Banjo-Kazooie 3DS v1.2

Banjo-Kazooie for the New Nintendo 3DS, as a homebrew app. No game data is included: it is made
once from your own ROM (US v1.0, US v1.1, PAL or Japanese).

Install

1. Copy to the SD card. Extract Lighthouse-3DS-v1.2.zip onto the root of the SD card, then put
   your ROM (.z64, .v64 or .n64) in 3ds/lighthouse/.
2. Play. Start Banjo-Kazooie from the Homebrew Launcher. The first start makes bk.o2r from the
   ROM, in about a minute and a half, with a progress bar. START + SELECT quits.

Full instructions and controls are in README-3DS.txt inside the zip and in
docs/3DS.md.

An Old 3DS can't make bk.o2r itself (not enough memory). Make it on a computer with the PC
build below instead: run it, choose your ROM, and put the bk.o2r it writes in 3ds/lighthouse/.
Use the PC build from this release; README-3DS.txt says where each one writes bk.o2r.

Downloads

File	What it is
Lighthouse-3DS-v1.2.zip	The 3DS app, for the SD card (.3dsx, and a .cia for the HOME Menu)
Lighthouse-PC-Win64.zip	PC build for Windows, to make bk.o2r on a computer
Lighthouse-PC-Mac.zip	PC build for macOS, to make bk.o2r on a computer
Lighthouse-PC-Linux.appimage	PC build for Linux, to make bk.o2r on a computer

Changes

Upgrading from v1.1

1. Extract this zip onto the root of the SD card, over the old files. This replaces
   3ds/Lighthouse.3dsx and 3ds/lighthouse/lighthouse.o2r, and adds the extract folder.
2. Put your Banjo-Kazooie ROM on the SD card, in 3ds/lighthouse/. This release is based on
   Lighthouse 1.2.0, whose bk.o2r is different, so the old one has to be made again. The app
   does that by itself on the first start, from the ROM, in about a minute and a half, and replaces
   the old bk.o2r only once the new one is complete.

Your saves and settings carry over.

New

• No PC needed. The app makes bk.o2r from your ROM (.z64, .v64 or .n64, any name) on
  the first start, with a progress bar, in about 75 seconds on a New 3DS. Put the ROM in
  3ds/lighthouse/, next to Lighthouse.3dsx or at the root of the SD card; other games there are
  skipped. Leave the ROM there to have future releases update bk.o2r on their own; if you
  delete it, a release that needs a new bk.o2r asks for it again.
• bk.o2r updates itself. When a release changes what goes into bk.o2r, the first start
  remakes it from the ROM ("Updating bk.o2r for this version"). A release that doesn't change it
  keeps the one you have, version bump or not.
• Install to the HOME Menu. Lighthouse.cia in this zip installs with FBI and starts from the
  HOME Menu, with its own banner and icon. It uses the same files and saves as the .3dsx.
• Lighthouse 1.2.0. The PC port's latest changes are merged in, among them fixes like
  Clanker's tooth no longer spawning Jiggies endlessly. Most of its new options need a settings
  menu, which the 3DS build doesn't have yet.
• 3D on the file select is tuned for that scene.

Fixes

• A rare freeze on a black or still screen, for example entering a level, after anything from
  a few minutes to a few hours. The game's audio and the frame being drawn could pick the same
  slot in a shared task list, and the frame was lost. A second, rarer hang in the renderer's
  handoff between threads is fixed too. The game now ran 7.5 hours straight without either.
• "SDL_OpenAudio error: Couldn't create audio thread" on the loading screen, seen on some
  consoles: the audio thread now starts on another core when the system won't give it core 1.

Known issues

• The Old 3DS, 3DS XL and 2DS run the game far too slowly to play (about 10 fps), and can't make
  bk.o2r themselves: there isn't enough memory. Make it on a New 3DS, or with this release's PC
  build (see the downloads above).
• A PAL ROM has English, French and German, but choosing one needs a settings menu that isn't
  there yet. Until then, set DialogLanguage in 3ds/lighthouse/lighthouse.cfg.json: English (UK)
  1583480766, French 2092788901, German 286263347.
• The bk.o2r the 3DS makes is about 47 MB, against 26 MB from a PC: compressing it would add
  almost a minute on the 3DS.
• Unchanged from v1.0: a few particle effects that read back the screen are missing, the grayscale
  and noise screen effects are not drawn, and entering a level can pause for about a second.

Banjo-Kazooie 3DS v1.1

Banjo-Kazooie for the New Nintendo 3DS, as a homebrew app. No game data is included: you make
bk.o2r once from your own ROM (US v1.0, US v1.1, PAL or Japanese).

Install

1. Make bk.o2r. Download the PC build for your computer below, run it and choose your ROM.
   Use the PC build from this release: bk.o2r from other Lighthouse versions does not work,
   unless the notes below say an older one still does.
   • Windows: bk.o2r appears next to Lighthouse.exe.
   • Linux: it is written to ~/.local/share/lighthouse/.
   • macOS: see README-3DS.txt in the 3DS zip.
2. Copy to the SD card. Extract Lighthouse-3DS-v1.1.zip onto the root of the SD card, then put
   your bk.o2r in 3ds/lighthouse/, next to lighthouse.o2r.
3. Play. Start Banjo-Kazooie from the Homebrew Launcher. START + SELECT quits.

Full instructions and controls are in README-3DS.txt inside the 3DS zip and in
docs/3DS.md.

Downloads

File	What it is
Lighthouse-3DS-v1.1.zip	The 3DS app, for the SD card
Lighthouse-PC-Win64.zip	PC build for Windows, to make bk.o2r
Lighthouse-PC-Mac.zip	PC build for macOS, to make bk.o2r
Lighthouse-PC-Linux.appimage	PC build for Linux, to make bk.o2r

Changes

Upgrading from v1.0

Replace 3ds/Lighthouse.3dsx and 3ds/lighthouse/lighthouse.o2r with the ones in this zip. Keep
your bk.o2r: it doesn't need to be made again for this release. Your saves and settings carry
over.

New

• 60 frames per second on a New 3DS. The game still updates 30 times a second, but the 3DS
  now draws an in-between frame for every update, so motion is twice as smooth. Freezeezy Peak,
  the heaviest level, holds about 60.
• Stereoscopic 3D. Push up the 3D slider. Banjo sits at about the screen's depth and the world
  goes back into it; the HUD and pause menu sit slightly in front, and the jigsaw transition's
  pieces fly out of the screen. It holds 60 fps with 3D on, and with the slider down the game
  draws one image at no extra cost.
• A loading screen and a stats screen on the bottom screen: a progress bar while the game
  starts, then the current level's notes, Jiggies, honeycombs and time, your game totals and the
  frame rate.
• Faster startup, about 2.5 seconds.
• Clear errors for setup problems. If bk.o2r or lighthouse.o2r is missing, damaged or from
  another version, the bottom screen says so and how to fix it, instead of exiting or hanging.

Under the hood

• All of the New 3DS's cores in use: the renderer, the game's audio, the game logic and the
  in-between frames each get their own.
• Textures in the GPU's own memory (VRAM), and the CPU and GPU working on frames at the same time.
• How each change sped things up is in
  docs/3DS-PERFORMANCE.md.

Known issues

• The Old 3DS, 3DS XL and 2DS (two cores) run the game but it will probably be slow.
• Unchanged from v1.0: a few particle effects that read back the screen are missing, the grayscale
  and noise screen effects are not drawn, and entering a level can pause for about a second.

Banjo-Kazooie 3DS v1.0

Banjo-Kazooie for the Nintendo 3DS, as a homebrew app. No game data is included: you make
bk.o2r once from your own ROM (US v1.0, US v1.1, PAL, or Japanese).

Install

1. Generate bk.o2r file. Download the PC build for your computer below, run it and choose your ROM.
   It will generate the file bk.o2r which you will need to copy to your SD card in the 3ds/lighthouse directory.
   • Windows: bk.o2r appears next to Lighthouse.exe.
   • Linux: it is written to ~/.local/share/lighthouse/.
   • macOS: see README-3DS.txt in the 3DS zip.
2. Copy to the SD card. Extract Lighthouse-3DS-v1.0.zip onto the root of the SD card, then put
   your bk.o2r in 3ds/lighthouse/, next to lighthouse.o2r.
3. Play. Start Banjo-Kazooie from the Homebrew Launcher. START + SELECT quits.

Full instructions and controls are in README-3DS.txt inside the 3DS zip and in
docs/3DS.md.

Downloads

File	What it is
Lighthouse-3DS-v1.0.zip	The 3DS app, for the SD card
Lighthouse-PC-Win64.zip	PC build for Windows, to make bk.o2r
Lighthouse-PC-Mac.zip	PC build for macOS, to make bk.o2r
Lighthouse-PC-Linux.appimage	PC build for Linux, to make bk.o2r

Changes

First release.

• Runs the full game natively on the New 3DS through a citro3d renderer, with game logic on its own CPU core
• Supports all four ROM versions: US v1.0, US v1.1, PAL and Japanese
• Controls are mapped for the 3DS; the C buttons are on both the C-stick and the D-pad
• Bottom screen shows the version and the frame rate
• Saves go to the SD card in 3ds/lighthouse/
• START + SELECT quits cleanly back to the Homebrew Launcher

Known issues

• Old 3DS / 2DS: boots in an emulator, but it hasn't been tested on real hardware and will likely be slow