Giter Site home page Giter Site logo

modthespire's Introduction

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

modthespire's People

Contributors

daviscook477 avatar difficulty-in-naming avatar kiooeht avatar reckter avatar rikahe avatar t-larson avatar unlimitedsola avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.