# Banjo-Tooie: Recompiled

A work-in-progress static recompilation of Banjo-Tooie (N64, NTSC-U) into a native port, built on
[N64: Recompiled](https://github.com/N64Recomp/N64Recomp), [RT64](https://github.com/rt64/rt64) and
the N64ModernRuntime libraries.

> **Status: work in progress.** The game boots, reaches gameplay and is playable through several
> areas, but there are known crashes, freezes and rendering gaps. This is a development repository,
> not a finished release.

## No ROM or checked-in translated game code

The ROM-derived C and RSP translations are generated locally from a user's own game image and are
ignored by Git. This public snapshot intentionally excludes ROMs, ELFs, generated `RecompiledFuncs/`,
generated RSP C++ output, and old development patches that embedded generated-code context.

You must supply your own legally obtained Banjo-Tooie (NTSC-U) game image. See
[BUILDING.md](BUILDING.md) for the current setup and known build-input gap.

## What works

- Boots to the title screen and into gameplay
- Spiral Mountain, Banjo's house, Digger Tunnel, Isle of Hags, Jinjo Village and King Jingaling
- Flight, shoes, molehills, pickups and boss encounters
- Both text systems, rain and glow effects, lighting, environments and characters
- Widescreen and a configuration launcher

## Known issues

The sanitized public snapshot intentionally does not include the private investigation ledger.
Current headline issues include:

- Kazooie is not rendered in several contexts
- Several held props and dialogue portraits are missing
- Some visual effects are absent
- Certain area transitions can hard-freeze or stall
- A camera softlock can occur leaving King Jingaling's throne room
- Two experimental generated-code replacement fixes were removed for publication; see
  [PUBLICATION_NOTES.md](PUBLICATION_NOTES.md)

## Layout

| path | contents |
| --- | --- |
| `src/` | hand-written native integration code, hooks, stubs and the live inspector |
| `patches/` | project-authored MIPS-side patches and dependency patch files |
| `config/` | recompiler configuration and overlay metadata |
| `tools/` | analysis, generation and public-tree validation scripts |
| `input_scripts/` | scripted input sequences for reproducible testing |
| `assets/` | redistributable UI assets plus instructions for locally supplied fonts |
| `PUBLICATION_NOTES.md` | what was intentionally removed from the private development tree |
| `THIRD_PARTY_NOTICES.md` | dependency, asset and trademark notices |

## Before publishing or contributing

Run:

```bash
python tools/check_public_tree.py
```

The check rejects ROMs, ELFs, generated translation output, font binaries, private Git metadata,
common credential formats and known machine-specific path markers.

## License

Project-authored source in this snapshot is provided under the GNU General Public License v3.0; see
[LICENSE](LICENSE). Third-party components and assets retain their own licenses; see
[THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).

## Acknowledgements

Built on the work of N64Recomp, N64ModernRuntime, RecompFrontend and RT64. BanjoRecomp was also
used as an architectural and implementation reference, and selected infrastructure files are adapted
from or closely follow its GPL-3.0 implementation patterns. PromptFont attribution is preserved for
frontend font-related material. See [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md) for the specific
provenance and licensing notes.

Banjo-Tooie and related trademarks belong to their respective rights holders. This project is
unofficial and is not affiliated with or endorsed by them.