Skip to content

Slay the Spire mod which provides a modding API and a dev console

License

Notifications You must be signed in to change notification settings

Moocowsgomoo/BaseMod

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BaseMod

BaseMod provides a number of hooks and a console.

Developer Console

Requirements

General Use

Development

Building

  1. (If you haven't already) mvn install ModTheSpire Altenatively, modify pom.xml to point to a local copy of the JAR.
  2. Copy desktop-1.0.jar from your Slay the Spire folder into ../_lib relative to the repo.
  3. Run mvn package

Installation

  1. Copy target/BaseMod.jar to your ModTheSpire mods directory. Maven will automatically do this after packaging if your mods directory is located at ../_ModTheSpire/mods relative to the repo.

Wiki

Take a look at the wiki (https://github.com/daviscook477/BaseMod/wiki) to get started using BaseMod as either a console or a modding platform!

Console

Take a look at the Console page on the wiki (https://github.com/daviscook477/BaseMod/wiki/Console) to start using the console to test things out!

Known Issues

  • If you use the console to fight an enemy or spawn an event in the starting room with Neow your save will be unloadable. Please refrain from using those commands until after leaving the starting room.
  • If you use the event command with an invalid ID it will crash the game.
  • BaseMod is likely to break when weekly patches hit. This means that if it's Thursday or Friday and things suddenly stop working you'll probably need to wait for an updated version of BaseMod in a day or two :)

Roadmap

For Modders

Hooks

Take a look here for the hooks that are available (https://github.com/daviscook477/BaseMod/wiki/Hooks)

Mod Badges

Take a look here for how to set up a Mod Badge (https://github.com/daviscook477/BaseMod/wiki/Mod-Badges)

About

Slay the Spire mod which provides a modding API and a dev console

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 100.0%