Installation

<u>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.</u>

Installing with a Mod Manager

1. Download and install Thunderstore Mod Manager, Gale or r2modman.
2. Click the Install with Mod Manager button on the top of BepInEx's page.
3. Run the game via the mod manager.

If you have issues with Mod Managers head to one of these discords;

• Thunderstore Support Discord: Here
• R2ModMan Support Discord: Here
• Gale Mod Manager Support Discord: Here

Installing Manually

1. Install BepInEx by pressing Manual Download and extract the contents into a folder. Do not extract into the game folder!
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).
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.
4. Install MonoModLoader and extract the contents into a folder.
5. Move the contents of the patchers folder into BepInEx/patchers (If any of the mentioned BepInEx folders don't exist, just create them).
6. Install Inscryption API and extract the contents into a folder.
7. Move the contents of the plugins folder into BepInEx/plugins and the contents of the monomod folder into the BepInEx/monomod folder.
8. Run the game again. If everything runs correctly, a message will appear in the console telling you that the API was loaded.
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;

   BepInEx // These go within the BepInEx root folder
   |-- config
   |-- patchers
   |-- plugins
   |-- monomod
   |-- core
   plugins // Files within go into the created plugin subfolder that was created for the mod
   |-- Art
   |-- Scripts
   |-- MyMod.dll
   manifest.json // Ignorable, but if kept, goes in plugin subfolder
   README.md // Ignorable, but if kept, goes in plugin subfolder
   CHANGELOG.md // Ignorable, but if kept, goes in plugin subfolder
   icon.png // Ignorable, but if kept, goes in plugin subfolder
   

10. Run the game once more and everything should be correct and working.

Installing Manually (XBOX Game-Pass)

1. Install BepInEx by pressing Manual Download and extract the contents into a folder. Do not extract into the game folder!
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).
3. Install the following package: XboxSilencio, this is a package which aims to solve frictions with XBOX Gamepass specific installations, such as HueyFS related errors.
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.
5. Install MonoModLoader and extract the contents into a folder.
6. Move the contents of the patchers folder into BepInEx/patchers (If any of the mentioned BepInEx folders don't exist, just create them).
7. Install Inscryption API and extract the contents into a folder.
8. Move the contents of the plugins folder into BepInEx/plugins and the contents of the monomod folder into the BepInEx/monomod folder.
9. Run the game again. If everything runs correctly, a message will appear in the console telling you that the API was loaded.
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;

    BepInEx // These go within the BepInEx root folder
    |-- config
    |-- patchers
    |-- plugins
    |-- monomod
    |-- core
    plugins // Files within go into the created plugin subfolder that was created for the mod
    |-- Art
    |-- Scripts
    |-- MyMod.dll
    manifest.json // Ignorable, but if kept, goes in plugin subfolder
    README.md // Ignorable, but if kept, goes in plugin subfolder
    CHANGELOG.md // Ignorable, but if kept, goes in plugin subfolder
    icon.png // Ignorable, but if kept, goes in plugin subfolder
    

11. Run the game once more and everything should be correct and working.

Installing on the Steam Deck

1. Download r2modman on the Steam Deck's Desktop Mode and open it from its download using its AppImage file.
2. Download the mods you plan on using and their dependencies.
3. Go to the setting of the profile you are using for the mods and click Browse Profile Folder.
4. Copy the BepInEx folder, then go to Steam and open Inscryption's Properties menu
5. Go to Installed Files click Browse to open the folder containing Inscryption's local files; paste the BepInEx folder there.
6. Enter Gaming Mode and check 'Force the use of a specific Steam Play compatibility tool' in the Properties menu under Compatibility.
7. Go to the launch parameters and enter WINEDLLOVERRIDES="winhttp.dll=n,b" %command%.
8. Open Inscryption. If everything was done correctly, you should see a console appear on your screen.

Mac & Linux

1. Follow the steps here first: https://docs.bepinex.dev/articles/user_guide/installation/index.html
2. Next do steps 4-10 of the Manual Installation
3. Your game should be setup for inscryption modding now

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

• Inscryption Modding Discord: Here

Installing the Package:

<u>If your using MadH95-JSONCardLoader for JLDR2 based mods, please make sure to go into MADH.inscryption.JSONLoader.cfg and disable JLDR Conversion, you may need to do this after launching the first time. If you don't JSONLoader in combination with JSONLoader-Nightly will register the card Twice to the Game.</u>

Manager

1. Find the package that correlates with your system, below is a quick reference of the RID's and what they correlate to;

• Win-x64: XBOX Gamepass Version of the game (based on the game on Windows)
• Win-x86: For the Steam Version of the game (based on the game on Windows)
• We also offer versions for the following:
  • Linux-Arm64
  • Linux-Arm
  • Linux-Musl-Arm64
  • Linux-Musl-X64
  • Linux-X64
  • OSX-Arm64 (Mac)
  • OSX-X64 (Mac)
  • Win-Arm64

1. Enter your Mod Manager and Import as a Local Mod via the Following Steps:

• R2ModMan

  1. Open the Application, Navigate to Inscryption, Navigate to the Profile you wish to Install to.

  2. Press Settings.

  3. Type Import into the Search box as highlighted below

     

  4. Press Import Local Mod.

  5. Press Select File and Navigate to and Select the File you just downloaded from this Release.

  6. If you followed the steps correctly it should appear as follows (with the correct version of this GitHub release,

     

     <u>For the current Nightly Version it should so 0.0.3 when importing.</u>

  7. Where it says Author: Unknown replace the Unknown with MADH95.

  8. Press Import Local Mod.

  9. Wait for Dependencies to Resolve and your set. (Note for any mods on Thunderstore needing an older version of JSONLoader you may want to also install them directly from the website, or do these steps after you finished installing those mods, you must remove ONLY the old version of the mod.)

• Gale
  1. Open the Application, Navigate to the Game, Than the Profile.
  2. At the top of the screen (on the left) press Import than ... Local Mod.
  3. Navigate to and Select the File you just downloaded from this Release.
  4. Wait for Dependencies to Resolve and your set. (Note for any mods on Thunderstore needing an older version of JSONLoader you may want to also install them directly from the website, or do these steps after you finished installing those mods, you must remove ONLY the old version of the mod.)

Manual

1. Find the package that correlates with your system, below is a quick reference of the RID's and what they correlate to;

• Win-x64: XBOX Gamepass Version of the game (based on the game on Windows)
• Win-x86: For the Steam Version of the game (based on the game on Windows)
• We also offer versions for the following:
  • Linux-Arm64
  • Linux-Arm
  • Linux-Musl-Arm64
  • Linux-Musl-X64
  • Linux-X64
  • OSX-Arm64 (Mac)
  • OSX-X64 (Mac)
  • Win-Arm64

1. Extract the Zip to a new folder.
2. Take the files and folders under plugins of the zip and move them up a folder.
3. Delete the plugins folder from the Extracted directory.
4. Now navigate to the location of your BepInEx install from your earlier setup for the API.
5. Navigate to plugins and add a folder entitled MadH95-JSON_and_CSV_Loader_Nightly.
6. Move the setup from steps 2-4 into the folder you created in step 7.