You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit de098bf
Browse filesBrowse the repository at this point in the historyBrowse files
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:
4
+
5
+
*[Inscryption API Documentation](api/index.md)
6
+
*[Inscryption Community Patch Documentation](community/index.md)
7
+
*[Inscryption Modding Wiki](wiki/index.md)
8
+
9
+
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](https://github.com/InscryptionModding/InscryptionAPI/tree/main/docs), 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.
15
+
16
+
___
17
+
1
18
## Inscryption API
19
+
20
+
This plugin is a BepInEx plugin made for Inscryption as an API. This is the de-facto standard API for Inscryption modders.
21
+
22
+
It can currently create and modify:
23
+
- Cards
24
+
- Abilities
25
+
- Appearance behaviours
26
+
- Stat Icons
27
+
- Challenges
28
+
- Starter Decks
29
+
- Regions
30
+
- Encounters
31
+
- Totem Tops
32
+
- Consumable Items
33
+
- Gramophone Tracks
34
+
- Slot Modifications
35
+
- Talking Cards
36
+
- Custom Costs
37
+
- Custom Rulebook Pages
38
+
- Rulebook Redirects/Hyperlinks
39
+
- And much more!
40
+
41
+
Additionally, a number of quality-of-life patches from the community are included with each release.
42
+
43
+
___
44
+
45
+
## Getting Started: Installation
46
+
---
47
+
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.
48
+
49
+
**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`.
50
+
51
+
### Installing with a Mod Manager
52
+
1. Download and install [Thunderstore Mod Manager](https://www.overwolf.com/app/Thunderstore-Thunderstore_Mod_Manager), [Gale](https://thunderstore.io/c/inscryption/p/Kesomannen/GaleModManager/), [Pulsar](https://pulsarmods.com/) or [r2modman](https://thunderstore.io/c/inscryption/p/ebkr/r2modman/).
53
+
2. Click the **Install with Mod Manager** button on the top of [BepInEx's](https://thunderstore.io/c/inscryption/p/BepInEx/BepInExPack_Inscryption/) page.
54
+
3. Run the game via the mod manager.
55
+
56
+
If you have issues with Mod Managers head to one of these discords;
57
+
58
+
***Thunderstore Support Discord:**[Here](https://discord.gg/Fbz54kQAxg)
59
+
***R2ModMan Support Discord:**[Here](https://discord.gg/R85wjqa4WN)
60
+
***Gale Mod Manager Support Discord:**[Here](https://discord.gg/sfuWXRfeTt)
61
+
62
+
### Installing Manually
63
+
1. Install [BepInEx](https://thunderstore.io/package/download/BepInEx/BepInExPack_Inscryption/5.4.2305/) by pressing `Manual Download` and extract the contents into a folder. **Do not extract into the game folder!**
64
+
2. 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`).
65
+
3. 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.
66
+
4. Install [MonoModLoader](https://inscryption.thunderstore.io/package/BepInEx/MonoMod_Loader_Inscryption/) and extract the contents into a folder.
67
+
5. Move the contents of the `patchers` folder into `BepInEx/patchers` (If any of the mentioned BepInEx folders don't exist, just create them).
68
+
6. Install [Inscryption API](https://inscryption.thunderstore.io/package/API_dev/API/) and extract the contents into a folder.
69
+
7. Move the contents of the `plugins` folder into `BepInEx/plugins` and the contents of the `monomod` folder into the `BepInEx/monomod` folder.
70
+
8. Run the game again. If everything runs correctly, a message will appear in the console telling you that the API was loaded.
71
+
9. 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;
72
+
```
73
+
BepInEx // These go within the BepInEx root folder
74
+
|-- config
75
+
|-- patchers
76
+
|-- plugins
77
+
|-- monomod
78
+
|-- core
79
+
plugins // Files within go into the created plugin subfolder that was created for the mod
80
+
|-- Art
81
+
|-- Scripts
82
+
|-- MyMod.dll
83
+
manifest.json // Ignorable, but if kept, goes in plugin subfolder
84
+
README.md // Ignorable, but if kept, goes in plugin subfolder
85
+
CHANGELOG.md // Ignorable, but if kept, goes in plugin subfolder
86
+
icon.png // Ignorable, but if kept, goes in plugin subfolder
87
+
```
88
+
10. Run the game once more and everything should be correct and working.
89
+
90
+
### Installing Manually (XBOX Game-Pass)
91
+
1. Install [BepInEx](https://thunderstore.io/package/download/BepInEx/BepInExPack_Inscryption/5.4.2305/) by pressing `Manual Download` and extract the contents into a folder. **Do not extract into the game folder!**
92
+
2. Move the contents of the `BepInExPack_Inscryption` folder into the game folder (where the game executable is; usually found here: `C:\XboxGames\Inscryption\Content`).
93
+
3. Install the following package: [XboxSilencio](https://thunderstore.io/c/inscryption/p/CORE_API_TEAM/GamepassSilencio/), this is a package which aims to solve frictions with XBOX Gamepass specific installations, such as HueyFS related errors.
94
+
4. 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.
95
+
5. Install [MonoModLoader](https://inscryption.thunderstore.io/package/BepInEx/MonoMod_Loader_Inscryption/) and extract the contents into a folder.
96
+
6. Move the contents of the `patchers` folder into `BepInEx/patchers` (If any of the mentioned BepInEx folders don't exist, just create them).
97
+
7. Install [Inscryption API](https://inscryption.thunderstore.io/package/API_dev/API/) and extract the contents into a folder.
98
+
8. Move the contents of the `plugins` folder into `BepInEx/plugins` and the contents of the `monomod` folder into the `BepInEx/monomod` folder.
99
+
9. Run the game again. If everything runs correctly, a message will appear in the console telling you that the API was loaded.
100
+
10. 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;
101
+
```
102
+
BepInEx // These go within the BepInEx root folder
103
+
|-- config
104
+
|-- patchers
105
+
|-- plugins
106
+
|-- monomod
107
+
|-- core
108
+
plugins // Files within go into the created plugin subfolder that was created for the mod
109
+
|-- Art
110
+
|-- Scripts
111
+
|-- MyMod.dll
112
+
manifest.json // Ignorable, but if kept, goes in plugin subfolder
113
+
README.md // Ignorable, but if kept, goes in plugin subfolder
114
+
CHANGELOG.md // Ignorable, but if kept, goes in plugin subfolder
115
+
icon.png // Ignorable, but if kept, goes in plugin subfolder
116
+
```
117
+
11. Run the game once more and everything should be correct and working.
118
+
119
+
### Installing on the Steam Deck
120
+
1. Download [r2modman](https://thunderstore.io/c/inscryption/p/ebkr/r2modman/) on the Steam Deck's Desktop Mode and open it from its download using its `AppImage` file.
121
+
2. Download the mods you plan on using and their dependencies.
122
+
3. Go to the setting of the profile you are using for the mods and click `Browse Profile Folder`.
123
+
4. Copy the BepInEx folder, then go to Steam and open Inscryption's Properties menu
124
+
5. Go to `Installed Files` click `Browse` to open the folder containing Inscryption's local files; paste the BepInEx folder there.
125
+
6. Enter Gaming Mode and check 'Force the use of a specific Steam Play compatibility tool' in the Properties menu under `Compatibility`.
126
+
7. Go to the launch parameters and enter `WINEDLLOVERRIDES="winhttp.dll=n,b" %command%`.
127
+
8. Open Inscryption. If everything was done correctly, you should see a console appear on your screen.
128
+
129
+
### Mac & Linux
130
+
1. Follow the steps here first: <https://docs.bepinex.dev/articles/user_guide/installation/index.html>
131
+
2. Next do steps 4-10 of the Manual Installation
132
+
3. Your game should be setup for inscryption modding now
133
+
134
+
If you have any issues with Mac/Linux, Steam Deck, or Manual head over to the discord for this game:
Welcome to the site of the Inscryption Modding API!
4
-
You can find the wiki and API documentation here.
140
+
Modding Inscryption requires a knowledge of coding in C#, and in many cases an understanding of how to patch the game using HarmonyPatch.
141
+
142
+
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/).
143
+
144
+
### Modding with JSONLoader
145
+
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#.
146
+
147
+
JSONLoader's documentation can be found [here](https://github.com/MADH95/JSONLoader).
148
+
149
+
A video tutorial covering how to use JSONLoader in a basic form can be found [here](https://www.youtube.com/watch?v=grTSkpI4U7g).
150
+
151
+
### Modding with C#
152
+
To begin modding with C#, you will need to create a new C# project using a code editor.
153
+
We recommend and assume you're using Microsoft's Visual Studio.
154
+
155
+
Your project's target framework needs to be `netstandard2.0`.
156
+
157
+
Once your project's created, go to `Project > Manage NuGet Packages`.
158
+
Click the dropdown menu for 'Package source' and check that 'BepInEx' and 'nuget' is there.
159
+
160
+
If BepInEx or nuget aren't an available source, we need to add them.
161
+
To add a new package source, click on the gear icon next to the package source selector, then click the large green plus-sign.
162
+
163
+
To add BepInEx, change the name to 'BepInEx' and the source link to 'https://nuget.bepinex.dev/v3/index.json'.
164
+
To add nuget, change the name to 'nuget' and the source link to 'https://nuget.windows10ce.com/nuget/v3/index.json'.
5
165
6
-
## Some Links
166
+
Change the package source to 'All' then click 'Browse'.
167
+
We want to install the following packages (**Make sure the version numbers match!**):
168
+
- BepInEx.Analyzers v1.0.8
169
+
- BepInEx.Core v5.4.19
170
+
- HarmonyX v2.9.0
171
+
- Inscryption.GameLibs v1.9.0-r.0
172
+
- UnityEngine.Modules v2019.4.24
173
+
174
+
You will also need to add the API as a reference.
175
+
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.
176
+
177
+
To do so, go to your 'BepInEx/plugins' folder and copy the folder path.
178
+
Then, navigate to `Project > Add Project Reference` and click 'Browse'.
179
+
Copy the folder path and add 'InscryptionAPI.dll' as a reference.
180
+
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).
181
+
182
+
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.
183
+
184
+
With all this, you are now ready to begin creating your mod!
185
+
Some resources are provided below for you to use, including an example mod to look at for examples.
[Example Mod using C#](https://github.com/debugman18/InscryptionExampleMod)
196
+
197
+
[Vanilla and Modded Enumerations](https://github.com/SaxbyMod/SabyModEnums)
198
+
199
+
An example mod utilising this plugin can be found [here](https://github.com/debugman18/InscryptionExampleMod),
200
+
and the modding wiki and documentation can be found [here](https://inscryptionmodding.github.io/InscryptionAPI/wiki/index.html).
201
+
202
+
___
203
+
204
+
## Modded Save File
205
+
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.
206
+
207
+
___
208
+
209
+
## Community Patches
210
+
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.
211
+
212
+
### SigilArtPatch by MADH95Mods
213
+
Fixes the art for abilities that previously only appeared in Act 2 so they appear correctly in Act 1 and Act 3
214
+
215
+
### Conduit Attack Fix by MADH95Mods
216
+
Fixes the behavior of conduits so they function correctly in Act 1.
217
+
218
+
### Activated Sigil Fix by MADH95Mods
219
+
Allows activated sigils to work correctly in Act 1 and Act 3 by clicking the sigil icon on the card.
220
+
221
+
### AnthonysLatchFix by AnthonyPython
222
+
Fixes latch sigils to work in Act 1
223
+
224
+
### Sigil Art Fix by Memez4Life
225
+
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).
226
+
227
+
### Visually Stackable Sigils by divisionbyz0rro
228
+
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.
229
+
230
+
### Cost Render Fix by Void Slime
231
+
Displays hybrid cost cards correctly and makes energy and mox show up on act 1 cards
232
+
233
+
### Cost Choice Node fix by Void Slime
234
+
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.
235
+
236
+
### Sniper Sigil Fix by SpecialAPI
237
+
Displays targets for attacks made with the sniper sigil in Act 1.
238
+
239
+
### Act 1 Sentry Fixes by WhistleWind
240
+
Fixes a number of bugs caused by the Sentry ability being used in Act 1.
241
+
242
+
### Multi-Act Sigil Compatibility Fixes by WhistleWind
243
+
Fixes a number of sigils to be usable in all Acts. Sigils include: Mental Gemnastics, Tidal Lock, Hoarder, Vessel Printer, Amorphous, Handy.
244
+
245
+
### Fledgling Sigil Fixes by WhistleWind
246
+
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.
247
+
248
+
### OverridePixelAbilityIcons by WhistleWind
249
+
Fixes the OverrideAbilityIcon method to work in Act 2.
250
+
251
+
### Temporary Mod Fixes by WhistleWind
252
+
- Fixes issues related to using temporary mods in Act 2 or to add custom decals
253
+
254
+
___
255
+
256
+
## Contribution
257
+
258
+
### How can you help?
259
+
Use the plugin and report bugs you find! Ping us on the [Inscryption Modding Discord](https://discord.gg/QrJEF5Denm) server in the api channel with what you find.
260
+
261
+
### But really, I want to help develop this mod!
262
+
Great! We're more than happy to accept help. Either make a pull request to the API's [GitHub page](https://github.com/InscryptionModding/InscryptionAPI) or come join us over in the [Inscryption Modding Discord](https://discord.gg/QrJEF5Denm).
263
+
264
+
### Can I donate?
265
+
Donations are totally not needed, this is a passion project before anything else.
0 commit comments