Skip to content

Commit 2b8f198

Browse files
committed
Update README.md
1 parent d906748 commit 2b8f198

File tree

1 file changed

+84
-1
lines changed

1 file changed

+84
-1
lines changed

README.md

Lines changed: 84 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ It can currently create and modify:
2525

2626
Additionally, a number of quality-of-life patches from the community are included with each release.
2727

28+
## Getting Started: Installation
29+
---
30+
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.
31+
2832
### Installing with a Mod Manager
2933
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/) or [r2modman](https://thunderstore.io/c/inscryption/p/ebkr/r2modman/).
3034
2. Click the **Install with Mod Manager** button on the top of [BepInEx's](https://thunderstore.io/package/download/BepInEx/BepInExPack_Inscryption/5.4.1902/) page.
@@ -44,6 +48,24 @@ If you have issues with ModmManagers head to one of these discords;
4448
6. Install [Inscryption API](https://inscryption.thunderstore.io/package/API_dev/API/) and extract the contents into a folder.
4549
7. Move the contents of the 'plugins' folder into 'BepInEx/plugins' and the contents of the 'monomod' folder into the 'BepInEx/monomod' folder.
4650
8. Run the game again. If everything runs correctly, a message will appear in the console telling you that the API was loaded.
51+
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;
52+
```
53+
BepInEx // These go within the BepInEx root folder
54+
|-- config
55+
|-- patchers
56+
|-- plugins
57+
|-- monomod
58+
|-- core
59+
plugins // Files within go into the created plugin subfolder that was created for the mod
60+
|-- Art
61+
|-- Scripts
62+
|-- MyMod.dll
63+
manifest.json --|
64+
README.md |-- These can be ignored but if you want to keep them put them in the plugin subfolder
65+
CHANGELOG.md |--
66+
icon.png --|
67+
```
68+
10. Run the game once more and everything should be correct and working.
4769

4870
### Installing on the Steam Deck
4971
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.
@@ -57,13 +79,74 @@ If you have issues with ModmManagers head to one of these discords;
5779

5880
### Mac & Linux
5981
1. Follow the steps here first: <https://docs.bepinex.dev/articles/user_guide/installation/index.html>
60-
2. Next do steps 4-8 of the Manual Installation
82+
2. Next do steps 4-10 of the Manual Installation
6183
3. Your game should be setup for inscryption modding now
6284

6385
If you have any issues with Mac/Linux, Steam Deck, or Manual head over to the discord for this game:
6486

6587
* **Inscryption Modding Discord:** [Here](https://discord.gg/ZQPvfKEpwM)
6688

89+
## Getting Started: Modding
90+
---
91+
Modding Inscryption requires a knowledge of coding in C#, and in many cases an understanding of how to patch the game using HarmonyPatch.
92+
93+
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/).
94+
95+
### Modding with JSONLoader
96+
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#.
97+
98+
JSONLoader's documentation can be found [here](https://github.com/MADH95/JSONLoader).
99+
100+
A video tutorial covering how to use JSONLoader in a basic form can be found [here](https://www.youtube.com/watch?v=grTSkpI4U7g).
101+
102+
### Modding with C#
103+
To begin modding with C#, you will need to create a new C# project using a code editor.
104+
We recommend and assume you're using Microsoft's Visual Studio.
105+
106+
Your project's target framework needs to be `netstandard2.0`.
107+
108+
Once your project's created, go to `Project > Manage NuGet Packages`.
109+
Click the dropdown menu for 'Package source' and check that 'BepInEx' and 'nuget' is there.
110+
111+
If BepInEx or nuget aren't an available source, we need to add them.
112+
To add a new package source, click on the gear icon next to the package source selector, then click the large green plus-sign.
113+
114+
To add BepInEx, change the name to 'BepInEx' and the source link to 'https://nuget.bepinex.dev/v3/index.json'.
115+
To add nuget, change the name to 'nuget' and the source link to 'https://nuget.windows10ce.com/nuget/v3/index.json'.
116+
117+
Change the package source to 'All' then click 'Browse'.
118+
We want to install the following packages (**Make sure the version numbers match!**):
119+
- BepInEx.Analyzers v1.0.8
120+
- BepInEx.Core v5.4.19
121+
- HarmonyX v2.9.0
122+
- Inscryption.GameLibs v1.9.0-r.0
123+
- UnityEngine.Modules v2019.4.24
124+
125+
You will also need to add the API as a reference.
126+
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.
127+
128+
To do so, go to your 'BepInEx/plugins' folder and copy the folder path.
129+
Then, navigate to `Project > Add Project Reference` and click 'Browse'.
130+
Copy the folder path and add 'InscryptionAPI.dll' as a reference.
131+
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).
132+
133+
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.
134+
135+
With all this, you are now ready to begin creating your mod!
136+
Some resources are provided below for you to use, including an example mod to look at for examples.
137+
Otherwise, continue reading this wiki.
138+
139+
### Modding Resources
140+
[Inscryption Modding Discord](https://discord.gg/QrJEF5Denm)
141+
142+
[BepInEx documentation](https://docs.bepinex.dev/)
143+
144+
[Harmony patching article](https://harmony.pardeike.net/articles/patching.html)
145+
146+
[Example Mod using C#](https://github.com/debugman18/InscryptionExampleMod)
147+
148+
[Vanilla and Modded Enumerations](https://github.com/SaxbyMod/SabyModEnums)
149+
67150
An example mod utilising this plugin can be found [here](https://github.com/debugman18/InscryptionExampleMod),
68151
and the modding wiki and documentation can be found [here](https://inscryptionmodding.github.io/InscryptionAPI/wiki/index.html).
69152

0 commit comments

Comments
 (0)