beta2和万圣节 (#21)

* doc (#19)
* 万圣节来力 (#20)

Author: YongAn404

.gitignore

@@ -360,4 +360,5 @@ MigrationBackup/
 .ionide/
 
 # Fody - auto-generated XML schema
-FodyWeavers.xsd
+FodyWeavers.xsd
+/nuget.exe

Commands/ExpCommand.cs

@@ -10,7 +10,7 @@ namespace BAPlugin.Command
     [CommandHandler(typeof(RemoteAdminCommandHandler))]
     public class ExpCommand : ICommand
     {
-        public string Command => "experience";
+        public string Command => "pexperience";
 
         public string[] Aliases => ["pexp"];
 

Players/CustomPlayer.cs

@@ -1,21 +1,69 @@
-namespace YongAnFrame.Players
+using YongAnFrame.Roles;
+
+namespace YongAnFrame.Players
 {
     public abstract class CustomPlayer(FramePlayer player)
     {
+        /// <summary>
+        /// 拥有该实例的框架玩家
+        /// </summary>
         public FramePlayer FramePlayer { get; private set; } = player;
+        /// <summary>
+        /// 是否有效
+        /// </summary>
         public bool IsInvalid => FramePlayer == null;
-        public float ExpMultiplier { get { return FramePlayer.ExpMultiplier; } set { FramePlayer.ExpMultiplier = value; } }
-        public ulong Exp { get { return FramePlayer.Exp; } set { FramePlayer.Exp = value; } }
-        public ulong Level { get { return FramePlayer.Level; } set { FramePlayer.Level = value; } }
+        /// <summary>
+        /// 实例拥有的自定义角色
+        /// </summary>
+        public CustomRolePlus CustomRolePlus => FramePlayer.CustomRolePlus;
+        /// <summary>
+        /// 提示系统管理器
+        /// </summary>
         public HintManager HintManager => FramePlayer.HintManager;
-        public PlayerTitle UsingTitles { get { return FramePlayer.UsingTitles; } set { FramePlayer.UsingTitles = value; } }
-        public PlayerTitle UsingRankTitles { get { return FramePlayer.UsingRankTitles; } set { FramePlayer.UsingRankTitles = value; } }
+        /// <summary>
+        /// 正在使用的主要自定义算法
+        /// </summary>
+        public ICustomAlgorithm CustomAlgorithm { get => FramePlayer.CustomAlgorithm; set=> FramePlayer.CustomAlgorithm = value; }
+        /// <summary>
+        /// 玩家等级
+        /// </summary>
+        public ulong Level { get => FramePlayer.Level; set => FramePlayer.Level = value; }
+        /// <summary>
+        /// 玩家经验
+        /// </summary>
+        public ulong Exp { get => FramePlayer.Exp; set => FramePlayer.Exp = value; }
+        /// <summary>
+        /// 玩家经验倍率
+        /// </summary>
+        public float ExpMultiplier { get => FramePlayer.ExpMultiplier; set => FramePlayer.ExpMultiplier = value; }
+        /// <summary>
+        /// 玩家批准绕过DNT
+        /// </summary>
+        public bool IsBDNT { get => FramePlayer.IsBDNT; set => FramePlayer.IsBDNT = value; }
+        /// <summary>
+        /// 正在使用的名称称号
+        /// </summary>
+        public PlayerTitle UsingTitles { get => FramePlayer.UsingTitles; set => FramePlayer.UsingTitles = value; }
 
+        /// <summary>
+        /// 正在使用的排名称号
+        /// </summary>
+        public PlayerTitle UsingRankTitles { get => FramePlayer.UsingRankTitles; set => FramePlayer.UsingRankTitles = value; }
+        
+        /// <summary>
+        /// 添加经验
+        /// </summary>
+        /// <param name="exp">数值</param>
+        /// <param name="name">原因</param>
         public void AddExp(ulong exp, string name = "未知原因")
         {
             FramePlayer.AddExp(exp, name);
         }
-
+        /// <summary>
+        /// 调用后该实例会立刻无效<br/>
+        /// 调用后该实例会立刻无效<br/>
+        /// 调用后该实例会立刻无效
+        /// </summary>
         public virtual void Invalid()
         {
             FramePlayer = null;

Players/FramePlayer.cs

@@ -124,6 +124,11 @@ internal FramePlayer(Player player)
             Events.Handlers.FramePlayer.OnFramePlayerCreated(new FramePlayerCreatedEventArgs(this));
         }
 
+        /// <summary>
+        /// 添加经验
+        /// </summary>
+        /// <param name="exp">数值</param>
+        /// <param name="name">原因</param>
         public void AddExp(ulong exp, string name = "未知原因")
         {
             float globalExpMultiplier = YongAnFramePlugin.Instance.Config.GlobalExpMultiplier;

Players/HintManager.cs

@@ -33,7 +33,7 @@ public IEnumerator<float> Update()
                 string[] text = new string[36];
 
                 int used = 0;
-                text[used] = $"YongAnFrame 1.0.0-Beta1";
+                text[used] = $"YongAnFrame 1.0.0-Beta2";
 
                 if (fPlayer.ExPlayer.DoNotTrack && !fPlayer.IsBDNT)
                 {

Players/ICustomAlgorithm.cs

@@ -2,6 +2,11 @@
 {
     public interface ICustomAlgorithm
     {
+        /// <summary>
+        /// 获取升级所需要的经验
+        /// </summary>
+        /// <param name="level"></param>
+        /// <returns></returns>
         public ulong GetNeedUpLevel(ulong level);
     }
 }

Properties/AssemblyInfo.cs

@@ -31,5 +31,5 @@
 //可以指定所有这些值，也可以使用“生成号”和“修订号”的默认值
 //通过使用 "*"，如下所示:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("1.0.0.9")]
-[assembly: AssemblyFileVersion("1.0.0.9")]
+[assembly: AssemblyVersion("1.0.0.10")]
+[assembly: AssemblyFileVersion("1.0.0.10")]

Roles/Properties/SkillProperties.cs

@@ -1,6 +1,6 @@
 namespace YongAnFrame.Roles.Properties
 {
-    public struct SkillProperties(string name, string statement, string description, float activeMaxTime, float burialMaxTime, ItemType useItem = ItemType.Coin)
+    public readonly struct SkillProperties(string name, string statement, string description, float activeMaxTime, float burialMaxTime, ItemType useItem = ItemType.Coin)
     {
         /// <summary>
         /// 技能名称

YongAnFrame.csproj

@@ -135,7 +135,6 @@
     <None Include="README.md" />
     <None Include="YongAnFrame.nuspec" />
   </ItemGroup>
-  <ItemGroup />
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
   <PropertyGroup>
     <PostBuildEvent>

YongAnFrame.nuspec

@@ -2,19 +2,21 @@
 <package >
   <metadata>
     <id>$id$</id>
-    <version>1.0.0-beta1</version>
+    <version>1.0.0-beta2</version>
     <title>$title$</title>
     <authors>$author$</authors>
-    <requireLicenseAcceptance>false</requireLicenseAcceptance>
+    <requireLicenseAcceptance>true</requireLicenseAcceptance>
     <license type="expression">LGPL-2.1-only</license>
     <!-- <icon>icon.png</icon> -->
+	<readme>docs\README.md</readme>
     <projectUrl>https://github.com/YongAn404/YongAnFrame</projectUrl>
     <description>$description$</description>
     <releaseNotes>$version$</releaseNotes>
     <copyright>$copyright$</copyright>
     <tags>EXILED SCPSL</tags>
   </metadata>
   <files>
+	<file src="README.md" target="docs\" />
     <file src="lib\net48\SCPSLAudioApi.dll" target="lib/net48/SCPSLAudioApi.dll" />
   </files>
 </package>