diff options
| author | sitton76 <58642183+sitton76@users.noreply.github.com> | 2025-06-19 17:34:58 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-06-19 16:34:58 -0600 |
| commit | 3f9f89ed413c3a4026b83e0486e960cb075c3114 (patch) | |
| tree | cc8f2843966409f210b712789c41b84a3a3e254f /README.md | |
| parent | 8f88dbd2c312b3478db7ef6e91b340ece5aa321e (diff) | |
Readme update (#224)
* Updated readme
* Fixed incorrect package name for quick Ubuntu setup
* Removed needless mention of 1.0 rom from readme
* Less weird wording.
* Update README.md
---------
Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 31 |
1 files changed, 17 insertions, 14 deletions
@@ -18,7 +18,7 @@ If you're having any trouble after reading through this `README`, feel free ask SpaghettiKart does not include any copyrighted assets. You are required to provide a supported copy of the game. ### 1. Verify your ROM dump -The supported ROM is the USA 1.1 Rev A version. You can verify you have dumped a supported copy of the game by using the SHA-1 File Checksum Online at https://www.romhacking.net/hash/. The hash for a US 1.0 ROM is SHA-1: 579C48E211AE952530FFC8738709F078D5DD215E. +The US ROM is the only supported version. You can verify you have dumped a supported copy of the game by using the SHA-1 File Checksum Online at https://www.romhacking.net/hash/. The hash for a US ROM is SHA-1: 579C48E211AE952530FFC8738709F078D5DD215E. ### 2. Verify your ROM is in .z64 format Your ROM needs to be in .z64 format. If it's in .n64 format, use the following to convert it to a .z64: https://hack64.net/tools/swapper.php @@ -28,16 +28,18 @@ Your ROM needs to be in .z64 format. If it's in .n64 format, use the following t ### 3. Generating the O2R from the ROM #### Windows * Extract every file from the zip into a folder of your choosing. -* Copy your ROM to the root of the folder you extracted the zip to. -* Run "generate_o2r.bat" +* Run "Spaghettify.exe" and select your US ROM. -#### MacOS +#### Linux * Extract every file from the zip into a folder of your choosing. -* Copy your ROM to the root of the folder you extracted the zip to. -* Run "generate_o2r.sh" +* Run "spaghetti.appimage" and select your US ROM. You may have to chmod +x the appimage via terminal. + +#### Nintendo Switch +* Run one of the PC releases to generate an `mk64.o2r` file. After launching the game on PC, you will be able to find these files in the same directory as `Spaghettify.exe` or `spaghetti.appimage`. +* Copy the files to your sd card ### 4. Play! -* Launch `SpaghettiKart.exe` +* Launch `Spaghettify.exe` Congratulations, you are now sailing with SpaghettiKart! Have fun! # Configuration @@ -59,11 +61,13 @@ Congratulations, you are now sailing with SpaghettiKart! Have fun! Currently, there are three rendering APIs supported: DirectX11 (Windows), OpenGL (all platforms), and Metal (macOS). You can change which API to use in the `Settings` menu of the menubar, which requires a restart. If you're having an issue with crashing, you can change the API in the `spaghettify.cfg.json` file by finding the line `"Backend":{`... and changing the `id` value to `3` and set the `Name` to `OpenGL`. `DirectX 11` with id `2` is the default on Windows. `Metal` with id `4` is the default on macOS. # Custom Assets -Custom assets are packed in `.o2r` or `.otr` files. To use custom assets, place them in the `mods` folder. +Custom assets are packed in `.o2r` or stored `.zip` files. To use custom assets, place them in the `mods` folder. + +If you're interested in creating and/or packing your own custom asset `.o2r` files, check out the following tools: +* [**retro - O2R generator**](https://github.com/HarbourMasters64/retro) +* [**fast64 - Blender plugin**](https://github.com/HarbourMasters/fast64) -If you're interested in creating and/or packing your own custom asset `.o2r`/`.otr` files, check out the following tools: -* [**retro - OTR and O2R generator**](https://github.com/HarbourMasters64/retro) -* [**fast64 - Blender plugin (Note that SF64 is not supported at this time)**](https://github.com/HarbourMasters/fast64) +**Note that .otr archives are not supported in SpaghettiKart!** # Development ### Building @@ -74,13 +78,12 @@ If you want to manually compile SpaghettiKart, please consult the [building inst If you want to playtest a continuous integration build, you can find them at the links below. Keep in mind that these are for playtesting only, and you will likely encounter bugs and possibly crashes. * [Windows](https://nightly.link/HarbourMasters/SpaghettiKart/workflows/main/main/spaghettify-windows.zip) -* [macOS](https://nightly.link/HarbourMasters/SpaghettiKart/workflows/main/main/spaghettify-mac-x64.zip) * [Linux](https://nightly.link/HarbourMasters/SpaghettiKart/workflows/main/main/SpaghettiKart-linux.zip) - +* [Switch](https://nightly.link/HarbourMasters/SpaghettiKart/workflows/main/main/Spaghettify-switch.zip) <a href="https://github.com/Kenix3/libultraship/"> <picture> <source media="(prefers-color-scheme: dark)" srcset="./docs/poweredbylus.darkmode.png"> <img alt="Powered by libultraship" src="./docs/poweredbylus.lightmode.png"> </picture> -</a>
\ No newline at end of file +</a> |
