joshsanch / bfbb

Decompilation project for SpongeBob SquarePants: Battle for Bikini Bottom

SpongeBob SquarePants: Battle for Bikini Bottom

This repo contains a WIP decompilation of SpongeBob SquarePants: Battle for Bikini Bottom (US) for Nintendo GameCube.

It builds the following DOL:

main.dol: sha1: 306526d90b48e99894c3138f5fc8f2716d9fecf6

Progress

View our progress and answers to frequently asked questions on the project tracking website (currently down, will be updated soon).

Join the discussion on the BFBB Decompilation Discord.

Building

Requirements

• devkitPro
  • During installation, only the 'GameCube Development' component is required.
• Python 3
• gcc
• Metrowerks CodeWarrior 2.0 and 2.7 compiler and linker for Embedded PowerPC (mwcceppc.exe and mwldeppc.exe)
  • Follow the instructions here.

Instructions

1. Extract the downloaded mwcc_compiler folder from the zip file into tools/mwcc_compiler.
2. Run the make command.

Instructions using Docker

1. Build the Docker image: docker build . -t bfbb
2. Compile BFBB: docker run -v $(pwd):/bfbbdecomp bfbb make --jobs

Project Structure

bfbb
├── .github/workflows: build script for the website and CI
├── .vscode: settings and tasks for VS Code
├── asm: disassembled source code and linker code
├── include: global include headers
│   ├── CodeWarrior: C/C++ standard library
│   ├── dolphin: Dolphin SDK
│   ├── inline: utility inline asm macros
│   └── rwsdk: RenderWare SDK
├── src: decompiled C/C++ source code for BFBB
│   ├── Core: core game engine code
│   │   ├── gc: platform-specific code for GameCube
│   │   └── x: game engine code
│   └── Game: game-specific code
├── tools: helper scripts and tools
│   ├── mwcc_compiler: Metrowerks compiler and linker
└   └── dtk: GameCube/Wii decompilation project tools.

Contributions

Contributions and PRs are welcome.

We recommend joining the BFBB Decompilation Discord as most of our discussion about this project occurs there. It's also the best place to get help if you need it.

Special Thanks

• @encounter for creating a full disassembly, dtk, and objdiff.

• All other contributors