本项目是基于我的世界中国版ModSDK的模组模板
脚本共有9个文件夹
用于存放类
用于存放 组件
存放配置文件
存放常量 例如LEVEL_ID
各种ModSDK的组件也可以存放 示例
import mod.server.extraServerApi as serverApi
LEVEL_ID = serverApi.GetLevelId()
COMPONENT_FACTORY = serverApi.GetEngineCompFactory()
GameComp = COMPONENT_FACTORY.CreateGame(LEVEL_ID)
存放枚举值
存放错误
存放你自定义或者封装的功能
存放三方库 新版不再区分sdk/api/library 直接归类为library
library库内自带一个consoleMod文件夹 这是项目的核心代码 请勿删除
存放客户端 服务端系统
method in root.library.consoleMod.serverApi
说明
用于快捷添加事件回调函数
参数
| 参数名 | 类型 | 说明 | 默认值 |
|---|---|---|---|
| funcOrStr | func|str | 事件名 不传时默认以下面的函数名作为事件名 | |
| namespace | str | 监听的事件命名空间 | serverApi.GetEngineNamespace() |
| systemName | str | 监听的事件系统名 | serverApi.GetEngineSystemName() |
| priority | int | 事件优先级 | 0 |
method in root.library.consoleMod.clientApi
说明
用于快捷添加事件回调函数
参数
| 参数名 | 类型 | 说明 | 默认值 |
|---|---|---|---|
| funcOrStr | func|str | 事件名 不传时默认以下面的函数名作为事件名 | |
| namespace | str | 监听的事件命名空间 | clientApi.GetEngineNamespace() |
| systemName | str | 监听的事件系统名 | clientApi.GetEngineSystemName() |
| priority | int | 事件优先级 | 0 |
客户端
method in root.system.ui
说明
用于给按钮快捷添加回调函数
参数
| 参数名 | 类型 | 说明 | 默认值 |
|---|---|---|---|
| path | str | 按钮路径 |
客户端
method in root.system.ui
说明
用于初始化快速设置按钮回调
参数
| 参数名 | 类型 | 说明 | 默认值 |
|---|---|---|---|
| instance | ScreenNode | 需要监听的UI类 |
复制到行为包
cd 行为包路径
git clone https://github.com/console41/console-mod-template.git
Rename-Item console-mod-template 脚本名
修改文件夹名
建议为团队名+功能+Scipts
配置
打开config/modCommon文件 配置MOD_NAME VERSION等内容
MOD_NAME = 'com.功能名.你的名字'
MOD_NAMESPACE = '模组的命名空间'
VERSION = '0.0.1' # 版本
加载模块(系统)
打开modMain 在Main类的LoadModule函数中直接import该模块即可 无需调用RegisterSystem注册
@staticmethod
def LoadModule():
from .system.server import server
打开system文件夹 开始写代码