OUTDATED - LOOK HERE INSTEAD

https://github.com/Alchyr/ModTemplate-StS2/wiki/Setup

ExampleMod

Example mod for Slay the Spire 2!

---

Development Setup

Prerequisites

Before you begin, ensure you have:

• .NET 9.0 SDK
• Godot 4.5.1 Mono - Download the "Windows 64-bit, .NET" version
• Slay the Spire 2 installed via Steam

---

Initial Configuration

1. Clone the Repository

git clone https://github.com/lamali292/sts2_example_mod.git
cd sts2_example_mod

2. Configure Your Paths

Windows (PowerShell):

Copy-Item local.props.example local.props

Linux/Mac:

cp local.props.example local.props

3. Edit local.props

Open local.props in any text editor and update with your paths:

<Project>
  <PropertyGroup>
    <!-- Example for default Steam installation: -->
    <STS2GamePath>C:\Program Files (x86)\Steam\steamapps\common\Slay the Spire 2</STS2GamePath>
    
    <!-- Example Godot path: -->
    <GodotExePath>C:\Godot\Godot_v4.5.1-stable_mono_win64.exe</GodotExePath>
  </PropertyGroup>
</Project>

---

Building the Mod

Visual Studio

Open ExampleMod.csproj as Visual Studio Project

Press Ctrl+Shift+B or click Build → Build Solution

The mod will automatically install to:

Slay the Spire 2/mods/ExampleMod/
├── ExampleMod.dll
└── ExampleMod.pck

can be changed in ExampleMod.csproj

---

Troubleshooting

"Cannot find Godot executable"

• Make sure GodotExePath in local.props points to the .exe file
• Download the Mono version, not the standard version

"Cannot find Slay the Spire 2"

• Right-click STS2 in Steam → Manage → Browse local files
• Copy the full path and paste into STS2GamePath

Build succeeds but mod doesn't load

• Check that both ExampleMod.dll AND ExampleMod.pck exist in mods/ExampleMod/
• Check the game's log file for errors: %AppData%\Roaming\SlayTheSpire2\Player.log

Changes don't appear in game

• Rebuild the mod (Ctrl+Shift+B) or with Rebuild Solution
• Restart Slay the Spire 2

---