You've already forked ultrasm64-2
mirror of
https://github.com/HackerN64/ultrasm64-2.git
synced 2026-01-21 10:38:08 -08:00
Refresh 1
This commit is contained in:
70
README.md
70
README.md
@@ -17,53 +17,56 @@ A prior copy of the game is required to extract the required assets.
|
||||
|
||||
### Linux
|
||||
|
||||
1. For each version (jp/us/eu) that you want to build a ROM for, put an existing ROM at
|
||||
#### 1. Copy baserom(s) for asset extraction
|
||||
|
||||
For each version (jp/us/eu) that you want to build a ROM for, put an existing ROM at
|
||||
`./baserom.<version>.z64` for asset extraction.
|
||||
|
||||
2. Install the following packages:
|
||||
#### 2. Install build dependencies
|
||||
|
||||
The build system has the following package requirements:
|
||||
* binutils-mips >= 2.27
|
||||
* python3 >= 3.6
|
||||
* libaudiofile
|
||||
* qemu-irix
|
||||
|
||||
__Debian / Ubuntu__
|
||||
* git
|
||||
* binutils-mips-linux-gnu / mips64-elf (>= 2.27)
|
||||
* python3 (>= 3.7)
|
||||
* build-essential
|
||||
* pkg-config
|
||||
* zlib1g-dev
|
||||
* libaudiofile-dev
|
||||
```
|
||||
sudo apt install build-essential pkg-config git binutils-mips-linux-gnu python3 zlib1g-dev libaudiofile-dev
|
||||
```
|
||||
|
||||
__Arch Linux__
|
||||
* base-devel
|
||||
* python
|
||||
* audiofile
|
||||
```
|
||||
sudo pacman -Sy base-devel python audiofile
|
||||
```
|
||||
Install the following AUR packages:
|
||||
* [mips64-elf-binutils](https://aur.archlinux.org/packages/mips64-elf-binutils) (AUR)
|
||||
* [qemu-irix-git](https://aur.archlinux.org/packages/qemu-irix-git) (AUR)
|
||||
|
||||
#### 3. Install qemu-irix
|
||||
|
||||
3. Install qemu-irix
|
||||
|
||||
3.a Options:
|
||||
1. Clone https://github.com/n64decomp/qemu-irix to somewhere and follow its
|
||||
install instructions in the README.
|
||||
2. Optionally, grab the prebuilt qemu-irix from the Releases section.
|
||||
3. (Arch) Use AUR package [qemu-irix-git](https://aur.archlinux.org/packages/qemu-irix-git)
|
||||
|
||||
3.b (For options 1 or 2), copy executable `qemu-irix` from irix-linux-user to
|
||||
somewhere convenient with a relatively short path.
|
||||
1. Options:
|
||||
1. Clone https://github.com/n64decomp/qemu-irix to somewhere and follow its install instructions in the README.
|
||||
2. Optionally, grab the prebuilt qemu-irix from the [Releases](https://github.com/n64decomp/sm64/releases) section.
|
||||
3. (Arch) Use AUR package [qemu-irix-git](https://aur.archlinux.org/packages/qemu-irix-git)
|
||||
2. (For the first two options), copy executable `qemu-irix` from irix-linux-user to
|
||||
somewhere convenient with a relatively short path. e.g.:
|
||||
```
|
||||
mkdir -p /opt/qemu-irix/bin
|
||||
cp irix-linux-user/qemu-irix /opt/qemu-irix/bin
|
||||
```
|
||||
|
||||
3.c Define `QEMU_IRIX` environment variable in your `~/.bashrc` to point to
|
||||
this qemu-irix executable.
|
||||
3. Define `QEMU_IRIX` environment variable in your `~/.bashrc` to point to this qemu-irix executable.
|
||||
```
|
||||
export QEMU_IRIX=/opt/qemu-irix/bin/qemu-irix
|
||||
```
|
||||
|
||||
6. Run `make` to build the ROM (defaults to us version). Make sure your path to
|
||||
the repo is not too long or else this process will error, as the emulated
|
||||
IDO compiler cannot handle paths longer than 255 characters.
|
||||
Build examples:
|
||||
#### 4. Build ROM
|
||||
|
||||
Run `make` to build the ROM (defaults to `VERSION=us`). Make sure your path to the repo
|
||||
is not too long or else this process will error, as the emulated IDO compiler cannot
|
||||
handle paths longer than 255 characters.
|
||||
Examples:
|
||||
```
|
||||
make VERSION=jp -j4 # build (J) version instead with 4 jobs
|
||||
make VERSION=eu COMPARE=0 # non-matching EU version still WIP
|
||||
@@ -71,7 +74,16 @@ make VERSION=eu COMPARE=0 # non-matching EU version still WIP
|
||||
|
||||
## Windows
|
||||
|
||||
For Windows, install WSL and a distro of your choice and follow the Linux guide.
|
||||
For 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.
|
||||
|
||||
Then follow the directions in the [Linux](#linux) installation section above.
|
||||
|
||||
## macOS
|
||||
|
||||
macOS is currently unsupported as qemu-irix is unable to be built for macOS host.
|
||||
The recommended path is installing a Linux distribution under a VM.
|
||||
|
||||
## Contributing
|
||||
|
||||
|
||||
Reference in New Issue
Block a user