Getting Started
This set of articles covers getting started for both users and modders. This page acts as the homepage that links out to them. You can switch between them through the table of contents, which is on the left hand of the screen. You can also switch to other articles through the table of contents.
Getting Started (Users)
The following are links to articles relavent for Users of the API. Namely covering the topic of installation of mods for Inscryption that utilize the API. This also includes how to install BepInEx, the underlying framework for all Inscryption Mods, for all of the given scenarios the Articles tackle.
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
- Installing Manually on Windows (x86)
- Installing Manually on Windows (x64)
- Installing on The Steam Deck
- Installing on Mac & Linux
Getting Started (Modders)
So your interested in learning how to modify Inscryption? Well this section of our guide should come in really handy for you! Albeit if your a artist, a developer, or just passing by, we hope you find these guides of value.
First off let's get you to the right branch of the guides. Let's get some groundworks out of the way now. Based on the item below, you should be funneled to the level your after.
flowchart TD
A["Are you trying to make a Simple Cardpack?"]
A --> A1["If this item applied to you, than let's head to the<br/>~~ JSONLoader Branch ~~<br/>Unless your willing to challenge yourself?<br/>If you want the challenge, follow the other tree!"]
B["Are you after something more Complex in terms of your Project?"]
B --> C["Are you already familiar with C#?"]
C -->|Yes| D["What is your preferred of the two? Visual Studio, or JetBrains Rider?"]
C -->|No| C1["If this was your case, than let's head into the<br/>~~ C# Basics Branch ~~</br>To get you familiar with the underlying concepts,<br/>and knowledge you will need in order to make your mod."]
D -->|Visual Studio| D1["If this was your choice, let us navigate into the<br/>~~ API Project Setup Guide for Visual Studio ~~"]
D -->|JetBrains Rider| D2["If this was your choice, let us navigate into the<br/>~~ API Project Setup Guide for JetBrains Rider ~~"]
click A1 "modders/jsonloader_projects/index.html" "Open JSONLoader Branch"
click C1 "modders/c_sharp_basics/index.html" "Open C# Basics Branch"
click D1 "modders/api_projects_vs_edition/index.html" "Open Visual Studio Setup Guide"
click D2 "modders/api_projects_rider_edition/index.html" "Open JetBrains Rider Setup Guide"
Plain-Text Version
- Are you trying to make a Simple Cardpack?
- If this item applied to you, than let's head to the JSONLoader Branch shallst we? Unless your willing to challenge yourself?
- Are you after something more Complex in terms of your Project?
- Are you already familiar with C#?
- If
Yeswas your choice:- What is your preferred of the two? Visual Studio, or JetBrains Rider?
- If
Visual Studiowas your choice:- If this was your choice, let us navigate into the API Project Setup Guide for Visual Studio.
- If
JetBrains Riderwas your choice:- If this was your choice, let us navigate into the API Project Setup Guide for JetBrains Rider.
- If
- What is your preferred of the two? Visual Studio, or JetBrains Rider?
- If
Nowas your choice:- If this was your case, than let's head into the C# Basics Branch, to get you familiar with the underlying concepts and knowledge you will need in order to make your mod.
- If
- Are you already familiar with C#?