Skip to content

Commit cd70d28

Browse files
ChaosyrChaosyr
authored
Update Guides in the README.md
1 parent d92ac2a commit cd70d28

1 file changed

Lines changed: 38 additions & 10 deletions

File tree

‎README.md‎

Lines changed: 38 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ To begin, we'll go over how to install BepInEx, the framework all Inscryption mo
3131

3232
### Installing with a Mod Manager
3333
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/).
34-
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.
34+
2. Click the **Install with Mod Manager** button on the top of [BepInEx's](https://thunderstore.io/c/inscryption/p/BepInEx/BepInExPack_Inscryption/) page.
3535
3. Run the game via the mod manager.
3636

3737
If you have issues with ModmManagers head to one of these discords;
@@ -40,15 +40,43 @@ If you have issues with ModmManagers head to one of these discords;
4040
* **Gale Mod Manager Support Discord:** [Here](https://discord.gg/sfuWXRfeTt)
4141

4242
### Installing Manually
43-
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!**
44-
2. Move the contents of the 'BepInExPack_Inscryption' folder into the game folder (where the game executable is).
43+
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!**
44+
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`).
4545
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.
4646
4. Install [MonoModLoader](https://inscryption.thunderstore.io/package/BepInEx/MonoMod_Loader_Inscryption/) and extract the contents into a folder.
47-
5. Move the contents of the 'patchers' folder into 'BepInEx/patchers' (If any of the mentioned BepInEx folders don't exist, just create them).
47+
5. Move the contents of the `patchers` folder into `BepInEx/patchers` (If any of the mentioned BepInEx folders don't exist, just create them).
4848
6. Install [Inscryption API](https://inscryption.thunderstore.io/package/API_dev/API/) and extract the contents into a folder.
49-
7. Move the contents of the 'plugins' folder into 'BepInEx/plugins' and the contents of the 'monomod' folder into the 'BepInEx/monomod' folder.
49+
7. Move the contents of the `plugins` folder into `BepInEx/plugins` and the contents of the `monomod` folder into the `BepInEx/monomod` folder.
5050
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;
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.
69+
70+
### Installing Manually (XBOX Game-Pass)
71+
1. Install [BepInEx](<https://github.com/BepInEx/BepInEx/releases/tag/v5.4.21>) by pressing `BepInEx_x64_5.4.21.0.zip` and extract the contents into a folder.
72+
2. Move the contents into the game folder (where the game executable is; usually found here: `C:\XboxGames\D30AC640-4EC1-4D15-96F3-384052F09699\Content`).
73+
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. (psst. Enable Logging in `BepInEx/config`)
74+
4. Install [MonoModLoader](<https://inscryption.thunderstore.io/package/BepInEx/MonoMod_Loader_Inscryption/>) and extract the contents into a folder.
75+
5. Move the contents of the `patchers` folder into `BepInEx/patchers` (If any of the mentioned BepInEx folders don't exist, just create them).
76+
6. Install [Inscryption API](<https://inscryption.thunderstore.io/package/API_dev/API/>) and extract the contents into a folder.
77+
7. Move the contents of the 'plugins' folder into `BepInEx/plugins` and the contents of the `monomod` folder into the `BepInEx/monomod` folder.
78+
8. Run the game again. If everything runs correctly, a message will appear in the console telling you that the API was loaded.
79+
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;
5280
```
5381
BepInEx // These go within the BepInEx root folder
5482
|-- config
@@ -68,13 +96,13 @@ icon.png --|
6896
10. Run the game once more and everything should be correct and working.
6997

7098
### Installing on the Steam Deck
71-
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.
72-
2. Download the mods you plan on using and their dependencies..
99+
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.
100+
2. Download the mods you plan on using and their dependencies.
73101
3. Go to the setting of the profile you are using for the mods and click `Browse Profile Folder`.
74102
4. Copy the BepInEx folder, then go to Steam and open Inscryption's Properties menu
75103
5. Go to `Installed Files` click `Browse` to open the folder containing Inscryption's local files; paste the BepInEx folder there.
76104
6. Enter Gaming Mode and check 'Force the use of a specific Steam Play compatibility tool' in the Properties menu under `Compatibility`.
77-
7. Go to the launch parameters and enter `WINEDLLOVERRIDES=“winhttp.dll=n,b” %command%`.
105+
7. Go to the launch parameters and enter `WINEDLLOVERRIDES="winhttp.dll=n,b" %command%`.
78106
8. Open Inscryption. If everything was done correctly, you should see a console appear on your screen.
79107

80108
### Mac & Linux
@@ -234,4 +262,4 @@ Contributors and builders of API 2.0:
234262
- WhistleWind
235263
- Windows10CE
236264
- Keks307
237-
- ThinCreator3483
265+
- ThinCreator3483

0 commit comments

Comments
 (0)