代码初始化

2026-03-21 17:10:22 +08:00
1 parent 8160eca074
commit dffebce01d
@@ -0,0 +1,39 @@
+# Blue Fox Tools Plus
+
+### 使用前须知
+
+1. 在使用工具之前,需要修改以下变量:*BlueFoxTools.ToolsConfig.MOD_NAME*以及*BlueFoxTools.ToolsConfig.MOD_VERSION*
+   .变量分别为模组名称,模组版本
+
+### 自动注册
+
+1. 使用Load函数自动注册系统时则需要`from BlueFoxTools.ModLoader import *`
+2. 自动注册系统时,需要在LoadMod之前声明所需要注册的类
+3. 自动注册系统时,仅注册BlueFox系统及其最终继承子类
+4. 自动注册的系统,nameSpace为MOD_NAME,systemName为类名
+
+### SystemTools
+
+1. 使用时,需要在类__init__函数下调用`SystemTools.Binding`方法
+2. 使用时,需要在类内生成SystemTools,使用`SystemTools.GetTools`方法获取
+
+### 背包引擎
+
+1. 物品数据，确保空物品为{}
+2. 使用时需要将gird节点名称,collection_name与slotDict内的槽位偏移键同名
+3. 需要结合背包引擎Json包使用
+4. 创建界面时,Parm需要传入两个参数:items-物品,posDim-工作方块坐标及维度
+5. 如需物品跟手功能,需要在界面添加`"bindings":[{"binding_name":"#main.gametick","binding_condition":"always"}],`字段
+
+### ScreenTools
+
+1. 如果自动注册界面,会在类内添加属性`cls.blueFoxClient = BlueFoxClientSystem`
+2. 使用自动注册界面时则需要声明类的位置
+3. 使用时,需要在类Create函数下调用`ScreenTools.Binding`方法
+4. 使用时,需要在类内生成ScreenTools,使用`ScreenTools.GetTools`方法获取
+
+### 方块块
+
+1. 模型具有一定的制作规则:界面朝北,以模型左下角为原点,移动到建模软件原点
+2. 方块具有一定规则:必须为四面向方块,必须为方块实体
+3. 创建之前应使用Able方法确认是否可以创建