Home - Gremious/StS-ArchetypeAPI GitHub Wiki

Welcome to the wiki for the Archetype-API mod for Slay the Spire. This mod is used for adding your own custom archetypes to both existing and modded StS classes. This guide also expects you to have read the BaseMod mod/card creation documentation, as well as basic java knowledge.

Now with 100% less hard dependencies!

FOR PLAYERS:

  1. Allow the player to select any character's archetype that they wish to see in the current run. For example, if you wanted to only see "Non-archetype cards, poison cards and shiv cards" this Silent run and nothing else, you can do that. This also works for custom characters that implement this API.

  2. If the player doesn't wish to manually select card Archetypes, (which is also disabled by default in the mod options), they can just let the game grab every archetype that the class has. If they have any modded ones, it only goes up to approximately the amount of cards the class originally has. What this means is, if a player has mods installed that add any archetypes, every run will have a different handful selection of them, preventing the card reward pool from being diluted.

FOR MODDERS:

All in all this means a couple of main things:

  1. Modders can add brand new archetypes to existing classes without worrying about the rates of their cards showing up i.e. it being hard to draft due to being lost in a sea of other cards.

  2. This API allows people to expand on existing archetypes in nice, organized way when adding additional poison cards to the poison archetype pool or extra shiv cards, etc.

  3. You can add custom archetypes to your custom classes with ease, allowing for bigger but still tight card pools, and providing all the normal custom-selection functionality that the API provides if any players wishes to use it.

Also, the cards you make will still also appear while playing normally, without ArchetypeAPI, if your mod's loaded. The API is an extension, not a necessity.

How to use:

Make your cards first! Then check out the tutorial page on the side.