Skip to content

Commit c5b2f45

Browse files
Updated installation instructions for ReadMe
1 parent 868cd6f commit c5b2f45

1 file changed

Lines changed: 40 additions & 18 deletions

File tree

README.md

Lines changed: 40 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -17,28 +17,47 @@ It can currently create and modify:
1717
- Totem Tops
1818
- Consumable Items
1919
- Gramophone Tracks
20+
- Slot Modifications
2021
- Talking Cards
2122
- Custom Costs
23+
- Custom Rulebook Pages
24+
- Rulebook Redirects/Hyperlinks
2225
- And much more!
2326

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

26-
## Installation (automated)
27-
This is the recommended way to install the API on the game.
28-
29-
- Download and install [Thunderstore Mod Manager](https://www.overwolf.com/app/Thunderstore-Thunderstore_Mod_Manager) or [r2modman](https://timberborn.thunderstore.io/package/ebkr/r2modman/).
30-
- 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.
31-
- Run the game via the mod manager.
32-
33-
## Installation (manual)
34-
To install this plugin first you need to install BepInEx as a mod loader for Inscryption. A guide to do this can be found [here](https://docs.bepinex.dev/articles/user_guide/installation/index.html#where-to-download-bepinex). Inscryption needs the 86x (32 bit) mono version.
35-
You also need to install [MonoMod Loader Inscryption](https://inscryption.thunderstore.io/package/BepInEx/MonoMod_Loader_Inscryption/).
36-
37-
- Copy the 'plugins' folder into 'BepInEx/plugins'.
38-
- Copy the 'monomod' folder into 'BepInEx/monomod'.
39-
(If any of these folders do not exist, just create them.)
40-
41-
An example Mod utilising this plugin can be found [here](https://github.com/debugman18/InscryptionExampleMod).
29+
### Installing with a Mod Manager (recommended)
30+
1. Download and install [Thunderstore Mod Manager](https://www.overwolf.com/app/Thunderstore-Thunderstore_Mod_Manager) or [r2modman](https://Timberborn.thunderstore.io/package/ebkr/r2modman/).
31+
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.
32+
3. Run the game via the mod manager.
33+
34+
### Installing Manually
35+
1. Install [BepInEx](https://thunderstore.io/package/download/BepInEx/BepInExPack_Inscryption/5.4.1902/) by pressing 'Manual Download' and extract the contents into a folder. **Do not extract into the game folder!**
36+
2. Move the contents of the 'BepInExPack_Inscryption' folder into the game folder (where the game executable is).
37+
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.
38+
4. Install [MonoModLoader](https://inscryption.thunderstore.io/package/BepInEx/MonoMod_Loader_Inscryption/) and extract the contents into a folder.
39+
5. Move the contents of the 'patchers' folder into 'BepInEx/patchers' (If any of the mentioned BepInEx folders don't exist, just create them).
40+
6. Install [Inscryption API](https://inscryption.thunderstore.io/package/API_dev/API/) and extract the contents into a folder.
41+
7. Move the contents of the 'plugins' folder into 'BepInEx/plugins' and the contents of the 'monomod' folder into the 'BepInEx/monomod' folder.
42+
8. Run the game again. If everything runs correctly, a message will appear in the console telling you that the API was loaded.
43+
44+
### Installing on the Steam Deck
45+
1. Download [r2modman](https://Timberborn.thunderstore.io/package/ebkr/r2modman/) on the Steam Deck’s Desktop Mode and open it from its download using its `AppImage` file.
46+
2. Download the mods you plan on using and their dependencies..
47+
3. Go to the setting of the profile you are using for the mods and click `Browse Profile Folder`.
48+
4. Copy the BepInEx folder, then go to Steam and open Inscryption's Properties menu
49+
5. Go to `Installed Files` click `Browse` to open the folder containing Inscryption's local files; paste the BepInEx folder there.
50+
6. Enter Gaming Mode and check 'Force the use of a specific Steam Play compatibility tool' in the Properties menu under `Compatibility`.
51+
7. Go to the launch parameters and enter `WINEDLLOVERRIDES=“winhttp.dll=n,b” %command%`.
52+
8. Open Inscryption. If everything was done correctly, you should see a console appear on your screen.
53+
54+
### Mac & Linux
55+
1. Follow the steps here first: [Installing BepInEx](https://docs.bepinex.dev/articles/user_guide/installation/index.html?tabs=tabid-nix)
56+
2. Next do steps 4-8 of the Manual Installation
57+
3. Your game should be setup for inscryption modding now
58+
59+
An example mod utilising this plugin can be found [here](https://github.com/debugman18/InscryptionExampleMod),
60+
and the modding wiki and documentation can be found [here](https://inscryptionmodding.github.io/InscryptionAPI/wiki/index.html).
4261

4362
## Modded Save File
4463
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.
@@ -76,7 +95,7 @@ Displays targets for attacks made with the sniper sigil in Act 1.
7695
## Act 1 Sentry Fixes by WhistleWind
7796
Fixes a number of bugs caused by the Sentry ability being used in Act 1.
7897

79-
## Multi-Act Sigil Compatability Fixes by WhistleWind
98+
## Multi-Act Sigil Compatibility Fixes by WhistleWind
8099
Fixes a number of sigils to be usable in all Acts. Sigils include: Mental Gemnastics, Tidal Lock, Hoarder, Vessel Printer, Amorphous, Handy.
81100

82101
## Fledgling Sigil Fixes by WhistleWind
@@ -85,6 +104,9 @@ Fixes Fledgling in Act 2 to show the correct number of turns until a card evolve
85104
## OverridePixelAbilityIcons by WhistleWind
86105
Fixes the OverrideAbilityIcon method to work in Act 2.
87106

107+
## Temporary Mod Fixes by WhistleWind
108+
- Fixes issues related to using temporary mods in Act 2 or to add custom decals
109+
88110
# Using the API
89111

90112
Inscryption API 2.0 tries to have you use the original game's objects as much as possible. For example, there are no more 'NewCard' and 'CustomCard' objects; instead, you are responsible to create CardInfo objects yourself and add them.
@@ -97,7 +119,7 @@ For more information, please check out the wiki: https://inscryptionmodding.gith
97119
### How can you help?
98120
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.
99121

100-
### But really, I want to help develop this mod
122+
### But really, I want to help develop this mod!
101123
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).
102124

103125
### Can I donate?

0 commit comments

Comments
 (0)