Skip to content

Commit 2a5d721

Browse files
ChaosyrChaosyr
committed
Update Installation Guides
1 parent 9fefbca commit 2a5d721

2 files changed

Lines changed: 92 additions & 90 deletions

File tree

‎README.md‎

Lines changed: 46 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ Additionally, a number of quality-of-life patches from the community are include
2929
---
3030
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.
3131

32+
**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`.
33+
3234
### Installing with a Mod Manager
3335
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/).
3436
2. Click the **Install with Mod Manager** button on the top of [BepInEx's](https://thunderstore.io/c/inscryption/p/BepInEx/BepInExPack_Inscryption/) page.
@@ -41,7 +43,7 @@ If you have issues with Mod Managers head to one of these discords;
4143
* **Gale Mod Manager Support Discord:** [Here](https://discord.gg/sfuWXRfeTt)
4244

4345
### Installing Manually
44-
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!**
46+
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!**
4547
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`).
4648
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.
4749
4. Install [MonoModLoader](https://inscryption.thunderstore.io/package/BepInEx/MonoMod_Loader_Inscryption/) and extract the contents into a folder.
@@ -50,51 +52,52 @@ If you have issues with Mod Managers head to one of these discords;
5052
7. Move the contents of the `plugins` folder into `BepInEx/plugins` and the contents of the `monomod` folder into the `BepInEx/monomod` folder.
5153
8. Run the game again. If everything runs correctly, a message will appear in the console telling you that the API was loaded.
5254
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;
53-
```
54-
BepInEx // These go within the BepInEx root folder
55-
|-- config
56-
|-- patchers
57-
|-- plugins
58-
|-- monomod
59-
|-- core
60-
plugins // Files within go into the created plugin subfolder that was created for the mod
61-
|-- Art
62-
|-- Scripts
63-
|-- MyMod.dll
64-
manifest.json --|
65-
README.md |-- These can be ignored but if you want to keep them put them in the plugin subfolder
66-
CHANGELOG.md |--
67-
icon.png --|
68-
```
55+
```
56+
BepInEx // These go within the BepInEx root folder
57+
|-- config
58+
|-- patchers
59+
|-- plugins
60+
|-- monomod
61+
|-- core
62+
plugins // Files within go into the created plugin subfolder that was created for the mod
63+
|-- Art
64+
|-- Scripts
65+
|-- MyMod.dll
66+
manifest.json // Ignorable, but if kept, goes in plugin subfolder
67+
README.md // Ignorable, but if kept, goes in plugin subfolder
68+
CHANGELOG.md // Ignorable, but if kept, goes in plugin subfolder
69+
icon.png // Ignorable, but if kept, goes in plugin subfolder
70+
```
6971
10. Run the game once more and everything should be correct and working.
7072
7173
### Installing Manually (XBOX Game-Pass)
72-
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.
73-
2. Move the contents into the game folder (where the game executable is; usually found here: `C:\XboxGames\D30AC640-4EC1-4D15-96F3-384052F09699\Content`).
74-
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`)
75-
4. Install [MonoModLoader](<https://inscryption.thunderstore.io/package/BepInEx/MonoMod_Loader_Inscryption/>) and extract the contents into a folder.
76-
5. Move the contents of the `patchers` folder into `BepInEx/patchers` (If any of the mentioned BepInEx folders don't exist, just create them).
77-
6. Install [Inscryption API](<https://inscryption.thunderstore.io/package/API_dev/API/>) and extract the contents into a folder.
78-
7. Move the contents of the `plugins` folder into `BepInEx/plugins` and the contents of the `monomod` folder into the `BepInEx/monomod` folder.
79-
8. Run the game again. If everything runs correctly, a message will appear in the console telling you that the API was loaded.
80-
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;
81-
```
82-
BepInEx // These go within the BepInEx root folder
83-
|-- config
84-
|-- patchers
85-
|-- plugins
86-
|-- monomod
87-
|-- core
88-
plugins // Files within go into the created plugin subfolder that was created for the mod
89-
|-- Art
90-
|-- Scripts
91-
|-- MyMod.dll
92-
manifest.json --|
93-
README.md |-- These can be ignored but if you want to keep them put them in the plugin subfolder
94-
CHANGELOG.md |--
95-
icon.png --|
96-
```
97-
10. Run the game once more and everything should be correct and working.
74+
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!**
75+
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`).
76+
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.
77+
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.
78+
5. Install [MonoModLoader](https://inscryption.thunderstore.io/package/BepInEx/MonoMod_Loader_Inscryption/) and extract the contents into a folder.
79+
6. Move the contents of the `patchers` folder into `BepInEx/patchers` (If any of the mentioned BepInEx folders don't exist, just create them).
80+
7. Install [Inscryption API](https://inscryption.thunderstore.io/package/API_dev/API/) and extract the contents into a folder.
81+
8. Move the contents of the `plugins` folder into `BepInEx/plugins` and the contents of the `monomod` folder into the `BepInEx/monomod` folder.
82+
9. Run the game again. If everything runs correctly, a message will appear in the console telling you that the API was loaded.
83+
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;
84+
```
85+
BepInEx // These go within the BepInEx root folder
86+
|-- config
87+
|-- patchers
88+
|-- plugins
89+
|-- monomod
90+
|-- core
91+
plugins // Files within go into the created plugin subfolder that was created for the mod
92+
|-- Art
93+
|-- Scripts
94+
|-- MyMod.dll
95+
manifest.json // Ignorable, but if kept, goes in plugin subfolder
96+
README.md // Ignorable, but if kept, goes in plugin subfolder
97+
CHANGELOG.md // Ignorable, but if kept, goes in plugin subfolder
98+
icon.png // Ignorable, but if kept, goes in plugin subfolder
99+
```
100+
11. Run the game once more and everything should be correct and working.
98101
99102
### Installing on the Steam Deck
100103
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.

‎docs/wiki/getting_started.md‎

Lines changed: 46 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
---
33
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.
44

5+
**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`.
6+
57
### Installing with a Mod Manager
68
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/).
79
2. Click the **Install with Mod Manager** button on the top of [BepInEx's](https://thunderstore.io/c/inscryption/p/BepInEx/BepInExPack_Inscryption/) page.
@@ -14,7 +16,7 @@ If you have issues with Mod Managers head to one of these discords;
1416
* **Gale Mod Manager Support Discord:** [Here](https://discord.gg/sfuWXRfeTt)
1517

1618
### Installing Manually
17-
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!**
19+
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!**
1820
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`).
1921
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.
2022
4. Install [MonoModLoader](https://inscryption.thunderstore.io/package/BepInEx/MonoMod_Loader_Inscryption/) and extract the contents into a folder.
@@ -23,55 +25,52 @@ If you have issues with Mod Managers head to one of these discords;
2325
7. Move the contents of the `plugins` folder into `BepInEx/plugins` and the contents of the `monomod` folder into the `BepInEx/monomod` folder.
2426
8. Run the game again. If everything runs correctly, a message will appear in the console telling you that the API was loaded.
2527
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;
26-
27-
```
28-
BepInEx // These go within the BepInEx root folder
29-
|-- config
30-
|-- patchers
31-
|-- plugins
32-
|-- monomod
33-
|-- core
34-
plugins // Files within go into the created plugin subfolder that was created for the mod
35-
|-- Art
36-
|-- Scripts
37-
|-- MyMod.dll
38-
manifest.json --|
39-
README.md |-- These can be ignored but if you want to keep them put them in the plugin subfolder
40-
CHANGELOG.md |--
41-
icon.png --|
42-
```
43-
28+
```
29+
BepInEx // These go within the BepInEx root folder
30+
|-- config
31+
|-- patchers
32+
|-- plugins
33+
|-- monomod
34+
|-- core
35+
plugins // Files within go into the created plugin subfolder that was created for the mod
36+
|-- Art
37+
|-- Scripts
38+
|-- MyMod.dll
39+
manifest.json // Ignorable, but if kept, goes in plugin subfolder
40+
README.md // Ignorable, but if kept, goes in plugin subfolder
41+
CHANGELOG.md // Ignorable, but if kept, goes in plugin subfolder
42+
icon.png // Ignorable, but if kept, goes in plugin subfolder
43+
```
4444
10. Run the game once more and everything should be correct and working.
4545
4646
### Installing Manually (XBOX Game-Pass)
47-
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.
48-
2. Move the contents into the game folder (where the game executable is; usually found here: `C:\XboxGames\D30AC640-4EC1-4D15-96F3-384052F09699\Content`).
49-
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`)
50-
4. Install [MonoModLoader](<https://inscryption.thunderstore.io/package/BepInEx/MonoMod_Loader_Inscryption/>) and extract the contents into a folder.
51-
5. Move the contents of the `patchers` folder into `BepInEx/patchers` (If any of the mentioned BepInEx folders don't exist, just create them).
52-
6. Install [Inscryption API](<https://inscryption.thunderstore.io/package/API_dev/API/>) and extract the contents into a folder.
53-
7. Move the contents of the `plugins` folder into `BepInEx/plugins` and the contents of the `monomod` folder into the `BepInEx/monomod` folder.
54-
8. Run the game again. If everything runs correctly, a message will appear in the console telling you that the API was loaded.
55-
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;
56-
57-
```
58-
BepInEx // These go within the BepInEx root folder
59-
|-- config
60-
|-- patchers
61-
|-- plugins
62-
|-- monomod
63-
|-- core
64-
plugins // Files within go into the created plugin subfolder that was created for the mod
65-
|-- Art
66-
|-- Scripts
67-
|-- MyMod.dll
68-
manifest.json --|
69-
README.md |-- These can be ignored but if you want to keep them put them in the plugin subfolder
70-
CHANGELOG.md |--
71-
icon.png --|
72-
```
73-
74-
10. Run the game once more and everything should be correct and working.
47+
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!**
48+
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`).
49+
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.
50+
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.
51+
5. Install [MonoModLoader](https://inscryption.thunderstore.io/package/BepInEx/MonoMod_Loader_Inscryption/) and extract the contents into a folder.
52+
6. Move the contents of the `patchers` folder into `BepInEx/patchers` (If any of the mentioned BepInEx folders don't exist, just create them).
53+
7. Install [Inscryption API](https://inscryption.thunderstore.io/package/API_dev/API/) and extract the contents into a folder.
54+
8. Move the contents of the `plugins` folder into `BepInEx/plugins` and the contents of the `monomod` folder into the `BepInEx/monomod` folder.
55+
9. Run the game again. If everything runs correctly, a message will appear in the console telling you that the API was loaded.
56+
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;
57+
```
58+
BepInEx // These go within the BepInEx root folder
59+
|-- config
60+
|-- patchers
61+
|-- plugins
62+
|-- monomod
63+
|-- core
64+
plugins // Files within go into the created plugin subfolder that was created for the mod
65+
|-- Art
66+
|-- Scripts
67+
|-- MyMod.dll
68+
manifest.json // Ignorable, but if kept, goes in plugin subfolder
69+
README.md // Ignorable, but if kept, goes in plugin subfolder
70+
CHANGELOG.md // Ignorable, but if kept, goes in plugin subfolder
71+
icon.png // Ignorable, but if kept, goes in plugin subfolder
72+
```
73+
11. Run the game once more and everything should be correct and working.
7574
7675
### Installing on the Steam Deck
7776
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.

0 commit comments

Comments
 (0)