Skip to content

Latest commit

 

History

History
45 lines (36 loc) · 1.32 KB

README.md

File metadata and controls

45 lines (36 loc) · 1.32 KB
Raw

ModTheSpire

ModTheSpire is a tool to load external mods for Slay the Spire without modifying the base game files.

Usage

Installation

  1. Download the latest Release.
  2. Copy ModTheSpire.jar to your Slay the Spire install directory.
    • For Windows, copy MTS.cmd to your Slay the Spire install directory.
    • For Linux, copy MTS.sh to your Slay the Spire install directory and make it executable.
  3. Create a mods directory. Place mod JAR files into the mods directory.

Running Mods

  1. Run ModTheSpire.
    • For Windows, run MTS.cmd.
    • For Linux, run MTS.sh.
    • Or run ModTheSpire.jar with Java 8.
  2. Select the mod(s) you want to use.
  3. Press 'Play'.

For Modders

Requirements

  • JDK 8
  • Maven

General

  • ModTheSpire automatically sets the Settings.isModded flag to true, so there is no need to do that yourself.
  • Wiki

Building

  1. Run mvnw package

Changelog

See CHANGELOG

Contributors

  • kiooeht - Original author
  • t-larson - Multi-loading, mod initialization, some UI work
  • test447 - Some launcher UI work, Locator
  • reckter - Maven setup
  • FlipskiZ - Mod initialization
  • pk27602017 - UTF-8 support in ModInfo