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

5.0 KiB

Setup Guide for Banjo-Tooie Archipelago

Important

As we are using BizHawk, this guide is only applicable to Windows and Linux systems. Our implementation also supports the Everdrive 3.0 and X7. (USB Support).

Required Software and Hardware

Playing on BizHawk

Configuring BizHawk

Once BizHawk has been installed, open EmuHawk and change the following settings:

  • Under Config > Customize, check the "Run in background" and "Accept background input" boxes. This will allow you to continue playing in the background, even if another window is selected
  • Under Config > Hotkeys, many hotkeys are listed, with many bound to common keys on the keyboard. You will likely want to disable most of these, which you can do quickly using Esc
  • If playing with a controller, when you bind controls, disable "P1 A Up", "P1 A Down", "P1 A Left", and "P1 A Right" as these interfere with aiming if bound. Set directional input using the Analog tab instead
  • Under N64 enable "Use Expansion Slot". (The N64 menu only appears after loading a ROM.)
  • Under Config -> Speed/Skip, click "Audio Throttle" as this will fix the off pitch sounds while playing

It is strongly recommended to associate N64 rom extensions (*.n64, *.z64) to the EmuHawk we've just installed. To do so, we simply have to search any N64 rom we happened to own, right click and select "Open with…", unfold the list that appears and select the bottom option "Look for another application", then browse to the BizHawk folder and select EmuHawk.exe.

If you are experiencing performance issues with Banjo-Tooie, you can try the following:

  • Under N64 -> Plugins, Set Active Video Plugin to Rice. This will create some visual artifacts however, it should not affect gameplay.

Setup - BizHawk

  • Run Launcher.exe and select Banjo-Tooie Client
  • If this is your first time running this version, it will prompt for your Banjo-Tooie (US) ROM
  • The patched rom is located in your Archipelago root folder by default
    • The exact path is also printed on the Banjo-Tooie Client
    • You can also click "Browse Files" in the Launcher which will take you to this folder
  • one time only run /autostart in the Banjo-Tooie Client and select Emuhawk.exe. This will automatically open Bizhawk, the patched Banjo-Tooie ROM and the required Lua script to connect.
  • Connect the Archipelago Client with the server.
    • To connect the client to the multiserver simply put <address>:<port> on the textfield on top and press connect (if the server uses password, then it will prompt after connection)
  • If you rather not use /autostart:
    • Open Bizhawk and open your patched Banjo-Tooie (US) game
    • Once you are in the game title menu or game select screen, drag and drop the connector_bt_bizhawk.lua script (which can be found in the data/lua folder of Archipelago) onto the Lua console window

Playing on Everdrive

  • Run ArchipelagoLauncher.exe and select Banjo-Tooie Client
  • If this is your first time running this version, it will prompt for your Banjo-Tooie (US) ROM
  • The patched rom is located in your Archipelago root folder
    • The exact path is also printed on the Banjo-Tooie Client
    • You can also click "Browse Files" in the Launcher which will take you to this folder
  • Load the patched version of the ROM on your everdrive sd card
  • The Everdrive will need to have a USB connection to the PC that will be running the Banjo-Tooie Client
  • one time only run /autostart in the Banjo-Tooie Client and select banjo_tooie_everdrive_connector.exe. This will automatically open the connector for the everdrive
    • If you are on Linux, select Banjo_Tooie_everdrive_connector_linux instead
  • If you rather not use /autostart:
    • Open banjo_tooie_everdrive_connector.exe if you are on Windows
    • If you are on Linux, select Banjo_Tooie_everdrive_connector_linux instead
  • Run the patched Banjo-Tooie Rom on the everdrive
  • Connect the Archipelago client with the server. (The banjo_tooie_connector window should say, "Connection Established")
  • To connect the client to the multiserver, simply put <address>:<port> on the textfield on top and press connect (if the server uses password, then it will prompt after connection)