模组开发规范
在发布你的 Mod 之前,请阅读并遵守以下规范。它们保护玩家、保护开发者、也保护这个生态。
1. 不要破坏原版游戏平衡
红线
请勿制作脱离原版游戏平衡的 Mod,例如改动判定、精度计算、伤害数值等影响游戏核心体验的内容。游戏判定是官方的雷区。
- 本教程不会介绍修改判定的做法,也请勿在任何渠道宣传这类功能
- 如果想让玩家获得更好的成绩展示,请参考组织内的 NotEnoughAccuracy、JustEnoughAccuracy 这类不影响原版判定的精度统计方案
2. AI 生成内容需要注明
如果你使用 AI 生成了代码、文档或素材,请在仓库中注明。
markdown
<!-- 本模块由 AI 辅助生成([工具/模型名]),使用前请人工审查 -->为什么:
- 保证代码质量与可信度
- 尊重贡献者与使用者
- 组织生态讲究透明与信任
3. 不要锁定关卡内容
DANGER
你不能将关卡或其他内容标记为「必须使用你的 Mod 才能打开」。
- 关卡文件本身属于创作者,不应被某个 Mod 绑架
- 你的 Mod 可以增强体验,但不能绑架内容
- 发布到 modrift.org 的 Mod 也遵循同样的原则
4. 不要分发原版游戏二进制
DANGER
Mod 产物与源代码仓库不得存放原版游戏的二进制文件(Assembly-CSharp.dll、UnityEngine.dll 等),它们受版权保护。
- 编译时需要引用的原版 DLL,使用私有 lib 仓库方案(见 GitHub Actions 自动构建)
- 构建产物(Release 的 zip)里只放你的 Mod 文件,不要附带游戏 DLL
- 反编译游戏二进制仅供理解与调试,不要外发
5. 其它质量要求
- 测试:功能需经过测试,发布前在干净环境下验证
- 注释:代码包含良好注释(尤其是 AI 生成的部分)
- 数据安全:持久化数据存放于 Mod 的本地配置目录,防止更新被覆盖
- 健壮性:良好的错误处理机制,不要让 Mod 因一个错误而崩溃(可以参考 Finalizer 补丁)
- 协作:如果是扩展现有 Mod 的功能,优先向原项目提交 PR
你学到了什么
- 四条不可逾越的红线(平衡 / AI 注明 / 不锁定内容 / 不含二进制)
- 质量与协作的基本要求
下一步
遇到问题?看看 常见问题与排查