mirror of https://github.com/bfbbdecomp/bfbb.git synced 2024-11-27 00:21:00 +00:00

Decompilation project for SpongeBob SquarePants: Battle for Bikini Bottom

Go to file

escape209 487fa69be2 Some checks are pending Build / build (GQPE78) (push) Waiting to run Details Build / website (push) Blocked by required conditions Details xParMgr: enable match (#386 )		2024-10-09 10:16:41 -05:00
.github/workflows	expose secret to env var	2024-08-01 21:02:28 -05:00
.vscode	zEntPlayer (#311 )	2024-07-13 07:43:52 -05:00
assets	initial commit	2024-06-20 17:35:55 -05:00
config/GQPE78	More accurate splits (#297 )	2024-07-07 10:03:06 -05:00
docs	initial commit	2024-06-20 17:35:55 -05:00
include	More iSG memcard stuff (#364 )	2024-09-05 08:01:52 -05:00
orig/GQPE78	initial commit	2024-06-20 17:35:55 -05:00
src/SB	xParMgr: enable match (#386 )	2024-10-09 10:16:41 -05:00
tools	save current + previous commit progress report, and commit data in artifacts	2024-07-22 18:45:55 -05:00
.clang-format	regenerate clang format and reformat code (#150 )	2021-03-29 13:02:59 -05:00
.flake8	initial commit	2024-06-20 17:35:55 -05:00
.gitattributes	initial commit	2024-06-20 17:35:55 -05:00
.gitignore	misc. fodder progress	2024-07-04 17:32:32 -05:00
configure.py	xParMgr: enable match (#386 )	2024-10-09 10:16:41 -05:00
LICENSE	initial commit	2024-06-20 17:35:55 -05:00
README.md	update readme badges to show actual progress	2024-07-03 20:44:20 -05:00

README.md

SpongeBob SquarePants: Battle for Bikini Bottom

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 is unable to get filesystem notifications for automatic rebuilds.

Install Python and add it to %PATH%.
- Also available from the Windows Store.
Download ninja and add it to %PATH%.
- Quick install via pip: pip install ninja

macOS

Install ninja:
```
brew install ninja
```

Install wine-crossover:

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:

sudo xattr -rd com.apple.quarantine '/Applications/Wine Crossover.app'

Linux

Install ninja.
For non-x86(_64) platforms: Install wine from your package manager.
- For x86(_64), wibo, a minimal 32-bit Windows binary wrapper, will be automatically downloaded and used.

Building

Clone the repository:

git clone https://github.com/bfbbdecomp/bfbb.git

Using Dolphin Emulator, 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:
```
python configure.py
```
To use a version other than GQPE78 (NTSC-U), specify it with --version.
Build:
```
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. 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.