Readme Maker

Creates a file that lists all new and modified cards/abilities and special abilities... etc to be easiy viewed or even used in your Mods' Readme.

To see what your Readme looks like when its on the store.

• Open your Readme.md in a text editor (Notepad, Sublime... etc)
• Copy everything
• Go to https://markdownlivepreview.com/
• Paste in the left column

Supports:

• Life Cost API
• Side Deck Selector

Example mods

• Void Life and Currency Cardpack
• Sire MoDeers
• MycoBotsinAct1
• ZergMod

How to use it

Setup

• Install the mod (Through thunderstore is highly recommended)
• Start the game
• Wait for the console to load the ReadmeMaker mod
• Quit game
• Change _ReadmeMaker.Enabled to true in the config
• Restart the game so it can add the rest of the configs for you

Making a Readme

• Start Inscryption
• Start the game either vanilla or KCM until it gets to the map
• Wait for console to say that it has dumped the GENERATED_README.md

!NOTE!

• Thunderstore will not accept a Readme with more than 32,768 characters. So if your mod has a lot of cards and sigils it's likely you'll hit this limit.

Adding Custom Information

The Readme Maker has support for your mod to add additional information to readme dumps

Setup

• Go to https://github.com/JamesVeug/InscyptionReadmeMaker/tree/develop/Scripts
• Download ExternalHelpers method and put it in your mod

How to add a custom card section to your mod

• Create a new class and make it inherit from CustomCardSection
• Override Initialize so it returns all the cards you want to appear in the readme dump.
• In your Plugin.cs script call AddSectionToReadmeMaker

eg:

private void Awake()
{
    new AllBoneCardsSection().AddSectionToReadmeMaker();
}

public class AllBoneCardsSection : CustomCardSection
{
    public override string SectionName() => "All Bone Cards";
    public override bool Enabled() => true;
    
    public override List<CardInfo> Initialize()
    {
        return CardManager.AllCardsCopy.FindAll(a => a.bonesCost > 0);
    }
}

How to add a general custom section to your mod

Go here for an example of what a custom section looks like

• Create a new class and make it inherit from CustomSection
• Fill our all methods as you need
• In your Plugin.cs script call AddSectionToReadmeMaker

eg:

private void Awake()
{
    new ExampleCustomSection().AddSectionToReadmeMaker();
}

How to add a custom cost to your mod

Go here for an example of what a custom cost looks like

• Create a new class and make it inherit from CustomCost
• Fill our all methods as you need
• In your Plugin.cs script call AddCostToReadmeMaker

eg:

private void Awake()
{
    new ExampleCustomCost().AddCostToReadmeMaker();
}

Includes:

Contributers

• JamesGames
• TeamDoodz
• der Kartoffelcode

Special Thanks:

• Eri - Eris's Battery Cost icon
• Manta Rain - Manta's Battery Cost icon
• Zepht - Zepht's Battery Cost icon