There are two ways to set up the project. Pick the one that matches what you want to do.
| Path | For you if… |
|---|---|
| A · Code only | You only want to write or change code, no editing scenes or UI in Godot. |
| B · Full setup | You want to open the project in Godot and edit scenes, UI, or other assets. |
Tip
Not sure? Start with Path A. It's lighter, and you can switch to Path B later if you decide to touch the UI.
For writing or changing code without editing scenes or UI in Godot.
- A Slay the Spire 2 installation
- A Godot executable - MegaDot v4.5.1 (preferred) or Godot v4.5.1
1. Clone the repository
git clone https://github.com/lamali292/Downfall.git2. Configure your local paths
Copy local.props.example to local.props and fill in the values:
GodotPath- the.exeof your downloaded MegaDot / GodotSteamLibraryPath- yoursteamappsfolder, where Slay the Spire 2 is installedAssetSourcePath- not needed for Path A
<Project>
<PropertyGroup>
<GodotPath>C:\...\MegaDot\MegaDot_v4.5.1_mono.exe</GodotPath>
<SteamLibraryPath>C:\Program Files (x86)\Steam\steamapps</SteamLibraryPath>
<!-- AssetSourcePath is not required for Path A -->
</PropertyGroup>
</Project>3. Run the setup script (ImageGen + build)
build/setup.ps1This builds the image atlas files and compiles the project. Add -Clean to wipe .godot first if you hit a stale build.
4. Package and copy the project to the mods folder
dotnet publish Downfall.csprojFor opening the project in Godot and editing scenes, UI, or other assets.
- A Slay the Spire 2 installation
- A Godot executable - MegaDot v4.5.1 (preferred) or Godot v4.5.1
- Extracted Slay the Spire 2 assets via GDRE
1. Clone the repository
git clone https://github.com/lamali292/Downfall.git2. Extract the game assets
Extract Slay the Spire 2 using GDRE. Note the root folder of the extracted project - you'll need it in the next step.
3. Configure your local paths
Copy local.props.example to local.props and fill in the values:
GodotPath- the.exeof your downloaded MegaDot / GodotSteamLibraryPath- yoursteamappsfolder, where Slay the Spire 2 is installedAssetSourcePath- the root folder of your extracted GDRE project
<Project>
<PropertyGroup>
<GodotPath>C:\...\MegaDot\MegaDot_v4.5.1_mono.exe</GodotPath>
<SteamLibraryPath>C:\Program Files (x86)\Steam\steamapps</SteamLibraryPath>
<AssetSourcePath>C:\path\to\extracted\Slay the Spire 2</AssetSourcePath>
</PropertyGroup>
</Project>4. Link the assets, run ImageGen & the compile setup script
build/link-assets.ps1
build/setup.ps15. Pack the assets
dotnet publish Downfall.csprojOnce set up, both paths use the same commands. Depending on what you changed, you may only need to run one of them.
| What changed | What to run | Command |
|---|---|---|
| New images | Image generator | dotnet run --project ImageGen/ImageGen.csproj |
| Code only | Compile | dotnet build Downfall.csproj |
| Assets (e.g. localization, images) | Pack | dotnet publish Downfall.csproj |
New images - build them into atlas files.
dotnet run --project ImageGen/ImageGen.csprojCode only - code changed, assets unchanged. Much faster, ideal for quick testing.
dotnet build Downfall.csprojAssets - repack after changing assets (e.g. localization). This takes a while and automatically compiles the code too.
dotnet publish Downfall.csproj