base on A Super Mario 64 decompilation, brought to you by a bunch of clever folks. # Super Mario 64 - This repo contains a full decompilation of Super Mario 64 of the following releases: Japan (jp), North America (us), Europe (eu), Shindou (sh) and iQue Player (cn). - Naming and documentation of the source code and data structures are in progress. It builds the following ROMs: * sm64.jp.z64 `sha1: 8a20a5c83d6ceb0f0506cfc9fa20d8f438cafe51` * sm64.us.z64 `sha1: 9bef1128717f958171a4afac3ed78ee2bb4e86ce` * sm64.eu.z64 `sha1: 4ac5721683d0e0b6bbb561b58a71740845dceea9` * sm64.sh.z64 `sha1: 3f319ae697533a255a1003d09202379d78d5a2e0` * sm64.cn.z64 `sha1: 2e1db2780985a1f068077dc0444b685f39cd90ec` This repo does not include all assets necessary for compiling the ROMs. A prior copy of the game is required to extract the assets. ## Quick Start (for Ubuntu) 1. Install prerequisites: `sudo apt install -y binutils-mips-linux-gnu build-essential git pkgconf python3` 2. Clone the repo from within Linux: `git clone https://github.com/n64decomp/sm64.git` 3. Place a Super Mario 64 ROM called `baserom.<VERSION>.z64` into the project folder for asset extraction, where `VERSION` can be `jp`, `us`, `eu`, `sh`, or `cn`. 4. Run `make` to build. Specify the version through `make VERSION=<VERSION>`. Add `-j4` to improve build speed (hardware dependent). Ensure the repo path length does not exceed 255 characters. Long path names result in build errors. ## Installation ### Windows Install WSL and a distro of your choice following [Windows Subsystem for Linux Installation Guide for Windows 10.](https://docs.microsoft.com/en-us/windows/wsl/install-win10) We recommend either Debian or Ubuntu 18.04 Linux distributions under WSL. Note: WSL1 does not currently support Ubuntu 20.04. Next, clone the SM64 repo from within the Linux shell: `git clone https://github.com/n64decomp/sm64.git` Then continue following the directions in the [Linux](#linux) installation section below. ### Linux There are 3 steps to set up a working build. #### Step 1: Install dependencies The build system has the following package requirements: * binutils-mips * pkgconf * python3 >= 3.6 Dependency installation instructions for common Linux distros are provided below: ##### Debian / Ubuntu To install build dependencies: ``` sudo apt install -y binutils-mips-linux-gnu build-essential git pkgconf python3 ``` ##### Arch Linux To install build dependencies: ``` sudo pacman -S base-devel python ``` Install the following AUR packages: * [mips64-elf-binutils](https://aur.archlinux.org/packages/mips64-elf-binutils) (AUR) ##### Other Linux distributions Most modern Linux distributions should have equivalent packages to the other two listed above. You may have to use a different version of GNU binutils. Listed below are fully compatible binutils distributions with support in the makefile, and examples of distros that offer them: * `mips64-elf-` (Arch AUR) * `mips-linux-gnu-` (Ubuntu and other Debian-based distros) * `mips64-linux-gnu-` (RHEL/CentOS/Fedora) You may also use [Docker](#docker-installation) to handle installing an image with minimal dependencies. #### Step 2: Copy baserom(s) for asset extraction For each version (jp/us/eu/sh/cn) for which you want to build a ROM, put an existing ROM at `./baserom.<VERSION>.z64` for asset extraction. ##### Step 3: Build the ROM Run `make` to build the ROM (defaults to `VERSION=us`). Other examples: ``` make VERSION=jp -j4 # build (J) version instead with 4 jobs make VERSION=eu COMPARE=0 # build (EU) version but do not compare ROM hashes ``` Resulting artifacts can be found in the `build` directory. The full list of configurable variables are listed below, with the default being the first listed: * ``VERSION``: ``jp``, ``us``, ``eu``, ``sh``, ``cn`` * ``GRUCODE``: ``f3d_old``, ``f3d_new``, ``f3dex``, ``f3dex2``, ``f3dzex`` * ``COMPARE``: ``1`` (compare ROM hash), ``0`` (do not compare ROM hash) * ``NON_MATCHING``: Use functionally equivalent C implementations for non-matchings. Also will avoid instances of undefined behavior. * ``CROSS``: Cross-compiler tool prefix (Example: ``mips64-elf-``). ### macOS With macOS, you may either use Homebrew or [Docker](#docker-installation). #### Homebrew #### Step 1: Install dependencies Install [Homebrew](https://brew.sh) and the following dependencies: ``` brew update brew install coreutils make pkg-config tehzz/n64-dev/mips64-elf-binutils ``` #### Step 2: Copy baserom(s) for asset extraction For each version (jp/us/eu/sh/cn) for which you want to build a ROM, put an existing ROM at `./baserom.<VERSION>.z64` for asset extraction. ##### Step 3: Build the ROM Use Homebrew's GNU make because the version included with macOS is too old. ``` gmake VERSION=jp -j4 # build (J) version instead with 4 jobs ``` ### Docker Installation #### Create Docker image After installing and starting Docker, create the docker image. This only needs to be done once. ``` docker build -t sm64 . ``` #### Build To build, mount the local filesystem into the Docker container and build the ROM with `docker run sm64 make`. ##### macOS example for (U): ``` docker run --rm --mount type=bind,source="$(pwd)",destination=/sm64 sm64 make VERSION=us -j4 ``` ##### Linux example for (U): For a Linux host, Docker needs to be instructed which user should own the output files: ``` docker run --rm --mount type=bind,source="$(pwd)",destination=/sm64 --user $UID:$GID sm64 make VERSION=us -j4 ``` Resulting artifacts can be found in the `build` directory. ## Project Structure sm64 ├── actors: object behaviors, geo layout, and display lists ├── asm: handwritten assembly code, rom header │ └── non_matchings: asm for non-matching sections ├── assets: animation and demo data │ ├── anims: animation data │ └── demos: demo data ├── bin: C files for ordering display lists and textures ├── build: output directory ├── data: behavior scripts, misc. data ├── doxygen: documentation infrastructure ├── enhancements: example source modifications ├── include: header files ├── levels: level scripts, geo layout, and display lists ├── lib: SDK library code ├── rsp: audio and Fast3D RSP assembly code ├── sound: sequences, sound samples, and sound banks ├── src: C source code for game │ ├── audio: audio code │ ├── buffers: stacks, heaps, and task buffers │ ├── engine: script processing engines and utils │ ├── game: behaviors and rest of game source │ ├── goddard: Mario intro screen │ └── menu: title screen and file, act, and debug level selection menus ├── text: dialog, level names, act names ├── textures: skybox and generic texture data └── tools: build tools ## Contributing Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Run `clang-format` on your code to ensure it meets the project's coding standards. Official Discord: [discord.gg/DuYH3Fh](https://discord.gg/DuYH3Fh) ", Assign "at most 3 tags" to the expected json: {"id":"4635","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"