Setup.zh

Setup（上手）

English

强烈建议具备 C# 与面向对象基础。若刚接触 C#，请先学习语言再回来做 Mod。

以下步骤使用 Miooowo.Sts2.Templates，基于 RitsuLib 创建项目。

1. 安装 C# IDE

推荐 Rider。熟悉 C# 也可用其他 IDE。

Godot 需要传统 .sln 文件，不要用 .slnx。

2. 下载依赖

• 通过 Steam 安装杀戮尖塔 2
• 下载 MegaDot（或与 MegaDot 版本一致的 Godot .NET，当前为 4.5.1）
• 安装 .NET SDK 9+
• 将 STS2-RitsuLib 安装到游戏 mods 目录：
  • 优先使用 STS2-RitsuLib Release 中的稳定包（不要用 Development build），或
  • 若创意工坊有 RitsuLib，也可订阅安装

项目里的 NuGet 引用（STS2.RitsuLib）与运行时 mods 目录安装是两回事，正常开发两者都需要。

3. 安装模板

dotnet new install Miooowo.Sts2.Templates

在 Rider 中：如需终端，可先随便建一个占位 solution，再在终端执行上述命令。

4. 创建 solution

Rider

File → New Solution，选择其一：

• Slay the Spire 2 Character — 新角色
• Slay the Spire 2 Content — 卡牌 / 遗物 / 药水 / 事件等
• Empty Slay the Spire 2 Mod — 最小骨架

创建时注意：

• 勾选 Put solution and project in same directory
• 项目名：不要有空格
• 格式：.sln
• 在 Advanced Settings 中设置作者（--ModAuthor）等选项

命令行

dotnet new miosts2charmod -n MyCharMod --ModAuthor "你的名字" -o MyCharMod
# 或：miosts2contentmod / miosts2mod

建议始终使用 -o，把文件放到独立目录。

5. 创建 Directory.Build.props

模板不会自带该文件。请在 .csproj 同级新建：

<Project>
  <PropertyGroup>
    <GodotPath>C:/path/to/MegaDot_mono_win64.exe</GodotPath>
    <!-- 若构建找不到游戏数据，请显式设置 Sts2Path -->
    <!-- <Sts2Path>C:/Steam/steamapps/common/Slay the Spire 2</Sts2Path> -->
  </PropertyGroup>
</Project>

路径不要加引号。也可用 local.props 做本机覆盖（Sts2Path / Sts2DataDir）。

先尝试 Build。若出现类似：

Slay the Spire 2 data not found at path '...'

请取消注释并填写 Sts2Path。

角色模板若出现本地化相关构建错误，通常说明游戏路径已找到，但本地化文件缺失——官方模板应已预置这些文件。

6. 编辑 {项目名}.json

可修改 name、author、description、version。

• 开始分发后不要改 id（影响加载路径与本地化 ID）。
• 保留依赖项 STS2-RitsuLib。
• 当前模板的 min_game_version 为 0.110.1（与面向 beta 的 RitsuLib 主包一致）。

7. 本地化（尤其是角色模板）

模型内容的键应形如：

{MODID}_{CATEGORY}_{ORIGINAL_ID}.title / .description

例如：MY_CHAR_MOD_CARD_STRIKE.title

角色模板已在 {ModFolder}/localization/ 下预置 eng 与 zhs。你可以先 Publish 再进游戏，无需先手写本地化。

可选参数：StrictLocalizationValidation=true（或设置 MainFile.StrictLocalizationValidation）。

分析器：项目引用 Miooowo.STS2RitsuLib.ModAnalyzers，用于 IDE / 构建期的本地化与资源路径检查。

8. Build 与 Publish

操作	作用	何时使用
Build	编译 .dll，复制 .dll / .json 到游戏 mods	只改 C#
Publish	Build + Godot 无头导出 .pck	改本地化 / 图片 / 场景，或首次部署资源

Rider：右键项目 → Publish → Local folder（默认即可）。

警告： 非代码改动必须 Publish 生成 .pck 后才会在游戏中生效。

Publish 需要有效的 GodotPath。

9. 运行游戏

启动杀戮尖塔 2，在 Mod 列表中启用你的 Mod 与 STS2-RitsuLib。角色模板在成功 Publish 后应能看到示例角色。

下一步

• Troubleshooting（中文）
• RitsuLib 教程
• STS2-RitsuLib
• Alchyr wiki（反编译、调试及其他 STS2 主题）