外观
搭建 API 1.9 MOD 项目
本页以当前 SurvivalcraftTemplateModForAPI 的 API1.9 分支为准。旧版 PAK 和 API 1.5–1.8 教程不能直接替代当前模板。
准备工具
- 安装 .NET 10 SDK；
- 安装支持 .NET 项目的 Visual Studio、Rider 或 VS Code；
- 安装 Git；
- 准备 Survivalcraft API 1.9 测试客户端；
- 单独建立测试世界并备份原有数据。
获取模板
bash
git clone -b API1.9 https://gitee.com/SC-SPM/SurvivalcraftTemplateModForAPI.git
cd SurvivalcraftTemplateModForAPI
dotnet restore
dotnet build模板通过 NuGet 引用 Survivalcraft API 包，nuget.config 是依赖恢复的一部分，不要随意删除。
模板结构
当前模板包括：
| 内容 | 用途 |
|---|---|
Assets/Lang | 本地化语言 |
Assets/Models | glTF 等模型资源 |
Assets/Widgets | XML 界面布局 |
*.csv | 方块数据与替换 |
*.clo | 衣物数据 |
*.cr | 合成配方 |
*.xdb | 子系统、组件、实体与数据库修改 |
TemplateBlock.cs | 新方块示例 |
TemplateModLoader.cs | MOD 加载和 Hook 注册 |
TemplateHarmonyPatch.cs | Harmony 补丁示例 |
modinfo.json | 名称、版本、依赖等元数据 |
第一次修改建议
- 修改
modinfo.json中的项目标识、名称、版本和作者； - 删除暂时不需要的示例功能，而不是把整个模板原样发布；
- 只保留一个最小功能完成编译；
- 把输出的
.scmod放入 API 客户端Mods目录； - 查看启动日志，确认 MOD 被识别；
- 在测试世界验证后再继续添加功能。
官方开发资料
先运行模板，再理解源码
模板只能说明项目结构。实现新机制时仍需阅读 SurvivalcraftApi 源码，确认当前类、生命周期和 Hook 行为。