From d0e19eaf232411762724a31783592f1d8791c24d Mon Sep 17 00:00:00 2001 From: CrashOveride95 <40003130+CrashOveride95@users.noreply.github.com> Date: Mon, 25 Jan 2021 12:42:24 -0500 Subject: [PATCH] Update README.md --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index d7c0c98a..9957555f 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,37 @@ - Getting HVQM FMV support to work with the game is in progress. - Getting UNFLoader (flashcart USB library) to work with the game is in progress. +## 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. + +Additionally, the repo also supports compressing 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`` + +This argument makes the makefile use ``libdeflate`` with it's highest compression setting, ``-12``. + + ## FAQ Q: Why in the hell are you bundling your own build of ``ld``?