Files
dockipelago/worlds/grinch/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

3.7 KiB

The Grinch (PS1) - Setup Guide

Required Software

  • Archipelago. Please use version 0.6.5 or later for integrated BizHawk support.
  • Legally obtained NTSC Bin ROM file, probably named something like Grinch, The (USA) (En,Fr,Es).bin. The game's CUE file should also work aswell along side the BIN file if you have troubles opening the BIN file.
  • BizHawk Versions between 2.9.1 & 2.11 will allow you to play the game. But 2.11 is recommended since with older versions, you may encounter instability & crashes within the game. Any version below 2.9.1 may not work.
  • The latest grinch.apworld file. You can find this on the Releases page. Put this in your Archipelago/custom_worlds folder.
  • PSX BIOS Firmware bin file, which is required to run the game through Bizhawk. The file you need should be named something like SCPH-5501.BIN.

Configuring BizHawk

Once you have installed BizHawk, open EmuHawk.exe and change the following settings:

  • Under Config > Customize, check the "Run in background" option to prevent disconnecting from the client while you're tabbed out of EmuHawk.
  • Under Config > Preferred Cores > PSX, select NymaShock.
  • Open any PlayStation game in EmuHawk and go to Config > Controllers… to configure your inputs. If you can't click Controllers…, it's because you need to load a game first. You may need to invert Sensitivity for the up/down axis to -100%. This can be found under Analog Controls through Config > Controllers…. Depending on your controller, you may also want to tweak the Deadzone & Sensitivity to prevent weird movements when using the analog stick to move. Something like 6% is recommended for a DualShock 4 controller.
  • Consider clearing keybinds in Config > Hotkeys… if you don't intend to use them. Select the keybind and press Esc to clear it.
  • You are required to legally obtain a PSX Bios BIN firmware file for the game to be opened. To import this, you go to Config > Firmware... > Tools and scrolling until you see the PlayStation tab. You might right click on the bios region and click Set Customization or Import on the top of the window. Then a window should open, telling you what file to import, which is the BIN file required. The bios should be recognized if Bizhawk displays a checkmark beside it, saying the bios version you have is stable and should run without issues. If a bios is already been imported and the game runs fine by itself, you may skip this step.

Generating a Game

  1. Create your options file (YAML). After installing the grinch.apworld file, you can generate a template within the Archipelago Launcher by clicking Generate Template Settings.
  2. Follow the general Archipelago instructions for generating a game.
  3. Open ArchipelagoLauncher.exe
  4. Select "BizHawk Client" in the right-side column. On your first time opening BizHawk Client, you will also be asked to locate EmuHawk.exe in your BizHawk install.

Connect to the Multiserver

Once both the client and the emulator are started, they must be connected. This should happen automatically. However, if the lua script window doesn't appear, then within the emulator click on the "Tools" menu and select "Lua Console". Click the folder button or press Ctrl+O to open a Lua script. Navigate to your Archipelago install folder and open data/lua/connector_bizhawk_generic.lua.

To connect the client to the multiserver simply put <address>:<port> on the text field on top and press enter (if the server uses a password, type in the bottom text field /connect <address>:<port> [password])