ReadmeMaker

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 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:

43 New Configs:

Section — Key — Description

1. Readme Maker — Enabled — Should the ReadmeMaker create a GeneratedReadme?

1. Readme Maker — Save To — Where to save the generated readme to. If blank will be same folder as ReadmeMaker.dll. See console for exact location after making a readme.

2. General — Display By — Changes how the cards, abilities and special abilities are displayed.

2. General — Filter by JSONLoader Mod Prefix — Show .jdlr cards with a specific Mod Prefix. Disable by leaving blank.

2. General — Filter by Mod GUID — Only cards, sigils... etc related to this mods GUID. Disable by leaving blank.

2. General — Header Size — How big should the header be? (Does not work for type Foldout!

2. General — Header Type — How should the header be shown? (Unaffected by Size)

2. General — Ignore Empty Columns — True=Any columns that have no data will not be shown, False=All columns shown even if it has no data to show.

2. General — Ignore Mod by GUID — Ignore mods using these guids. Separate multiple guids by a comma. Disable by leaving blank.

2. General — Show GUIDs — Show the mod GUID for each sigils, tribes... etc.

2. General — Sort By — Changes the order of how rows in sections are displayed.

2. General — Sort by Ascending — True=Names will be ordered from A-Z, False=Z-A... etc.

3. Toggle Sections — Gramophone Sort Type — Order of which the Gramophone tracks will show in.

3. Toggle Sections — Show Boons — Show all new Boons added in its own section..

3. Toggle Sections — Show Cards Modified — Show a section that lists all the cards modified.

3. Toggle Sections — Show Configs — Should the Readme Maker show a section listing all the new configs added?

3. Toggle Sections — Show Consumable Items — Show all new Consumable Items added in its own section.

3. Toggle Sections — Show Encounters — Show all new encounters added in its own section..

3. Toggle Sections — Show Gramophone Tracks — Show all new Gramophone Tracks added in its own section.

3. Toggle Sections — Show Kaycees Mod Challenges — Show all new challenges added for Kaycee's mod.

3. Toggle Sections — Show Kaycees Mod Starter Decks — Show all new starter decks for Kaycee's mod.

3. Toggle Sections — Show Map Nodes — Show all new map nodes added in its own section..

|3. Toggle Sections|Show Pelts|Show all new Pelts added in its own sectio