Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bfbbdecomp/bfbb
Decompilation project for SpongeBob SquarePants: Battle for Bikini Bottom
https://github.com/bfbbdecomp/bfbb
Last synced: 2 months ago
JSON representation
Decompilation project for SpongeBob SquarePants: Battle for Bikini Bottom
- Host: GitHub
- URL: https://github.com/bfbbdecomp/bfbb
- Owner: bfbbdecomp
- License: cc0-1.0
- Created: 2020-08-30T01:25:16.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-17T19:57:07.000Z (4 months ago)
- Last Synced: 2024-09-17T23:55:55.088Z (4 months ago)
- Language: C++
- Homepage: https://bfbbdecomp.github.io/bfbb/
- Size: 23.7 MB
- Stars: 127
- Watchers: 7
- Forks: 26
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-gamecube-development - SpongeBob SquarePants: Battle for Bikini Bottom - An in-progress decompilation of _SpongeBob SquarePants: Battle for Bikini Bottom_ (Reverse Engineering / Projects)
README
# SpongeBob SquarePants: Battle for Bikini Bottom
[![Discord Badge]][discord]
[![Build Status]][actions]
[![Perfect Match]][progress]
[![Fuzzy Match]][progress]
[![Functions]][progress]
[progress]: https://bfbbdecomp.github.io/bfbb/
[Fuzzy Match]: https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fbfbbdecomp.github.io%2Fbfbb%2Fapi.json&query=fuzzy_match&label=Close%20Match&color=yellowgreen
[Perfect Match]: https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fbfbbdecomp.github.io%2Fbfbb%2Fapi.json&query=perfect_match&label=Matching&color=limegreen
[Functions]: https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fbfbbdecomp.github.io%2Fbfbb%2Fapi.json&query=functions_matched&label=Functions&color=lavender
[Build Status]: https://github.com/bfbbdecomp/bfbb/actions/workflows/build.yml/badge.svg
[actions]: https://github.com/bfbbdecomp/bfbb/actions/workflows/build.yml
[Discord Badge]: https://img.shields.io/discord/829152115322257436?color=%237289DA&logo=discord&logoColor=%23FFFFFF
[discord]: https://discord.gg/dVbGFdYU6A
A work-in-progress decompilation of SpongeBob SquarePants: Battle for Bikini Bottom.
It builds the following DOL:
main.dol: `sha1: 306526d90b48e99894c3138f5fc8f2716d9fecf6`
This repository does **not** contain any game assets or assembly whatsoever. An existing copy of the game is required.
Supported versions:
- `GQPE78`: (NTSC-U)
# Dependencies
## Windows
On Windows, it's **highly recommended** to use native tooling. WSL or msys2 are **not** required.
When running under WSL, [objdiff](#diffing) is unable to get filesystem notifications for automatic rebuilds.
- Install [Python](https://www.python.org/downloads/) and add it to `%PATH%`.
- Also available from the [Windows Store](https://apps.microsoft.com/store/detail/python-311/9NRWMJP3717K).
- Download [ninja](https://github.com/ninja-build/ninja/releases) and add it to `%PATH%`.
- Quick install via pip: `pip install ninja`
## macOS
- Install [ninja](https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages):
```sh
brew install ninja
```
- Install [wine-crossover](https://github.com/Gcenx/homebrew-wine):
```sh
brew install --cask --no-quarantine gcenx/wine/wine-crossover
```
After OS upgrades, if macOS complains about `Wine Crossover.app` being unverified, you can unquarantine it using:
```sh
sudo xattr -rd com.apple.quarantine '/Applications/Wine Crossover.app'
```
## Linux
- Install [ninja](https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages).
- For non-x86(\_64) platforms: Install wine from your package manager.
- For x86(\_64), [wibo](https://github.com/decompals/wibo), a minimal 32-bit Windows binary wrapper, will be automatically downloaded and used.
# Building
- Clone the repository:
```sh
git clone https://github.com/bfbbdecomp/bfbb.git
```
- Using [Dolphin Emulator](https://dolphin-emu.org/), extract your game to `orig/GQPE78`.
- To save space, the only necessary files are the following. Any others can be deleted.
- `sys/main.dol`
- Configure:
```sh
python configure.py
```
To use a version other than `GQPE78` (NTSC-U), specify it with `--version`.
- Build:
```sh
ninja
```
# Visual Studio Code
If desired, use the recommended Visual Studio Code settings by renaming the `.vscode.example` directory to `.vscode`.
# Diffing
Once the initial build succeeds, an `objdiff.json` should exist in the project root.
Download the latest release from [encounter/objdiff](https://github.com/encounter/objdiff). Under project settings, set `Project directory`. The configuration should be loaded automatically.
Select an object from the left sidebar to begin diffing. Changes to the project will rebuild automatically: changes to source files, headers, `configure.py`, `splits.txt` or `symbols.txt`.
