BaseMod Documentation

BaseMod provides extensibility for modders through hooks and branding tools:

• Hooks: To see the list of available hooks for modding, visit the Hooks Wiki Page.
• Mod Badges: To learn how to implement and set up a Mod Badge for your project, visit the Mod Badges Wiki Page.

To install BaseMod, copy the target/BaseMod.jar file into your ModTheSpire mods directory.

If your mods directory is located at ../_ModTheSpire/mods relative to the repository root, Maven will automatically perform this copy step after packaging.

cp target/BaseMod.jar path/to/your/mods/directory/

To develop mods using BaseMod, you need the following environment setup:

• Java 8
• Maven
• ModTheSpire

Follow these steps to build the project using Maven:

1. Install ModTheSpire locally using mvn install, or modify the pom.xml to point to a local copy of the ModTheSpire JAR.
2. Copy desktop-1.0.jar from your Slay the Spire folder into the ../lib directory (relative to the repository root).
3. Run the package command.

mvn package

BaseMod includes a developer console for testing. For detailed instructions on how to use the console, refer to the Console Wiki Page.

Important Safety Warnings:

• Avoid using the fight command on an enemy or the event command in the starting room while Neow is present; doing so may result in an unloadable save file. Use these commands only after leaving the starting room.
• Using the event command with an invalid ID will cause the game to crash.

To use BaseMod, ensure you meet the following requirements:

• Java 8 (Note: Do not use Java 9, as ModTheSpire is incompatible with it).
• ModTheSpire v3.1.0+.

The Action Queue window provides a real-time view of the AbstractDungeon.actionManager.actions list. This is useful for debugging sequence-breaking or stuck game states.

• View Actions: The table displays the class name of the action and its remaining duration.
• Remove Actions: You can click the Remove button next to any action (including the currently executing currentAction) to immediately delete it from the queue. This can help bypass broken or infinite loops in game logic.

The BaseMod combat panel provides direct manipulation of creature attributes during gameplay:

Player Stats

• Keys: Toggle emerald, ruby, or sapphire keys (Act 4 content).
• Gold: Adjust current gold via an input field.
• HP: Set Max HP and Current HP (sliders/inputs).
• Energy: Adjust Energy or toggle Infinite energy mode.
• Deck/Hand: View and manipulate the master deck or current hand (Upgrade or Remove cards).

Monster Stats

• Control: Use Open All or Close All to expand/collapse monster info nodes.
• HP/Block: Adjust individual monster health and block values via sliders/drags.
• Powers: View active powers and click Remove to strip a specific power from a monster.
• Kill: Use the Kill button to trigger an InstantKillAction on a monster.

BaseMod provides persistent configuration for its ImGui-based developer tools. You can control the visibility of specific windows using the following boolean configuration keys:

• imgui-search: Toggles the visibility of the Search window (used for finding cards, relics, and potions).
• imgui-actionqueue: Toggles the visibility of the Action Queue window (used for inspecting and removing pending game actions).

These settings are managed via BaseMod.setBoolean and BaseMod.getBoolean and persist across sessions.