Inscryption API Wiki
Hey there, and welcome to the Inscryption Modding and API Wiki. This is your one stop hub for all things related to the API. The following are some quick links:
Some other links you may find extremely valuable are as follows:
How can you contribute to the wiki? Well for starters you can find the Wiki end of our setup here, the only relevant part of this setup you may need to interact with is wiki or any index.md files. The rest of it leave untouched unless you know what you are doing. Once you have a markdown file open its straight forward editing as long as you know how Markdown works.
Inscryption API
This plugin is a BepInEx plugin made for Inscryption as an API. This is the de-facto standard API for Inscryption modders.
It can currently create and modify:
- Cards
- Abilities
- Appearance behaviours
- Stat Icons
- Challenges
- Starter Decks
- Regions
- Encounters
- Totem Tops
- Consumable Items
- Gramophone Tracks
- Slot Modifications
- Talking Cards
- Custom Costs
- Custom Rulebook Pages
- Rulebook Redirects/Hyperlinks
- And much more!
Additionally, a number of quality-of-life patches from the community are included with each release.
Getting Started: Installation
To begin, we'll go over how to install BepInEx, the framework all Inscryption mods use. This is a necessary step to playing modded Inscryption, so be sure to follow this carefully.
FOR LINUX AND STEAMDECK: Ensure that the game is set to run using Proton in he game settings on steam. Should be a setting like this: Change launch behaviour -> Proton.
Installing with a Mod Manager
- Download and install Thunderstore Mod Manager, Gale, Pulsar or r2modman.
- Click the Install with Mod Manager button on the top of BepInEx's page.
- Run the game via the mod manager.
If you have issues with Mod Managers head to one of these discords;
- Thunderstore Support Discord: Here
- R2ModMan Support Discord: Here
- Gale Mod Manager Support Discord: Here
Installing Manually
- Install BepInEx by pressing
Manual Downloadand extract the contents into a folder. Do not extract into the game folder! - Move the contents of the
BepInExPack_Inscryptionfolder into the game folder (where the game executable is; usually found here:C:\Program Files (x86)\Steam\steamapps\common\Inscryption). - Run the game. If everything was done correctly, you will see the BepInEx console appear on your desktop. Close the game after it finishes loading.
- Install MonoModLoader and extract the contents into a folder.
- Move the contents of the
patchersfolder intoBepInEx/patchers(If any of the mentioned BepInEx folders don't exist, just create them). - Install Inscryption API and extract the contents into a folder.
- Move the contents of the
pluginsfolder intoBepInEx/pluginsand the contents of themonomodfolder into theBepInEx/monomodfolder. - Run the game again. If everything runs correctly, a message will appear in the console telling you that the API was loaded.
- For any additional mods create a new subfolder, it can be called anything and extract the zips archive into it and if there is a
BepInExfolder within the zip instead drop the contents of that folder into theBepInExroot for the modding instance. EX;BepInEx // These go within the BepInEx root folder |-- config |-- patchers |-- plugins |-- monomod |-- core plugins // Files within go into the created plugin subfolder that was created for the mod |-- Art |-- Scripts |-- MyMod.dll manifest.json // Ignorable, but if kept, goes in plugin subfolder README.md // Ignorable, but if kept, goes in plugin subfolder CHANGELOG.md // Ignorable, but if kept, goes in plugin subfolder icon.png // Ignorable, but if kept, goes in plugin subfolder - Run the game once more and everything should be correct and working.
Installing Manually (XBOX Game-Pass)
- Install BepInEx by pressing
Manual Downloadand extract the contents into a folder. Do not extract into the game folder! - Move the contents of the
BepInExPack_Inscryptionfolder into the game folder (where the game executable is; usually found here:C:\XboxGames\Inscryption\Content). - Install the following package: XboxSilencio, this is a package which aims to solve frictions with XBOX Gamepass specific installations, such as HueyFS related errors.
- Run the game. If everything was done correctly, you will see the BepInEx console appear on your desktop. Close the game after it finishes loading.
- Install MonoModLoader and extract the contents into a folder.
- Move the contents of the
patchersfolder intoBepInEx/patchers(If any of the mentioned BepInEx folders don't exist, just create them). - Install Inscryption API and extract the contents into a folder.
- Move the contents of the
pluginsfolder intoBepInEx/pluginsand the contents of themonomodfolder into theBepInEx/monomodfolder. - Run the game again. If everything runs correctly, a message will appear in the console telling you that the API was loaded.
- For any additional mods create a new subfolder, it can be called anything and extract the zips archive into it and if there is a
BepInExfolder within the zip instead drop the contents of that folder into theBepInExroot for the modding instance. EX;BepInEx // These go within the BepInEx root folder |-- config |-- patchers |-- plugins |-- monomod |-- core plugins // Files within go into the created plugin subfolder that was created for the mod |-- Art |-- Scripts |-- MyMod.dll manifest.json // Ignorable, but if kept, goes in plugin subfolder README.md // Ignorable, but if kept, goes in plugin subfolder CHANGELOG.md // Ignorable, but if kept, goes in plugin subfolder icon.png // Ignorable, but if kept, goes in plugin subfolder - Run the game once more and everything should be correct and working.
Installing on the Steam Deck
- Download r2modman on the Steam Deck's Desktop Mode and open it from its download using its
AppImagefile. - Download the mods you plan on using and their dependencies.
- Go to the setting of the profile you are using for the mods and click
Browse Profile Folder. - Copy the BepInEx folder, then go to Steam and open Inscryption's Properties menu
- Go to
Installed FilesclickBrowseto open the folder containing Inscryption's local files; paste the BepInEx folder there. - Enter Gaming Mode and check 'Force the use of a specific Steam Play compatibility tool' in the Properties menu under
Compatibility. - Go to the launch parameters and enter
WINEDLLOVERRIDES="winhttp.dll=n,b" %command%. - Open Inscryption. If everything was done correctly, you should see a console appear on your screen.
Mac & Linux
- Follow the steps here first: https://docs.bepinex.dev/articles/user_guide/installation/index.html
- Next do steps 4-10 of the Manual Installation
- Your game should be setup for inscryption modding now
If you have any issues with Mac/Linux, Steam Deck, or Manual head over to the discord for this game:
- Inscryption Modding Discord: Here
Getting Started: Modding
Modding Inscryption requires a knowledge of coding in C# or a similar programming language such as Java, and in many cases an understanding of how to patch the game using HarmonyPatch, which you can find the docs for here for HarmonyX, and here for the underlying basic Harmony.
If you're unfamiliar with any of this, or just want to create cards and sigils, you can use JSONLoader, if you wish to avoid learning C#.
If your up for the task, a good entry point to learning C# is this tutorial by freeCodeCamp.org. It's around a 4 hour video, we'd advise you to tackle it in portions. One deviation from the video however, we are going to advise you to grab a thing called JetBrains Rider, you'll specifically want the Free for non-commerical use version. If your familiar with the UX of IntelliJ Idea for Java based modding, than it should feel familiar to you.
If at any point your confused while doing the tutorial, feel free to ask for help in the discord specifically, the channel entitled programming-help will be your friend. Mind you help will not be immediate, but we will try and get help to you as soon as we are able.
Modding with JSONLoader
JSONLoader is a versatile mod that provides a more beginner-friendly way of creating new cards and abilities for Inscryption using JSON syntax, which is much simpler than C#. If you don't know the basics of JSON you can find a useful video on the subject here.
JSONLoader's official documentation can be found in the following places, note Nightly refers to the Beta version, and Stable refers to the Main-Line version.
- Nightly GitHub Wiki: GitHub Wiki
- Nightly Thunderstore Wiki: Thunderstore Wiki
- Stable GitHub Wiki: GitHub Wiki
- Stable Thunderstore Wiki: Thunderstore Wiki
A video tutorial covering how to use JSONLoader in a basic form can be found here. A more updated series of sorts by JamesGames can be found here. If you at any point need any help with JSONLoader, you can ask your questions in the discord, specifically the jsonloader-help channel.
Modding with C#
First things first, in order to even make a mod for the game you will need a few things setup. First off if you haven't installed it yet, we reccomend getting a tool called JetBrains Rider. This guide will follow the layout of this IDE. If you still want to use Visual Studio instead, no one is going to stop you, there will be a foldout below this guide with the setup for that IDE, note its a little outdated.
JetBrains Rider Based Project Setups
Click me to close
Now that you have your IDE, we'll start by making our Project.
- Open up the IDE, than click on
New, followed byNew Solution. - One the menu pops up select
Class Libraryfrom the Left-Side panel. - Next we want to fill in some fields
- Where it says
Solution Name, update the associated field to the name of your mod. - Next to that field theres a little thing that says
format, click the drop down and change it tosln. - Where it says
Target Framework, select the dropdown and change it tov4.7.2. If it is not present, that means you don't have the SDK or Framework installed.- First ensure the Net10 SDK is installed, you'll want the
SDKassociated with your OS and Architecture. Note you will want to download anInstallernot aBinary. - Now ensure the Netframework 4.7.2 is installed, you'll want the
Offline InstallerunderBuild Appscalled theDeveloper Pack.
- First ensure the Net10 SDK is installed, you'll want the
- Ensure the
Languageis set toC#, and the Type is set toClass Library.
- Where it says
- Now press
Create.
Now we have your basic project setup, if you see a pop up about Microsoft Defender affecting the IDE click Exclude folders, this will allow the IDE to do its job much quicker than it would be able to otherwise.
Alright now we'll need to make sure you have the NuGet Package sources you'll need for success. The following steps will guide you through the process.
- Right-Click on the
Solution, hover overOpen In, than selectExplorer. - Once open you should see the File Explorer opened to a folder containing an
slnfile with a name matching your Project's. - In this folder create a new text file, than open it in a text editor. Now enter the following into the text file:
<?xml version="1.0" encoding="utf-8"?> <configuration> <packageSources> <add key="BepInEx" value="https://nuget.bepinex.dev/v3/index.json" /> <add key="nuget.org" value="https://api.nuget.org/v3/index.json" /> <add key="ts-nuget" value="https://nuget.windows10ce.com/nuget/v3/index.json" protocolVersion="3" /> </packageSources> </configuration> - Save the file, and rename it to
NuGet.Config. - If you don't see the sources in your IDE, try following this short guide and try again: File Explorer (Windows); JSONLoader Wiki. Simply put, your windows might not of overwrote the file extension because your extensions are hidden by default.
Now that we have this setup when you hit All enabled feeds under the NuGet menu found in the bottom of the left-hand toolbar, you should see 3 feeds, labeled BepInEx, nuget.org, and ts-nuget. Also ensure Prerelease is ticked on.
Next up, press Discover under the Packages tab of the NuGet menu. Search up the following packages in the table below, than install the version specified to the solution, also ensure the source matches.
| Package Name | Version | Source |
|---|---|---|
BepInEx.Analyzers |
1.0.8 | BepInEx |
BepInEx.Core |
5.4.21 | BepInEx |
HarmonyX |
2.10.2 | nuget.org |
Inscryption.GameLibs |
v1.9.0-r.0 | BepInEx |
UnityEngine.Modules |
v2019.4.24 | BepInEx |
API_dev-API |
2.24.1 | ts-nuget |
If you need any other dependencies that are mods on Thunderstore, search up its package identifier in the NuGet Search, for example Nevernamed-Nevernameds_Sigilarium. You can get the package identifier by going to the mods page on the Thunderstore Website, such as: Nevernameds Sigilarium. Beneath the Download, Like and Report Buttons, there will be a string of text resembling Team-Name-Version. You'll want to copy that string and remove the version part of it, that is what you will put in the NuGet Search.
Visual Studio Based Project Setups
Click me to expand
Now that you have your IDE, do the following to begin with. Your project's target framework needs to be netstandard4.7.2. Once your project's created, go to Project > Manage NuGet Packages. Click the dropdown menu for Package source and check that BepInEx, nuget.org and ts-nuget are there.
If BepInEx, nuget.org or ts-nuget aren't an available source, we need to add them. There are two methods you can use to address this, the first of which is entirely within Visual Studio, the second of which is through file, which may be less complicated.
Via Package Source Configuration
For each missing source you will want to do the following:- Click on the
Gearicon next to the package source selector. - Click the large green
Plus. - Set the fields to match what is shown in the below list:
- To add
BepInEx, change the name toBepInExand the source link tohttps://nuget.bepinex.dev/v3/index.json. - To add
nuget.org, change the name tonuget.organd the source link tohttps://api.nuget.org/v3/index.json. - To add
ts-nuget, change the name tots-nugetand the source link tohttps://nuget.windows10ce.com/nuget/v3/index.json.
- To add
Via File
- Right-Click the
Solutionfound at the top of theSolution Explorer. - Click
Open Folder in File Explorer. - Once open you should see the File Explorer opened to a folder containing an
slnfile with a name matching your Project's. - In this folder create a new text file, than open it in a text editor. Now enter the following into the text file:
<?xml version="1.0" encoding="utf-8"?> <configuration> <packageSources> <add key="BepInEx" value="https://nuget.bepinex.dev/v3/index.json" /> <add key="nuget.org" value="https://api.nuget.org/v3/index.json" /> <add key="ts-nuget" value="https://nuget.windows10ce.com/nuget/v3/index.json" protocolVersion="3" /> </packageSources> </configuration> - Save the file, and rename it to
NuGet.Config. - If you don't see the sources in your IDE, try following this short guide and try again: File Explorer (Windows); JSONLoader Wiki. Simply put, your windows might not of overwrote the file extension because your extensions are hidden by default. If that fails try the
Via Package Source Configurationmethod.
Now that we have this setup change the package source to All. Also ensure Prerelease is ticked on.
Next up, press Browse in the menu. Search up the following packages in the table below, than install the version specified to the solution, also ensure the source matches.
| Package Name | Version | Source |
|---|---|---|
BepInEx.Analyzers |
1.0.8 | BepInEx |
BepInEx.Core |
5.4.21 | BepInEx |
HarmonyX |
2.10.2 | nuget.org |
Inscryption.GameLibs |
v1.9.0-r.0 | BepInEx |
UnityEngine.Modules |
v2019.4.24 | BepInEx |
API_dev-API |
2.24.1 | ts-nuget |
If you need any other dependencies that are mods on Thunderstore, search up its package identifier in the NuGet Search, for example Nevernamed-Nevernameds_Sigilarium. You can get the package identifier by going to the mods page on the Thunderstore Website, such as: Nevernameds Sigilarium. Beneath the Download, Like and Report Buttons, there will be a string of text resembling Team-Name-Version. You'll want to copy that string and remove the version part of it, that is what you will put in the NuGet Search.
You are now ready to begin creating your mod! Some resources are provided below for you to use, including an example mod to look at for examples. Otherwise, continue reading this wiki.
Modding Resources
Vanilla and Modded Enumerations
Modded Save File
With this API installed, an additional 'modded save file' will be created by the game. This file will be found in the 'BepInEx' subdirectory, and contains all save data created by mods that use this API. This file will not automatically be synced to the cloud by Steam.
Community Patches
The following patches from the Inscryption modding community have been included in this package to improve the overall quality-of-life for modding and compatibility.
SigilArtPatch by MADH95Mods
Fixes the art for abilities that previously only appeared in Act 2 so they appear correctly in Act 1 and Act 3
Conduit Attack Fix by MADH95Mods
Fixes the behavior of conduits so they function correctly in Act 1.
Activated Sigil Fix by MADH95Mods
Allows activated sigils to work correctly in Act 1 and Act 3 by clicking the sigil icon on the card.
AnthonysLatchFix by AnthonyPython
Fixes latch sigils to work in Act 1
Sigil Art Fix by Memez4Life
Allows up to 8 sigils to be displayed on cards and adds the option to display merged sigil stamps at the bottom of the card instead of over the artwork (see the config files for more information).
Visually Stackable Sigils by divisionbyz0rro
Combines multiple instances of the same sigil on a single card into a single sigil with a number to free up space on the card.
Cost Render Fix by Void Slime
Displays hybrid cost cards correctly and makes energy and mox show up on act 1 cards
Cost Choice Node fix by Void Slime
If energy/mox cards are in the Act 1 pool, energy and mox card choice nodes will be added to the cost choice node in Act 1.
Sniper Sigil Fix by SpecialAPI
Displays targets for attacks made with the sniper sigil in Act 1.
Act 1 Sentry Fixes by WhistleWind
Fixes a number of bugs caused by the Sentry ability being used in Act 1.
Multi-Act Sigil Compatibility Fixes by WhistleWind
Fixes a number of sigils to be usable in all Acts. Sigils include: Mental Gemnastics, Tidal Lock, Hoarder, Vessel Printer, Amorphous, Handy.
Fledgling Sigil Fixes by WhistleWind
Fixes Fledgling in Act 2 to show the correct number of turns until a card evolves, up to 3. Also changes its description to show the correct number of turns.
OverridePixelAbilityIcons by WhistleWind
Fixes the OverrideAbilityIcon method to work in Act 2.
Temporary Mod Fixes by WhistleWind
- Fixes issues related to using temporary mods in Act 2 or to add custom decals
Contribution
How can you help?
Use the plugin and report bugs you find! Ping us on the Inscryption Modding Discord server in the api channel with what you find.
But really, I want to help develop this mod!
Great! We're more than happy to accept help. Either make a pull request to the API's GitHub page or come join us over in the Inscryption Modding Discord.
Can I donate?
Donations are totally not needed, this is a passion project before anything else.
Contributors
Original version by cyantist
Contributors and builders of API 2.0:
- BobbyShmurner
- divisionbyz0rro
- Eri
- IngoH
- JamesVeug
- julian-perge
- KellyBetty
- Nevernamed
- SpecialAPI
- Void Slime
- WhistleWind
- Windows10CE
- Keks307
- Creator/Chaosyr/SaxbyMod/The Stoat Lord/ThinCreator3483
- stillrinny
- R3b00t3d-kawaii