Miooowo.Sts2.Templates 0.0.4

Miooowo.Sts2.Templates

中文说明

dotnet new templates for creating Slay the Spire 2 mods that use RitsuLib.

NuGet package: Miooowo.Sts2.Templates
Full setup guide: Wiki → Setup

Slay the Spire 2 is in Early Access. Game updates can break mods. These templates currently target game API 0.110.1 (beta-oriented STS2.RitsuLib package).

Templates

Prerequisites

• Slay the Spire 2 installed via Steam
• .NET SDK 9+
• MegaDot (or matching Godot .NET 4.5.1)
• A C# IDE (Rider recommended; use a classic .sln, not .slnx)
• Runtime install of STS2-RitsuLib in the game mods folder (GitHub releases or Steam Workshop if available)

Install the templates

dotnet new install Miooowo.Sts2.Templates

To update later:

dotnet new install Miooowo.Sts2.Templates --force

Create a project (CLI)

Important: put the solution and project in the same directory (required for Godot). Prefer -o so files are not spilled into your current folder.

# Character mod
dotnet new miosts2charmod -n MyCharMod --ModAuthor "YourName" -o MyCharMod

# Content mod
dotnet new miosts2contentmod -n MyContentMod --ModAuthor "YourName" -o MyContentMod

# Empty mod
dotnet new miosts2mod -n MyMod --ModAuthor "YourName" -o MyMod

In Rider: File → New Solution, pick one of the three templates, enable Put solution and project in same directory, use a name without spaces, and keep the .sln format.

After creating the project

1. Create Directory.Build.props next to the .csproj (not shipped by the template) and set GodotPath to your MegaDot/Godot executable. If Steam path discovery fails, also set Sts2Path.
2. Edit {ProjectName}.json for display name / description. Do not change id. Keep the STS2-RitsuLib dependency.
3. Build copies the .dll (and .json) into the game mods folder — enough for C#‑only changes.
4. Publish runs Godot and produces a .pck — required after changing localization, images, or scenes.

Example Directory.Build.props:

<Project>
  <PropertyGroup>
    <GodotPath>C:/path/to/MegaDot_mono_win64.exe</GodotPath>
    
    
  </PropertyGroup>
</Project>

Localization notes

Model text keys follow the RitsuLib analyzer format:

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

Example: MY_MOD_CARD_STRIKE.title

The Character template ships starter eng / zhs localization and can be launched for a smoke test after Publish.

Templates reference Miooowo.STS2RitsuLib.ModAnalyzers (*) for localization and asset-path diagnostics.

Next steps

• Wiki Setup (English)
• Wiki Setup (中文)
• RitsuLib tutorials
• STS2-RitsuLib
• Broader STS2 topics (decompiling, debugging): Alchyr ModTemplate wiki

Getting help

Ask in #sts2-modding on the Slay the Spire Discord.