Decompiling TSSM: A Step-by-Step Guide

Are you interested in decompiling The SpongeBob SquarePants Movie (TSSM)? This guide provides a clear, concise walkthrough of the process using the bfbbdecomp/tssm GitHub project. Learn how to set up your environment and contribute to this exciting project.

What is TSSM Decompilation & Why Should You Care?

Decompilation translates the game's machine code back into a human-readable format (like C code). This allows modders, researchers, and fans to understand the inner workings of the game.

• Improved Modding: Create more sophisticated mods with a deeper understanding of the game's code.
• Game Preservation: Ensure the game's logic isn't lost.
• Learning Experience: Explore game development techniques.

Supported TSSM Versions

Currently, the project supports only the following version:

• GGVE78: (NTSC)

Setting Up Your Environment: Windows, macOS, & Linux

The setup process varies depending on your operating system. Choose the section that applies to you.

Windows: Native Tooling is Key

For Windows users, utilizing native tooling ensures a smoother experience. Skip the complexities of WSL or msys2.

• Install Python: Ensure Python is installed and added to your %PATH% environment variable. It can be installed from the Windows store.
• Install Ninja: Download and add Ninja to your %PATH%. Use pip install ninja for quick installation.

macOS: Wine Crossover is Essential

macOS users need Wine Crossover to handle Windows-specific tasks during the decompilation.

• Install Ninja: Use your preferred package manager (e.g., Homebrew) to install Ninja.
• Install Wine Crossover: Execute the following command in your terminal: brew install --cask --no-quarantine gcenx/wine/wine-crossover
• Fix Verification Issues: After OS upgrades, you might need to unquarantine Wine Crossover. Use this command: sudo xattr -rd com.apple.quarantine ' /Applications/Wine Crossover.app '

Linux: Wibo for x86(_64)

Linux setup depends on your architecture.

• Install Ninja: Use your distribution's package manager to install Ninja.
• Install Wine (Non-x86(_64)): For non-x86(_64) platforms, install Wine from your package manager.
• Wibo (x86(_64)): A minimal 32-bit Windows binary wrapper, will be automatically downloaded and used for x86(_64) architectures.

Decompiling TSSM: The Build Process

Follow these steps to build the decompiled project.

Clone the Repository and Add Game Files

Start by cloning the repository and adding your game's disc image.

1. Clone: git clone https://github.com/my/repo.git
2. Copy Disc Image: Place your game's disc image into the orig/GGVE78 directory. Supported formats: ISO (GCM), RVZ, WIA, WBFS, CISO, NFS, GCZ, TGC. You can delete disc images after initial build.

Configure and Build

Now, configure and build the project:

1. Configure: Run the configure script. For non-USA versions, specify with --version.
2. Build: Execute the build command (e.g., ninja) to start the decompilation process.

Diffing: Comparing Code

Diffing is crucial for understanding the changes you're making.

1. Locate objdiff.json: After a successful initial build, find objdiff.json in the project root.
2. Download objdiff: Get the latest release from encounter/objdiff.
3. Configure: In objdiff's settings, set the Project directory to your decompilation project's root (where objdiff.json is located). The configuration should load automatically.
4. Start Diffing: Select an object from the left sidebar to compare code and view changes. The TSSM project will rebuild automatically based on your changes.

Contributing to TSSM Decompilation

By following these steps, you can successfully decompile TSSM and contribute to the bfbbdecomp/tssm project. Your contributions help preserve and enhance this classic game!