Game-Decompilation/bfbb
1
0
Fork 0
mirror of https://github.com/bfbbdecomp/bfbb.git synced 2024-11-23 14:29:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
Decompilation project for SpongeBob SquarePants: Battle for Bikini Bottom
260 Commits 12 Branches 0 Tags 47 MiB
C++ 77.6%
C 18.3%
Python 4%
Assembly 0.1%
e23d1a3c28
Go to file
Steven Casper e23d1a3c28
zAnimList 100% Equivalent (#275) 
Floating point scheduling is preventing a perfect match on
zAnimListInit.
2024-06-24 08:21:54 -05:00
.github/workflows Reapply "Try wine in CI instead of Wibo" 2024-06-22 01:29:57 -04:00
.vscode 100% OK zNPCTiki_InitStacking 2024-06-22 20:52:59 -05:00
assets initial commit 2024-06-20 17:35:55 -05:00
config/GQPE78 initial commit 2024-06-20 17:35:55 -05:00
docs initial commit 2024-06-20 17:35:55 -05:00
include Move CodeWarrior include files to proper directories 2024-06-21 22:13:53 -04:00
orig/GQPE78 initial commit 2024-06-20 17:35:55 -05:00
src/SB zAnimList 100% Equivalent (#275) 2024-06-24 08:21:54 -05:00
tools Enable CI, Track Progress 2024-06-21 23:16:25 -04: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 add VScode C++ settings 2024-06-21 23:07:49 -05:00
configure.py zAnimList 100% Equivalent (#275) 2024-06-24 08:21:54 -05:00
LICENSE initial commit 2024-06-20 17:35:55 -05:00
README.md Update readme badges 2024-06-22 02:15:48 -04:00

README.md

SpongeBob SquarePants: Battle for Bikini Bottom

Build Status DOL Progress Discord Badge

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%.
  • 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.