markstreet/sssv repository overview

⁠Space Station Silicon Valley N64

A WIP decompilation of Space Station Silicon Valley (SSSV) for N64. Checkout the wiki⁠ for more information.

Note: To use this repository, you must already own a copy of the game.

⁠Building

The instructions below assume that you will be using Ubuntu 20.04; either natively, via WSL2⁠, or via Docker⁠. Please check the packages.txt⁠ and requirements.txt⁠ for the prerequisite Linux and Python packages respectively.

⁠Natively

Clone the repository; note the --recursive flag to fetch submodules at the same time:

git clone [email protected]:mkst/sssv.git --recursive

Navigate into the freshly cloned repo

cd sssv

Place the US 1.0 SSSV ROM in the root of this repository, name it baserom.us.z64, and then run the first make command to extract the ROM:

make extract

Now build the ROM:

make --jobs

If you did everything correctly, you'll be greeted with the following:

build/sssv.us.z64: OK

⁠Docker

Clone this repository, place the baserom.us.z64 at its root, and then run the Docker image via:

docker run --rm -ti -v $(pwd):/sssv markstreet/sssv:latest

From here you can run the make extract and make --jobs commands.

⁠Versions

There are 5 known versions of the ROM:

Only US and EU versions were released. If you are in possession of the Prototype ROM, let me know - mkst#4741.

⁠Building EU Version

Place baserom.eu.z64 in the root of the repository, and suffix each make command with VERSION=eu. Note that whilst this will build the EU ROM, no effort has been made to decompile it.

⁠ROM Info

⁠Layout

The layout of the ROM is work-in-progress. Three sections of code have been identified along with a mix of compressed and non-compressed data.

⁠Compression

Uses RNC⁠ for a number of assets.

Compression is partially matching; 250/263 files match after compression.

A handful of files are compressed twice.

In order to decompress the game assets run make decompress after you have performed the make extract step. This will be done automatically when matching compression has been figured out.

⁠Repo layout

asm/             ; assembly files split by splat (not checked in)
bin/             ; binary files split by splat (not checked in)
build/           ; build folder (not checked in)
include/
  2.0I/          ; libultra 2.0I headers
src/
  core/          ; core code
  lib/libultra/  ; libultra code
  sssv/          ; game code
tools/
  ido5.3_recomp/ ; static recompilation of IDO 5.3 compiler

⁠Tools

• asm-processor⁠; allows GLOBAL_ASM pragma - replacing assembly inside C files
• asm-differ⁠; rapidly diff between source/target assembly
• decomp-permuter⁠; tweaks code, rebuilds, scores; helpful for weird regalloc issues
• ido-static-recomp⁠; no need to use qemu-irix anymore!
• mips2c⁠; assembly to C code translator
• rnc_propack_source⁠; open-source compressor/decompressor for RNC file format
• splat⁠; successor to n64split

⁠Useful Links

• SSSV at TCRF⁠
• SSSV at romhacking.net⁠
• Music video based on SSSV Prototype build⁠
• ScriptHawk lua for SSSV⁠
• EverDrive Forum thread⁠