ModInfo

The ModTheSpire.json file

By including a file named ModTheSpire.json at the root of a mod's .jar file, the mod can tell ModTheSpire some information about itself:

Property	Type	Default	Description
modid	string	required	The unique ID string for this mod.
name	string	required	The user-friendly name of this mod.
description	string	""	A description of this mod.
version	string	""	The version of the mod.
sts_version	string	""	The exact Slay the Spire version this mod supports.
mts_version	string	""	The minimum ModTheSpire version this mod requires.
author_list	[string]	[]	A list of authors to this mod.
credits	string	""	A string containing any acknowledgements you want to mention.
dependencies	[string]	[]	A list of modids. All of the listed mods will load before this one. If one is missing, the game will crash.
optional_dependencies	[string]	[]	A list of modids. All of the listed mods will load before this one. Will NOT crash if one is missing.
update_json	string	""	No longer needed with Steam Workshop support. The URL to a version JSON.

Example file:

{
  "modid": "example",
  "name": "Example Mod",
  "author_list": ["kiooeht"],
  "description": "An example mod to be an example.",
  "version": "0.1",
  "sts_version": "03-29-2018",
  "mts_version": "2.6.0",
  "dependencies": ["basemod"]
}

Versioning

Mod version numbers (the "version" property) use Semantic Versioning. Read up on it at https://semver.org/ so your version numbers are correct.

If you don't use proper Semantic Versioning, the auto-updater won't function properly for your mod.

Old Format, DO NOT USE

This old mod info format exists for legacy and backward compatibility reasons.

By including a file named ModTheSpire.config at the root of a mod's .jar file, the mod can tell ModTheSpire some information about itself:

• name Specify the name to be displayed in game (in the mod list and credits).
• author The mod author's name to display in the launcher and in-game credits. Separate with a comma (,) for multiple authors.
• description The mod's description to display in the launcher.
• mts_version The minimum version of ModTheSpire the mod supports.

Example file:

name=Example Mod
author=kiooeht
description=An example mod to be an example.
mts_version=2.3.0