{"id":13691981,"url":"https://github.com/bfbbdecomp/bfbb","last_synced_at":"2025-05-02T16:31:09.076Z","repository":{"id":45135666,"uuid":"291377478","full_name":"bfbbdecomp/bfbb","owner":"bfbbdecomp","description":"Decompilation project for SpongeBob SquarePants: Battle for Bikini Bottom","archived":false,"fork":false,"pushed_at":"2024-09-17T19:57:07.000Z","size":24885,"stargazers_count":127,"open_issues_count":2,"forks_count":26,"subscribers_count":7,"default_branch":"main","last_synced_at":"2024-09-17T23:55:55.088Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://bfbbdecomp.github.io/bfbb/","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bfbbdecomp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-08-30T01:25:16.000Z","updated_at":"2024-09-17T19:20:51.000Z","dependencies_parsed_at":"2024-07-06T11:56:12.805Z","dependency_job_id":"794999fa-0d92-4dd6-9cf7-4da517614c91","html_url":"https://github.com/bfbbdecomp/bfbb","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bfbbdecomp%2Fbfbb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bfbbdecomp%2Fbfbb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bfbbdecomp%2Fbfbb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bfbbdecomp%2Fbfbb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bfbbdecomp","download_url":"https://codeload.github.com/bfbbdecomp/bfbb/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224319515,"owners_count":17291855,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-02T17:00:52.249Z","updated_at":"2024-11-12T17:32:34.914Z","avatar_url":"https://github.com/bfbbdecomp.png","language":"C++","funding_links":[],"categories":["Nintendo Wii","Game \u0026 Studio Tools","Reverse Engineering"],"sub_categories":["Heavy Iron Studios","Projects"],"readme":"# SpongeBob SquarePants: Battle for Bikini Bottom\n\n[![Discord Badge]][discord]\n[![Build Status]][actions]\n\n[![Perfect Match]][progress]\n[![Fuzzy Match]][progress]\n[![Functions]][progress]\n\n[progress]: https://bfbbdecomp.github.io/bfbb/\n[Fuzzy Match]: https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fbfbbdecomp.github.io%2Fbfbb%2Fapi.json\u0026query=fuzzy_match\u0026label=Close%20Match\u0026color=yellowgreen\n[Perfect Match]: https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fbfbbdecomp.github.io%2Fbfbb%2Fapi.json\u0026query=perfect_match\u0026label=Matching\u0026color=limegreen\n[Functions]: https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fbfbbdecomp.github.io%2Fbfbb%2Fapi.json\u0026query=functions_matched\u0026label=Functions\u0026color=lavender\n[Build Status]: https://github.com/bfbbdecomp/bfbb/actions/workflows/build.yml/badge.svg\n[actions]: https://github.com/bfbbdecomp/bfbb/actions/workflows/build.yml\n[Discord Badge]: https://img.shields.io/discord/829152115322257436?color=%237289DA\u0026logo=discord\u0026logoColor=%23FFFFFF\n[discord]: https://discord.gg/dVbGFdYU6A\n\nA work-in-progress decompilation of SpongeBob SquarePants: Battle for Bikini Bottom.\n\nIt builds the following DOL:\n\nmain.dol: `sha1: 306526d90b48e99894c3138f5fc8f2716d9fecf6`\n\nThis repository does **not** contain any game assets or assembly whatsoever. An existing copy of the game is required.\n\nSupported versions:\n\n- `GQPE78`: (NTSC-U)\n\n# Dependencies\n\n## Windows\n\nOn Windows, it's **highly recommended** to use native tooling. WSL or msys2 are **not** required.  \nWhen running under WSL, [objdiff](#diffing) is unable to get filesystem notifications for automatic rebuilds.\n\n- Install [Python](https://www.python.org/downloads/) and add it to `%PATH%`.\n  - Also available from the [Windows Store](https://apps.microsoft.com/store/detail/python-311/9NRWMJP3717K).\n- Download [ninja](https://github.com/ninja-build/ninja/releases) and add it to `%PATH%`.\n  - Quick install via pip: `pip install ninja`\n\n## macOS\n\n- Install [ninja](https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages):\n\n  ```sh\n  brew install ninja\n  ```\n\n- Install [wine-crossover](https://github.com/Gcenx/homebrew-wine):\n\n  ```sh\n  brew install --cask --no-quarantine gcenx/wine/wine-crossover\n  ```\n\nAfter OS upgrades, if macOS complains about `Wine Crossover.app` being unverified, you can unquarantine it using:\n\n```sh\nsudo xattr -rd com.apple.quarantine '/Applications/Wine Crossover.app'\n```\n\n## Linux\n\n- Install [ninja](https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages).\n- For non-x86(\\_64) platforms: Install wine from your package manager.\n  - For x86(\\_64), [wibo](https://github.com/decompals/wibo), a minimal 32-bit Windows binary wrapper, will be automatically downloaded and used.\n\n# Building\n\n- Clone the repository:\n\n  ```sh\n  git clone https://github.com/bfbbdecomp/bfbb.git\n  ```\n\n- Using [Dolphin Emulator](https://dolphin-emu.org/), extract your game to `orig/GQPE78`.\n  ![](assets/dolphin-extract.png)\n  - To save space, the only necessary files are the following. Any others can be deleted.\n    - `sys/main.dol`\n- Configure:\n\n  ```sh\n  python configure.py\n  ```\n\n  To use a version other than `GQPE78` (NTSC-U), specify it with `--version`.\n\n- Build:\n\n  ```sh\n  ninja\n  ```\n\n# Visual Studio Code\n\nIf desired, use the recommended Visual Studio Code settings by renaming the `.vscode.example` directory to `.vscode`.\n\n# Diffing\n\nOnce the initial build succeeds, an `objdiff.json` should exist in the project root.\n\nDownload the latest release from [encounter/objdiff](https://github.com/encounter/objdiff). Under project settings, set `Project directory`. The configuration should be loaded automatically.\n\nSelect 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`.\n\n![](assets/objdiff.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbfbbdecomp%2Fbfbb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbfbbdecomp%2Fbfbb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbfbbdecomp%2Fbfbb/lists"}