Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
ddab80d
Merge pull request #4 from Chaosyr/Update-Installation-Guides-and-Doc…
Chaosyr Nov 17, 2026
ad7b600
Try Fix Doc Bugs
Chaosyr Nov 17, 2026
48b313e
Remove Namespace from Aggregate
Chaosyr Nov 17, 2026
b677e4c
Make summary match the correct extension
Chaosyr Nov 17, 2026
9ee39a6
Fix Extension Summaries
Chaosyr Nov 17, 2026
66b72cc
Extension stuff
Chaosyr Nov 17, 2026
37826e1
More Extension Stuff
Chaosyr Nov 17, 2026
ae1164d
remove debug logging in wiki builds
Chaosyr Nov 17, 2026
8f41870
Merge pull request #5 from Chaosyr/Update-Installation-Guides-and-Doc…
Chaosyr Nov 19, 2026
0f0f7ac
Update Getting Started With C# Guide
Chaosyr Nov 19, 2026
5521f56
Update getting_started.md
Chaosyr Nov 19, 2026
a78de46
Blockquote CSS Improvements
Chaosyr Nov 19, 2026
9fdb270
testing
Chaosyr Nov 21, 2026
16195e8
testing pt.2
Chaosyr Nov 21, 2026
c7b6fbe
testing pt.3
Chaosyr Nov 21, 2026
27b2209
Add YML to inclusions for wiki
Chaosyr Nov 21, 2026
a4de41f
Update TOCs
Chaosyr Nov 21, 2026
616d08a
Part 1 of Getting Started Rework into Sub-Items
Chaosyr Nov 21, 2026
ddd71b2
resolve a heading overflow issue at zoom 220%, 240%, 260%, 280%, 300%,
Chaosyr Nov 21, 2026
fa8f478
Quick fix user level index.md under Getting Started
Chaosyr Nov 21, 2026
2f807cb
Make the spacing between the arrow and toc item larger
Chaosyr Nov 21, 2026
66e7102
Part 2 of Getting Started Rework into Sub-Items
Chaosyr Nov 21, 2026
4edad58
Mermaid Styling
Chaosyr Nov 21, 2026
282ea90
add color to mermaid styling
Chaosyr Nov 21, 2026
9317e82
More Mermaid Styling
Chaosyr Nov 21, 2026
ee57ab7
Even More Mermaid Styling
Chaosyr Nov 21, 2026
c416dcf
Yet Again More Mermaid
Chaosyr Nov 21, 2026
c57e0d0
change linking from .md to .html for getting started (modders)
Chaosyr Nov 21, 2026
5c3b180
Pinch More Mermaid CSS
Chaosyr Nov 21, 2026
ff37b5d
Add Headers to the Getting Started Modders Section Index's
Chaosyr Nov 21, 2026
4507b63
More Mermaid Stuff
Chaosyr Nov 21, 2026
c011cba
Mermaid Upgrades
Chaosyr Nov 21, 2026
15a95b4
Mermaid Upgrades Pt.2
Chaosyr Nov 21, 2026
ae95d98
Mermaid Accounts for Style Changes Now
Chaosyr Nov 21, 2026
807e1f4
Fixup Getting Started Index Mermaid
Chaosyr Nov 21, 2026
2e5c99e
Mermaid Render Fixes
Chaosyr Nov 21, 2026
41ec7a1
quick fix
Chaosyr Nov 21, 2026
464c2b9
disable max width on mermaid
Chaosyr Nov 22, 2026
cdde6f3
More Mermaid Tweaks
Chaosyr Nov 22, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
165 changes: 133 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,53 +120,154 @@ If you have any issues with Mac/Linux, Steam Deck, or Manual head over to the di

## Getting Started: Modding

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything I said on getting_started.md applies here.

---
Modding Inscryption requires a knowledge of coding in C#, and in many cases an understanding of how to patch the game using HarmonyPatch.
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](https://github.com/BepInEx/HarmonyX/wiki) for HarmonyX, and [here](https://harmony.pardeike.net/v2/articles/intro.html) 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](https://inscryption.thunderstore.io/package/MADH95Mods/JSONCardLoader/).
If you're unfamiliar with any of this, or just want to create cards and sigils, you can use [JSONLoader](https://inscryption.thunderstore.io/package/MADH95Mods/JSONCardLoader/), 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](https://www.youtube.com/watch?v=GhQdlIFylQ8). 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](https://www.jetbrains.com/rider/), you'll specifically want the `Free for non-commerical use` version. If your familiar with the UX of [IntelliJ Idea](https://www.jetbrains.com/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](https://discord.gg/qEqtF29ZEt) 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 mode that provides a more beginner-friendly way of creating new cards and abilities for Inscryption using JSON syntax, which is much simpler than C#.
> 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](https://www.youtube.com/watch?v=iiADhChRriM).

JSONLoader's documentation can be found [here](https://github.com/MADH95/JSONLoader).
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](https://github.com/Chaosyr/JSONCardLoaderWiki/wiki)
- Nightly Thunderstore Wiki: [Thunderstore Wiki](https://thunderstore.io/c/inscryption/p/MADH95Mods/JSON_and_CSV_Loader_Nightly/wiki)
- Stable GitHub Wiki: [GitHub Wiki](https://github.com/MADH95/JSONLoader/wiki)
- Stable Thunderstore Wiki: [Thunderstore Wiki](https://thunderstore.io/c/inscryption/p/MADH95Mods/JSONCardLoader/wiki)

A video tutorial covering how to use JSONLoader in a basic form can be found [here](https://www.youtube.com/watch?v=grTSkpI4U7g).
A video tutorial covering how to use JSONLoader in a basic form can be found [here](https://www.youtube.com/watch?v=grTSkpI4U7g). A more updated series of sorts by JamesGames can be found [here](https://youtube.com/playlist?list=PLy57qL2R3Z6NaRJKF4QBaBn6WH8Vztya9&si=npQ2ZxF4gHRXa0B3). If you at any point need any help with JSONLoader, you can ask your questions in [the discord](https://discord.gg/BNDVDA5Gvh), specifically the `jsonloader-help` channel.

### Modding with C#
To begin modding with C#, you will need to create a new C# project using a code editor.
We recommend and assume you're using Microsoft's Visual Studio.

Your project's target framework needs to be `netstandard2.0`.

Once your project's created, go to `Project > Manage NuGet Packages`.
Click the dropdown menu for 'Package source' and check that 'BepInEx' and 'nuget' is there.
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](https://www.jetbrains.com/rider/). This guide will follow the layout of this IDE. If you still want to use [Visual Studio](https://visualstudio.microsoft.com/) 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

<details open>
<summary>
Click me to close
</summary>

Now that you have your IDE, we'll start by making our Project.

1. Open up the IDE, than click on `New`, followed by `New Solution`.
2. One the menu pops up select `Class Library` from the Left-Side panel.
3. Next we want to fill in some fields
1. Where it says `Solution Name`, update the associated field to the name of your mod.
2. Next to that field theres a little thing that says `format`, click the drop down and change it to `sln`.
3. Where it says `Target Framework`, select the dropdown and change it to `v4.7.2`. If it is not present, that means you don't have the SDK or Framework installed.
1. First ensure the [Net10 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/10.0) is installed, you'll want the `SDK` associated with your OS and Architecture. Note you will want to download an `Installer` not a `Binary`.
2. Now ensure the [Netframework 4.7.2](https://dotnet.microsoft.com/en-us/download/dotnet-framework/net472) is installed, you'll want the `Offline Installer` under `Build Apps` called the `Developer Pack`.
4. Ensure the `Language` is set to `C#`, and the Type is set to `Class Library`.
4. 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.

1. Right-Click on the `Solution`, hover over `Open In`, than select `Explorer`.
2. Once open you should see the File Explorer opened to a folder containing an `sln` file with a name matching your Project's.
3. In this folder create a new text file, than open it in a text editor. Now enter the following into the text file:
```xml
<?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>
```
4. Save the file, and rename it to `NuGet.Config`.
5. If you don't see the sources in your IDE, try following this short guide and try again: [File Explorer (Windows); JSONLoader Wiki](https://github.com/Chaosyr/JSONCardLoaderWiki/wiki/JSON-and-CSV-Loader-API-Documentation-%E2%80%90-JSON-Inscrybing#file-explorer-windows). 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](https://thunderstore.io/c/inscryption/p/Nevernamed/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.

</details>

#### Visual Studio Based Project Setups

<details>
<summary>
Click me to expand
</summary>

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.

<details>
<summary>
Via Package Source Configuration
</summary>
For each missing source you will want to do the following:

1. Click on the `Gear` icon next to the package source selector.
2. Click the large green `Plus`.
3. Set the fields to match what is shown in the below list:
- To add `BepInEx`, change the name to `BepInEx` and the source link to `https://nuget.bepinex.dev/v3/index.json`.
- To add `nuget.org`, change the name to `nuget.org` and the source link to `https://api.nuget.org/v3/index.json`.
- To add `ts-nuget`, change the name to `ts-nuget` and the source link to `https://nuget.windows10ce.com/nuget/v3/index.json`.

</details>

<details>
<summary>
Via File
</summary>

1. Right-Click the `Solution` found at the top of the `Solution Explorer`.
2. Click `Open Folder in File Explorer`.
3. Once open you should see the File Explorer opened to a folder containing an `sln` file with a name matching your Project's.
4. In this folder create a new text file, than open it in a text editor. Now enter the following into the text file:
```xml
<?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>
```
5. Save the file, and rename it to `NuGet.Config`.
6. If you don't see the sources in your IDE, try following this short guide and try again: [File Explorer (Windows); JSONLoader Wiki](https://github.com/Chaosyr/JSONCardLoaderWiki/wiki/JSON-and-CSV-Loader-API-Documentation-%E2%80%90-JSON-Inscrybing#file-explorer-windows). 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 Configuration` method.

If BepInEx or nuget aren't an available source, we need to add them.
To add a new package source, click on the gear icon next to the package source selector, then click the large green plus-sign.
</details>

To add BepInEx, change the name to 'BepInEx' and the source link to 'https://nuget.bepinex.dev/v3/index.json'.
To add nuget, change the name to 'nuget' and the source link to 'https://nuget.windows10ce.com/nuget/v3/index.json'.
Now that we have this setup change the package source to `All`. Also ensure `Prerelease` is ticked on.

Change the package source to 'All' then click 'Browse'.
We want to install the following packages (**Make sure the version numbers match!**):
- BepInEx.Analyzers v1.0.8
- BepInEx.Core v5.4.19
- HarmonyX v2.9.0
- Inscryption.GameLibs v1.9.0-r.0
- UnityEngine.Modules v2019.4.24
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.

You will also need to add the API as a reference.
There are a couple ways to do this, detailed below; whichever way you choose to do this, you'll also need to need to reference `InscryptionAPI.dll`, which should be in your BepInEx plugins folder; copy this path for future use.
| 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` |

To do so, go to your 'BepInEx/plugins' folder and copy the folder path.
Then, navigate to `Project > Add Project Reference` and click 'Browse'.
Copy the folder path and add 'InscryptionAPI.dll' as a reference.
You can do this for other mods' .dll files if you want to reference them as a mod dependency (a separate mod that your mod relies on to work).
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](https://thunderstore.io/c/inscryption/p/Nevernamed/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.

An alternative method to adding the API (and other mods) as a reference is to use NuGet packages by adding 'https://nuget.bepinex.dev/v3/index.json' as a package source, and then adding 'API_dev-API' as a reference.
</details>

With all this, 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.
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
[Inscryption Modding Discord](https://discord.gg/QrJEF5Denm)
Expand Down
2 changes: 1 addition & 1 deletion docs/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
"files": ["community/**.yml", "community/index.md"]
},
{
"files": ["wiki/toc.yml", "wiki/**.md"]
"files": ["wiki/toc.yml", "wiki/**.md", "wiki/**.yml"]
},
{
"files": ["toc.yml", "index.md"]
Expand Down
Loading
Loading