The SpongeBob SquarePants Movie: PC port

The SpongeBob SquarePants Movie: PC port is a native Windows port of The SpongeBob SquarePants Movie game for GameCube with widescreen and high frame rates.

README

The SpongeBob SquarePants Movie: PC port

A native Windows version of The SpongeBob SquarePants Movie game, built from the matching decompilation of the GameCube game (tssm-decomp-fork, whose history this repository starts from). The game's own decompiled code runs unchanged in behaviour; a new platform layer (src/SB/Core/pc) replaces the GameCube one, draws through librw (Direct3D 9, Direct3D 11 or OpenGL 3), and uses SDL 3 for the window, controllers and sound.

  • Windows, 64-bit (x64) and 32-bit (x86). The code also has Linux and macOS paths, but they are not tested.
  • Widescreen, any resolution, high frame rates, MSAA, a settings window (F1, or Back + Start on a controller), controller and keyboard bindings, mods (Xbox or GameCube packages), and save import and export with Dolphin and the GameCube.
  • The Xbox release's extras, each an option beside the GameCube's version and on by default: its glow, its moving spotlights, its fish crowds, its water (reflections, refraction and ripples) and full frame rate in the six levels the GameCube holds at 30 fps. The settings window's Xbox extras rows switch each one, and All GameCube sets them all to the GameCube's version.

Two ways to play

  • Download it ready-made. This repository's Releases page has TSSM Dehydrated 0.9.3 for Windows: TSSM-Dehydrated-0.9.3-Windows.zip (64-bit) and TSSM-Dehydrated-0.9.3-Windows-32bit.zip (32-bit). It is this branch, built under that neutral name with the port's own simple icon, and has no game data. It has no updater: a new version is a new zip.
  • Build it yourself from this source, as below. A build of your own is called The SpongeBob SquarePants Movie Video Game, and can carry an icon made from a picture of your choice (docs/ICON.md).

Either way you bring your own copy of the game's files, from the Xbox or the GameCube disc (below).

To play the zip: unzip it into a folder of its own (not under Program Files) and start tssm.exe. The program is not signed, so Windows may warn that it does not know the publisher: choose More info, then Run anyway. On the first start the launcher asks for the game's files: Browse... to the folder that holds boot.HIP, font.HIP and FMV (Xbox), or to the files folder of a GameCube disc extracted with Dolphin, then Play. config.ini is written beside tssm.exe, saves go to %APPDATA%\tssm\saves, and the log of the last run to %APPDATA%\tssm\last_run.log. The renderer is Direct3D 9 unless you pick Direct3D 11 or OpenGL 3 (launcher or settings window, Display, Renderer). The Xbox extras are on by default; the launcher's and the settings window's Xbox extras rows switch each one to the GameCube's version. src/SB/Core/pc/README.md ("Building the TSSM Dehydrated release") has the exact commands the zips were made with.

This repository and its branches

This repository holds the ports. The decompilation they are built on is its own repository, tssm-decomp-fork: this repository's history starts with that one's, so every port sits on exactly that code. Each port is a branch here; pick one from GitHub's branch menu, or clone it with git clone --branch <name>.

BranchWhat it is for
pc (this one)Windows (64-bit and 32-bit; Direct3D 9, Direct3D 11, OpenGL). The main port: every other branch is built on it.
androidAndroid phones and tablets: the PC port as an app, with touch controls and an import screen for the game files.
switchNintendo Switch homebrew (custom firmware): tssm.nro.
3dsNew 3DS homebrew (custom firmware): tssm.3dsx and tssm.cia. Still in progress: it runs, but has been played on a console only a little.
coopWindows with two-player co-op: online, on the home network, or two copies on one PC. Built on pc.
coop-androidThe co-op app for Android, a second app beside the normal one. Built on android.
coop-switchThe co-op Switch program, tssm-coop.nro. Built on switch.

Every branch builds from source; you bring your own game files.

You need your own copy of the game

This repository contains no game data. The port reads the files of the Xbox or the GameCube release of The SpongeBob SquarePants Movie, so you need your own copy of one of those discs and its files copied off it (about 1 GB). Never put those files in the repository.

  • GameCube: in Dolphin, right-click the game and choose Extract Entire Disc. It writes a files and a sys folder; point the game at either files or the folder holding both. Only the USA disc (GGVE78) has been tested.
  • Xbox: extract the files from your Xbox disc image (XISO) with an XISO extractor; point the game at the folder that directly holds boot.HIP, font.HIP and FMV\.

A disc image (.iso, .rvz) is not read directly: extract it first. With GameCube files the game is the GameCube release: its wording, its button pictures, its sound and its movies. The Xbox extras come from what the GameCube files hold: No Cheese!'s and Turn the Tables on Plankton's spotlights and No Cheese!'s crowd work as on the Xbox; the water, Sandwich Driving 101's crowd and Bubble Blowing Baby Hunt's disco lights are not in them, so those keep the GameCube version, and the settings window says so (docs/EXTRAS.md).

Building on Windows

You need:

  • Visual Studio 2022 or its Build Tools, with the "Desktop development with C++" workload and a Windows SDK
  • LLVM (clang++), CMake 3.16 or newer, Ninja, Python 3 and git
  • optional, for the game's movies: FFmpeg from vcpkg, vcpkg install ffmpeg[core,avcodec,avformat,swresample,swscale]:x64-windows (and :x86-windows for a 32-bit build). Without it the movies are skipped.

Then, in a normal command prompt:

git clone --branch pc <this repository's address> tssm
cd tssm
git submodule update --init --depth 1
build-release.bat

build-release.bat finds Visual Studio by itself, and LLVM and CMake in their default install folders. It puts tssm.exe and the DLLs it needs in bin\. build-release.bat GL3 x86 builds one renderer, 32-bit; build-debug.bat makes a debug build. src/SB/Core/pc/README.md lists the CMake options and the rest.

Building with MinGW-w64

The PC port also builds with MinGW-w64's GCC in MSYS2: 64-bit in the MINGW64 shell and 32-bit in the MINGW32 shell, with the same renderers, settings, saves and mods. The result is one tssm.exe with SDL and FFmpeg inside it, which needs no other DLLs. The steps, from installing MSYS2 to the finished build, are in src/SB/Core/pc/README.md, section "Building with MinGW (MSYS2)": tools/pcbuild-mingw.sh builds the game, and tools/mingw/build_ffmpeg.sh builds the small static FFmpeg it uses for the movies.

Playing

  1. Start bin\tssm.exe. On the first run it writes config.ini beside itself.
  2. Point the game at your game files, Xbox or GameCube: on the first run a window asks for the folder; or set path under [assets] in config.ini (or the TSSM_ASSETS environment variable) to the folder that holds boot.HIP (for a GameCube disc extracted with Dolphin, its files folder or the one above it).
  3. F1, or Back + Start on a controller, opens the settings window.

Saves go to %APPDATA%\tssm\saves, and the log of the last run to %APPDATA%\tssm\last_run.log.

More documentation:

FileWhat
docs/CONTROLS.mdthe controls, and how each was worked out
docs/GUI.mdthe settings window and the launcher
docs/SAVES.mdsave files, and moving them to and from Dolphin or a GameCube
docs/MODDING.mdmods: replacing textures, sounds, text and whole assets
docs/RENDERING.md, docs/WIDESCREEN.mdhow the console's screen effects, the water and widescreen are done
docs/EXTRAS.mdthe Xbox release's extras: glow, spotlights, crowds, water, the 30 fps levels
docs/PACING.mdhow a frame is paced, and what the frame-rate cap does
docs/ICON.mdusing your own picture as the program's icon
src/SB/Core/pc/README.mdbuilding in detail, settings, switches and test runs
src/SB/Core/pc/PORTING.mdwhere every file of the platform layer came from, and what is still stubbed

Building the original GameCube program

This section is about rebuilding the GameCube game's own program (main.dol) from the decompilation, not about playing the game: for that, see "You need your own copy of the game" above.

The port's changes to shared game code are all behind PLATFORM_PC, which only the port's CMake build defines, so this branch still builds the original GameCube program exactly (the decompilation repository's steps: your GameCube disc image in orig/GGVE78/, then python configure.py and ninja, which checks main.dol against SHA-1 f772db7f38b9b55e27169822ed17184fa2dc2574). Every change to shared code is checked that way.

How this was made

This port, like the decompilation under it, was made with an AI coding assistant (Claude, made by Anthropic), directed by the repository's owner, and tested by playing it. The upstream decompilation project keeps AI-assisted work out of its own repository and treats it as a separate reference: this repository is that kind of separate fork, not part of the upstream project.

Credits

  • The bfbbdecomp team and contributors, for the upstream TSSM decompilation project this is based on, and the Battle for Bikini Bottom decompilation.
  • treedome, the PC port of the Battle for Bikini Bottom decompilation (CC0) by @joeyballentine, whose platform layer this port started from.
  • blu (@bluisblu), who guided the decompilation and tested the ports.
  • seil (@seilc), for the references used in the decompilation.
  • The authors of librw, SDL, Dear ImGui, FFmpeg and the other libraries below.

The SpongeBob SquarePants Movie and its characters belong to their owners. This project is not affiliated with or endorsed by them, and it contains none of their game data.

Licenses

The port's own code, the decompiled game code and the rest of the work in this repository are released under CC0 1.0 (public domain); see LICENSE. That does not cover the parts that belong to others: the RenderWare SDK headers (include/rwsdk, and the port's adapted copies in src/SB/Core/pc/rwsdk) and the GameCube SDK, runtime and middleware code under src/dolphin, src/PowerPC_EABI_Support, src/rwsdk and src/FMOD keep their owners' copyright notices where the files carry them, as in the upstream project; dwarf/ is debugging information from the PlayStation 2 release, kept for reference.

The libraries the port is built with keep their own licences. The game shows their notices in its settings window (About tab).

If you share a build you made (rather than the source), the libraries' terms travel with it. In particular FFmpeg is under the LGPL: on Windows it is linked as separate DLLs, which keeps that simple; on Android, the Switch and the 3DS it is linked into the program, so a shared build also has to offer what the LGPL asks for (for example the object files needed to relink it with another FFmpeg).

LibraryHow it gets hereLicence
librw (a patched fork; the port's own fixes are in tools/librw/*.patch)git submodule third_party/librwMIT
LodePNG (inside librw)with librwzlib
SDL 3git submodule third_party/SDLzlib
Dear ImGuigit submodule third_party/imguiMIT
volk, Vulkan Memory Allocator (Vulkan renderer only)git submodulesMIT
Vulkan-Headers (Vulkan renderer only)git submoduleApache 2.0 / MIT
FFmpeg (optional, for the movies)not in the repository: you install or build itLGPL 2.1 or later
treedome (code adapted into src/SB/Core/pc)copied, see src/SB/Core/pc/PORTING.mdCC0 1.0
MinGW-w64 winpthreads (MinGW builds only)the MinGW-w64 toolchain, linked statically into tssm.exeMIT
MinGW-w64 runtime, the C runtime's startup and support code (MinGW builds only)the MinGW-w64 toolchain, linked staticallyZPL 2.1 and others
libgcc, libstdc++ (MinGW builds only)MinGW-w64 GCC, linked staticallyGPL 3 with the GCC Runtime Library Exception
FFmpeg in a MinGW build (optional)built by tools/mingw/build_ffmpeg.sh from FFmpeg's source and linked statically into tssm.exeLGPL 2.1 or later

A MinGW build is the exception on Windows: FFmpeg is linked into tssm.exe, so whoever shares one also has to offer the FFmpeg source it was built from, with tools/mingw/build_ffmpeg.sh (which is how it was configured). The About tab lists the MinGW-w64 runtime's notices with the others. Never share a build made with MSYS2's own FFmpeg package: it is GPL, not LGPL.