API

API

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 Mod Manager, Gale 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;

• Support Discord: Here
• R2ModMan Support Discord: Here
• Gale Mod Manager Support Discord: Here

Installing Manually

• Install BepInEx by pressing Manual Download and extract the contents into a folder. Do not extract into the game folder!
• Move the contents of the BepInExPack_Inscryption folder 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 patchers folder into BepInEx/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 plugins folder into BepInEx/plugins and the contents of the monomod folder into the BepInEx/monomod folder.
• 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 BepInEx folder within the zip instead drop the contents of that folder into the BepInEx root 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 Download and extract the contents into a folder. Do not extract into the game folder!
• Move the contents of the BepInExPack_Inscryption folder 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 patchers folder into BepInEx/patchers (If any of the mentioned BepInE