summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorcoco875 <59367621+coco875@users.noreply.github.com>2026-02-26 20:36:21 +0100
committerGitHub <noreply@github.com>2026-02-26 12:36:21 -0700
commit5c93004e38ac2345ed4c3686ceba27f2aa427793 (patch)
tree1e1d4d1519d9a8e7996001788de8f2424d311d18 /README.md
parentcb3b447b53abb8280e8dba891cd7acdd0aa1909f (diff)
clarify modding section (#656)
* clarify modding * add the mention of gamebanana page --------- Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 23 insertions, 10 deletions
diff --git a/README.md b/README.md
index 5b79bf3a3..a5bd266d0 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
## Discord
-Official Discord: https://discord.com/invite/shipofharkinian
+Official Discord: <https://discord.com/invite/shipofharkinian>
If you're having any trouble after reading through this `README`, feel free ask for help in the SpaghettiKart Support text channels. Please keep in mind that we do not condone piracy.
@@ -12,40 +12,49 @@ 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 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.
+
+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
+
+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>
### 2. Download SpaghettiKart from [Releases](https://github.com/HarbourMasters/SpaghettiKart/releases)
### 3. Generating the O2R from the ROM
+
#### Windows
+
* Extract every file from the zip into a folder of your choosing.
* Run "Spaghettify.exe" and select your US ROM.
#### Linux
+
* Extract every file from the zip into a folder of your choosing.
* Ensure `zenity` or `kdialog` package is installed.
* 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!
+### 4. Play
+
* Launch `Spaghettify.exe`
Congratulations, you are now sailing with SpaghettiKart! Have fun!
# Configuration
### Default controls configuration
+
| N64 | A | B | L | R | Z | Start | Analogue stick | C buttons | D-Pad |
| - | - | - | - | - | - | - | - | - | - |
| Keyboard | Shift | Ctrl | Q | Space | Z | Enter | Arrow keys | TGFH (↑ ↓ ← →) | Num 8 2 4 6 |
| SDL Gamepad | A | X | LB | RB | LT | Start | L-Stick | R-Stick Up, B, Y, R-Stick Right (↑ ↓ ← →) | D-Pad |
### Other shortcuts
+
| Keys | Action |
| - | - |
| F11 | Fullscreen |
@@ -54,24 +63,28 @@ Congratulations, you are now sailing with SpaghettiKart! Have fun!
| Esc | Settings |
### Graphics Backends
+
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
+# Modding
+
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)
+There is an official [gamebanana page](https://gamebanana.com/games/22970).
+
+If you're interested in creating and/or packing your own custom asset `.o2r` files, check out the [documentation page](https://harbourmasters.github.io/SpaghettiKart/).
**Note that .otr archives are not supported in SpaghettiKart!**
# Development
+
### Building
If you want to manually compile SpaghettiKart, please consult the [building instructions](https://github.com/HarbourMasters/SpaghettiKart/blob/main/docs/BUILDING.md).
-### Playtesting
-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.
+### Playtesting (nightly)
+
+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/spaghetti-windows.zip?status=completed)
* [Linux](https://nightly.link/HarbourMasters/SpaghettiKart/workflows/main/main/spaghetti-linux-x64.zip?status=completed)