Difference between revisions of "Documentation"
(Added the Documentation on modding page into existence.) |
|||
| Line 1: | Line 1: | ||
| − | + | '''Installation:''' | |
| − | + | '''''Installation (game, automated):''''' | |
This is the recommended way to install BepInEx on the game. | This is the recommended way to install BepInEx on the game. | ||
1. Download and install [https://www.overwolf.com/app/Thunderstore-Thunderstore_Mod_Manager Thunderstore Mod Manager][https://Timberborn.thunderstore.io/package/ebkr/r2modman/ R2ModMan] | 1. Download and install [https://www.overwolf.com/app/Thunderstore-Thunderstore_Mod_Manager Thunderstore Mod Manager][https://Timberborn.thunderstore.io/package/ebkr/r2modman/ R2ModMan] | ||
| + | |||
2. Click **Install with Mod Manager** button on top of the page | 2. Click **Install with Mod Manager** button on top of the page | ||
| + | |||
3. Run the game via the mod manager | 3. Run the game via the mod manager | ||
| − | + | '''''Installation (manual):''''' | |
If you are installing this manually, do the following | If you are installing this manually, do the following | ||
0. Install [https://thunderstore.io/package/download/BepInEx/BepInExPack_Inscryption/5.4.1902/ BepInEx] | 0. Install [https://thunderstore.io/package/download/BepInEx/BepInExPack_Inscryption/5.4.1902/ BepInEx] | ||
| + | |||
1. Extract the archive into a folder. **Do not extract into the game folder.** | 1. Extract the archive into a folder. **Do not extract into the game folder.** | ||
| + | |||
2. Move the contents of `BepInExPack_Inscryption` folder into the game folder (where the game executable is located). | 2. Move the contents of `BepInExPack_Inscryption` folder into the game folder (where the game executable is located). | ||
| + | |||
3. Run the game. If everything runs correctly, you will see BepInEx console pop up on your desktop. | 3. Run the game. If everything runs correctly, you will see BepInEx console pop up on your desktop. | ||
| + | |||
4. Follow the game running instructions below: | 4. Follow the game running instructions below: | ||
| − | + | '''''Installation Manual Sub Info:''''' | |
1. Make 2 Folders in the BepInEx Folder called `patchers` and `monomod` | 1. Make 2 Folders in the BepInEx Folder called `patchers` and `monomod` | ||
| + | |||
2. Install and place: [https://cdn.discordapp.com/attachments/904819911010947092/1041376866164015144/Assembly-CSharp.APIPatcher.mm.dll API Patcher] into `monomod` | 2. Install and place: [https://cdn.discordapp.com/attachments/904819911010947092/1041376866164015144/Assembly-CSharp.APIPatcher.mm.dll API Patcher] into `monomod` | ||
| + | |||
3. Install and Place: [https://cdn.discordapp.com/attachments/904819911010947092/1041377048188440626/BepInEx.MonoMod.Loader.dll MonoMod Loader] and, [https://cdn.discordapp.com/attachments/904819911010947092/1041377048448471110/MonoMod.dll MonoMod] into `patchers` | 3. Install and Place: [https://cdn.discordapp.com/attachments/904819911010947092/1041377048188440626/BepInEx.MonoMod.Loader.dll MonoMod Loader] and, [https://cdn.discordapp.com/attachments/904819911010947092/1041377048448471110/MonoMod.dll MonoMod] into `patchers` | ||
| + | |||
4. Place the Plugins folder in the Zip into `plugins` | 4. Place the Plugins folder in the Zip into `plugins` | ||
| − | + | '''''Other Info:''''' | |
For information on how to Mod the game using the Api visit [https://inscryptionmodding.github.io/InscryptionAPI/ this website.] | For information on how to Mod the game using the Api visit [https://inscryptionmodding.github.io/InscryptionAPI/ this website.] | ||
For information on how to Mod the game using the JsonLoader visit: [https://github.com/MADH95/JSONLoader/wiki this website.] | For information on how to Mod the game using the JsonLoader visit: [https://github.com/MADH95/JSONLoader/wiki this website.] | ||
Revision as of 01:54, 3 November 2023
Installation:
Installation (game, automated):
This is the recommended way to install BepInEx on the game.
1. Download and install Thunderstore Mod ManagerR2ModMan
2. Click **Install with Mod Manager** button on top of the page
3. Run the game via the mod manager
Installation (manual):
If you are installing this manually, do the following
0. Install BepInEx
1. Extract the archive into a folder. **Do not extract into the game folder.**
2. Move the contents of `BepInExPack_Inscryption` folder into the game folder (where the game executable is located).
3. Run the game. If everything runs correctly, you will see BepInEx console pop up on your desktop.
4. Follow the game running instructions below:
Installation Manual Sub Info:
1. Make 2 Folders in the BepInEx Folder called `patchers` and `monomod`
2. Install and place: API Patcher into `monomod`
3. Install and Place: MonoMod Loader and, MonoMod into `patchers`
4. Place the Plugins folder in the Zip into `plugins`
Other Info:
For information on how to Mod the game using the Api visit this website.
For information on how to Mod the game using the JsonLoader visit: this website.