Spire Codex — Slay the Spire 2 mod

The in-game companion for spire-codex.com. It connects Slay the Spire 2 to the Spire Codex ecosystem: automatic run tracking and a native companion panel, using the same data and API as the website and the Overwolf overlay.

• Run tracking — uploads your finished runs so they land on spire-codex.com and the leaderboards automatically. Off by default; you opt in.
• In-game companion (F5) — a draggable panel with your live run, leaderboards, your recent runs, and an About tab. Plus on-map guidance: the recommended route with community danger, upcoming events, win-rate plates on card rewards and shops, and community stats inside the game's own tooltips.
• Overwolf Overlay — pairs perfectly with the Overwolf overlay. If you haven't downloaded it yet, get it at spire-codex.com/overlay

Install

1. Install BaseLib (the required dependency) into the game's mods/ folder (paths below).
2. Download the latest release and extract it into the same mods/ folder, so you end up with mods/SpireCodex/ next to mods/BaseLib/.
3. Launch the game and press F5 or L3/R3 on your controller.

The mods/ folder lives inside your Slay the Spire 2 install:

OS	mods/ folder
Windows	C:\Program Files (x86)\Steam\steamapps\common\Slay the Spire 2\mods\
Linux	~/.steam/steam/steamapps/common/Slay the Spire 2/mods/
macOS	~/Library/"Application Support"/Steam/steamapps/common/"Slay the Spire 2"/SlayTheSpire2.app/Contents/MacOS/mods/

If the mods/ folder isn't there, create it. On macOS the game is an app bundle, so right-click SlayTheSpire2.app and choose Show Package Contents to get inside. Not sure where Steam put the game? Right-click it in your Steam library, choose Manage, then Browse local files.

Links

• Website: spire-codex.com
• Main project & API: github.com/ptrlrd/spire-codex
• Discord: discord.gg/uged4qFufK
• Support: Patreon

Building

Built with the ModTemplate-StS2 starter (Godot.NET.Sdk, Harmony, BaseLib). Needs a local Slay the Spire 2 install (for sts2.dll), and Godot 4.5.1 .NET to export the .pck that carries the readable settings labels.

• Copy Directory.Build.props.example to Directory.Build.props and set your Godot path.
• Build (installs into the game's mods folder): dotnet build SpireCodex.csproj -c Debug
• Package a release zip (dll + manifest + pck): bash tools/package.sh