If you're having any trouble after reading through this README, feel free ask for help in the Lighthouse text channels. Please keep in mind that we do not condone piracy.
Quick Start
Lighthouse does not include any copyrighted assets. You are required to provide a supported copy of the game.
1. Verify your ROM dump
Any retail version listed below is supported. You can verify you have dumped a supported copy of the game by using the SHA-1 File Checksum Online at https://www.romhacking.net/hash/.
Extract every file from the zip into a folder of your choosing.
Run lighthouse.exe and select your compatible ROM.
Linux
Extract every file from the zip into a folder of your choosing.
Execute lighthouse.appimage. You may have to chmod +x the appimage via terminal.
MacOS
Extract every file from the zip into a folder of your choosing.
Run lighthouse and select your compatible ROM.
Configuration
Lighthouse ships with a file with many standard controller mappings that can be used as-is with most controllers. If your controller isn't recognized by Lighthouse, or isn't working properly, you can create your own custom mapping using the built-in mapper in the Settings menu.
Default keyboard configuration
N64
A
B
Z
Start
Analog stick
C buttons
D-Pad
Keyboard
X
C
Z
Space
WASD
Arrow keys
TFGH
Other shortcuts
Keys
Action
ESC
Toggle menubar
Ctrl+R
Reset
F11
Fullscreen
Tab
Toggle Alternate assets
Graphics Backends
Currently, there are three rendering APIs supported: DirectX11 (Windows), OpenGL (all platforms), and Metal (macOS). You can change which API to use in the Settings menu of the menubar, which requires a restart. If you're having an issue with crashing, you can change the API in the lighthouse.cfg.json file by finding the line "Backend":{... and changing the id value to 2 and set the Name to OpenGL. DirectX 11 with id 1 is the default on Windows. Metal with id 3 is the default on macOS.
Language Packs
Lighthouse supports using multiple regions of Banjo-Kazooie as language packs. Generate your base bk.o2r file and once Lighthouse has started, open the imgui menu. Under General -> Languages, you will be able to select another ROM to extract as a language pack. PAL supports UK, French, and German, and Japanese adds Japanese support. After the language pack is generated, the language it brings will be added to the dropdown menu.
Romhacks
Many romhacks can be extracted from patched ROMs and used as mods with Lighthouse. This can be done in-game using the Romhacks menu in the Settings section. If any hack isn't fully supported, the menu should inform you when extracting the mod. Most supported romhacks currently haven't been fully tested, so there may still be some issues.
_NOTE: When using romhacks, only US v1.0 is supported, inherited from Banjo's Backpack. Therefore, it is recommended to use US v1.0 as your base bk.o2r file.
Custom Assets
Custom assets are packed in .o2r or .otr files. To use custom assets, place them in the mods folder.
If you're interested in creating and/or packing your own custom asset .o2r/.otr files, check out the following tools:
If you want to manually compile Lighthouse, please consult the building instructions.
Playtesting
If you want to playtest a continuous integration build, you can find them at the links below. Keep in mind that these are for playtesting only, and you will likely encounter bugs and possibly crashes.
