Archipelago/worlds/inscryption/docs/setup_en.md

5.8 KiB

Inscryption Randomizer Setup Guide

Required Software

Installation

Before starting the installation process, here's what you should know:

  • Only install the mods mentioned in this guide if you want a guaranteed smooth experience! Other mods were NOT tested with ArchipelagoMod and could cause unwanted issues.
  • The ArchipelagoMod uses its own save file system when playing, but for safety measures, back up your save file by going to your Inscryption installation directory and copy the SaveFile.gwsave file to another folder.
  • It is strongly recommended to use a mod manager if you want a quicker and easier installation process, but if you don't like installing extra software and are comfortable moving files around, you can refer to the manual setup guide instead.

Easy setup (mod manager)

  1. Download r2modman using the "Manual Download" button, then install it using the executable in the downloaded zip package (You can also use Thunderstore Mod Manager which works the same, but it requires Overwolf)
  2. Open the mod manager and select Inscryption in the game selection screen.
  3. Select the default profile or create a new one.
  4. Open the Online tab on the left, then search for ArchipelagoMod.
  5. Expand ArchipelagoMod and click the Download button to install the latest version and all its dependencies.
  6. Click Start Modded to open the game with the mods (a console should appear if everything was done correctly).

Manual setup

  1. Download the following mods using the Manual Download button:
  2. Open your Inscryption installation directory. On Steam, you can find it easily by right-clicking the game and clicking Manage > Browse local files.
  3. Open the BepInEx pack zip file, then open the BepInExPack_Inscryption folder.
  4. Drag all folders and files located inside the BepInExPack_Inscryption folder and drop them in your Inscryption directory.
  5. Open the BepInEx folder in your Inscryption directory.
  6. Open the ArchipelagoMod zip file.
  7. Drag and drop the plugins folder in the BepInEx folder to fuse with the existing plugins folder.
  8. Open the game normally to play with mods (if BepInEx was installed correctly, a console should appear).

Joining a new MultiWorld Game

  1. After opening the game, you should see a new menu for browsing and creating save files.
  2. Click on the New Game button, then write a unique name for your save file.
  3. On the next screen, enter the information needed to connect to the MultiWorld server, then press the Connect button.
  4. If successful, the status on the top-right will change to "Connected". If not, a red error message will appear.
  5. After connecting to the server and receiving items, the game menu will appear.

Continuing a MultiWorld Game

  1. After opening the game, you should see a list of your save files and a button to add a new one.
  2. Find the save file you want to use, then click its Play button.
  3. On the next screen, the input fields will be filled with the information you've written previously. You can adjust some fields if needed, then press the Connect button.
  4. If successful, the status on the top-right will change to "connected". If not, a red error message will appear.
  5. After connecting to the server and receiving items, the game menu will appear.

Troubleshooting

The game opens normally without the new menu.

If the new menu mentioned previously doesn't appear, it can be one of two issues:

  • If there was no console appearing when opening the game, this means the mods didn't load correctly. Here's what you can try:
    • If you are using the mod manager, make sure to open it and press Start Modded. Opening the game normally from Steam won't load any mods.
    • Check if the mod manager correctly found the game path. In the mod manager, click Settings then go to the Locations tab. Make sure the path listed under Change Inscryption directory is correct. You can verify the real path if you right-click the game on steam and click Manage > Browse local files. If the path is wrong, click that setting and change the path.
    • If you installed the mods manually, this usually means BepInEx was not correctly installed. Make sure to read the installation guide carefully.
    • If there is still no console when opening the game modded, try asking in the Archipelago Discord Server for help.
  • If there is a console, this means the mods loaded but the ArchipelagoMod wasn't found or had errors while loading.
    • Look in the console and make sure you can find a message about ArchipelagoMod being loaded.
    • If you see any red text, there was an error. Report the issue in the Archipelago Discord Server or create an issue in our GitHub.

I'm getting a different issue.

You can ask for help in the Archipelago Discord Server or, if you think you've found a bug with the mod, create an issue in our GitHub.