You've already forked Microtransactions64
mirror of
https://github.com/Print-and-Panic/Microtransactions64.git
synced 2026-01-21 10:17:19 -08:00
78 lines
3.1 KiB
Markdown
78 lines
3.1 KiB
Markdown
# UltraSM64
|
|
|
|
- This repo contains a full decompilation of Super Mario 64 (J), (U), (E), and (SH).
|
|
- Naming and documentation of the source code and data structures are in progress.
|
|
- It has been edited to allow for the usage of the final "N64 OS" library, version ``2.0L``
|
|
- Shindou Rumble Pak code is on for all regions.
|
|
- Targeting the iQue Player is supported.
|
|
- Saving to 32kbyte/256kbit SRAM is supported.
|
|
- Newer compression options are supported.
|
|
- UNFLoader (flashcart USB library) is supported, allowing for debugging on EverDrive/64Drive.
|
|
- It has been patched with someone2639's shiftable segments patch
|
|
- Getting HVQM FMV support to work with the game is WIP.
|
|
|
|
## UNFLoader support
|
|
|
|
The repository supports UNFLoader for debugging.
|
|
|
|
To build with UNF, run make with ``UNF=1``.
|
|
|
|
Further instructions can be found at the [official repository](https://github.com/buu342/N64-UNFLoader)
|
|
|
|
## Multi-Save support
|
|
|
|
The repository supports SRAM in addition to EEPROM. The standard save data functions are #ifdef'd to accommedate this.
|
|
|
|
To build with SRAM support, run make with ``SAVETYPE=sram``.
|
|
|
|
I may attempt FlashRAM in the future.
|
|
|
|
## Multi-Console support
|
|
|
|
The repository supports targeting the iQue Player in addition to the N64. The iQue libultra is ***NOT*** compatible with N64 in many ways, so it is currently NOT possible to have one build for both consoles.
|
|
|
|
To target iQue, run make with the ``CONSOLE=bb`` argument.
|
|
|
|
## Compression
|
|
|
|
The repository supports using DEFLATE compression instead of Nintendo's Yay0. This boasts a better compression ratio, but at a slight cost to load times.
|
|
|
|
On average I'd estimate that the bottleneck on decompression is about 1-2 seconds.
|
|
|
|
To switch to gzip, run make with the ``COMPRESS=gzip`` argument.
|
|
|
|
The repo also supports gziping with ``libdeflate-gzip``. This compresses at a slightly better ratio than standard ``gzip``, with no real downside from a decompression standpoint.
|
|
|
|
To use ``libdeflate-gzip``, first clone the [repo](https://github.com/ebiggers/libdeflate), then make and make install it.
|
|
|
|
Then run make for sm64 with ``GZIPVER=libdef`` in addition to ``COMPRESS=gzip``
|
|
|
|
The repo also supports RNC (Rob Northen Compression). RNC has two methods.
|
|
|
|
Method 1 is designed to compress as small as possible, while method 2 is designed so that decompression is as fast as possible.
|
|
|
|
Both methods are fast. Method 1 has better compression than 2, so I suggest using method 1 if using RNC.
|
|
|
|
To switch to RNC, run make with either ``COMPRESS=rnc1`` or ``COMPRESS=rnc2``, depending on preferred method.
|
|
|
|
|
|
## FAQ
|
|
|
|
Q: Why in the hell are you bundling your own build of ``ld``?
|
|
|
|
A: Newer binutils (Like the one bundled with Ubuntu, 2.34) break linking with libultra builds due to local asm symbols.
|
|
|
|
This puts me at a crossroads of either touching leaked code and requiring GCC, or just using an older linker that works just fine.
|
|
|
|
I went with the latter.
|
|
|
|
Thanks to "someone2639" for this hacky-ass idea
|
|
|
|
Q: Will this allow me to use FlashRAM/Transfer Pak/microcode swapping/Other Cool N64 Features?
|
|
|
|
A: Theoretically, all yes.
|
|
|
|
## Installation help
|
|
|
|
Go read the original repo README.md
|