Files
dockipelago/worlds/cat_quest/docs/setup_en.md
Jonathan Tinney 7971961166
Some checks failed
Analyze modified files / flake8 (push) Failing after 2m28s
Build / build-win (push) Has been cancelled
Build / build-ubuntu2204 (push) Has been cancelled
ctest / Test C++ ubuntu-latest (push) Has been cancelled
ctest / Test C++ windows-latest (push) Has been cancelled
Analyze modified files / mypy (push) Has been cancelled
Build and Publish Docker Images / Push Docker image to Docker Hub (push) Successful in 5m4s
Native Code Static Analysis / scan-build (push) Failing after 5m2s
type check / pyright (push) Successful in 1m7s
unittests / Test Python 3.11.2 ubuntu-latest (push) Failing after 16m23s
unittests / Test Python 3.12 ubuntu-latest (push) Failing after 28m19s
unittests / Test Python 3.13 ubuntu-latest (push) Failing after 14m49s
unittests / Test hosting with 3.13 on ubuntu-latest (push) Successful in 5m0s
unittests / Test Python 3.13 macos-latest (push) Has been cancelled
unittests / Test Python 3.11 windows-latest (push) Has been cancelled
unittests / Test Python 3.13 windows-latest (push) Has been cancelled
add schedule I, sonic 1/frontiers/heroes, spirit island
2026-04-02 23:46:36 -07:00

2.5 KiB

Cat Quest Multiworld Setup Guide

Required Software

  • Cat Quest from: Steam
    • Games from other storefronts may work, but only if it's the 32 bit version. (EGS, Amazon and GOG are confirmed to be the 64 bit version unfortunately)
    • Only the english version of the game works
  • BepInEx from: GitHub
  • Cat Quest Randomizer from: GitHub
  • Cat Quest World from: GitHub
  • (Optional) Cat Quest PopTracker from: GitHub

Installation

  1. Download and install BepInEx 5 (x86, version 5.4.20 or newer) into your Cat Quest root folder. (Don't use the pre-release of 6) (Installation guide for BepInEx can be found here)

  2. Start Cat Quest once, so that BepInEx can create its required configuration files.

  3. After BepInEx has been installed and configured, download the Cat Quest Randomizer zip file, move it to the Cat Quest root folder alongside Cat Quest.exe, right click and select "Extract Here" or the equivalent for your extraction software. After this, you can delete the .zip file

Connecting

When you open your game, you should see the archipawlago menu screen and the randomizer version.

Depending on how much you've played the game beforehand, the menu may look different.

  • If you have the 'New Game +' button, click it, and you should have a button called Start New Archipelago Game. Type in your room info and click confirm to start the game
  • If you have save data already (the continue button is lit up), then simply click 'New Game' and do as above.
  • if you do not have save data, click 'New Game', play the game until it saves for the first time, return to the menu and click 'New Game' again. Do as above.

You can continue your saved game by clicking Continue like in vanilla Cat Quest. This will automatically connect you to the slot you last played on.

Help Checklist!

  • Make sure installed the correct version of BepInEx (x86, version 5.4.20 or newer. not x64 and not version 6.0.0+. Also make sure you installed the version that matches your OS)
  • Make sure the contents of the mod zip file are put directly in the root cat quest folder, not wrapped in a folder by the name of the downloaded Zip file.
  • Make sure your game is in English.