mirror of
https://github.com/HarbourMasters/Starship.git
synced 2025-01-23 13:35:11 +03:00
76 lines
3.2 KiB
Markdown
76 lines
3.2 KiB
Markdown
[comment]: <> (Todo: Make Light Mode Image)
|
|
[comment]: <> (Todo: Make Dark Mode Image)
|
|
|
|
# Starship
|
|
|
|
## Discord
|
|
|
|
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 Starship Support text channels. Please keep in mind that we do not condone piracy.
|
|
|
|
# Quick Start
|
|
|
|
Starship 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 MD5 File Checksum Online at https://www.romhacking.net/hash/. The MD5 hash for a US 1.1 ROM is 741A94EEE093C4C8684E66B89F8685E8.
|
|
|
|
### 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
|
|
|
|
### 2. Download Starship from [Releases](https://github.com/HarbourMasters/Starship/releases)
|
|
|
|
### 3. Generating the OTR 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_otr.bat"
|
|
|
|
#### MacOS
|
|
* 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_otr.sh"
|
|
|
|
### 4. Play!
|
|
* Launch `Starship.exe`
|
|
Congratulations, you are now sailing with Starship! Have fun!
|
|
|
|
# Configuration
|
|
|
|
### Default keyboard configuration
|
|
| N64 | A | B | Z | Start | Analog stick | C buttons | D-Pad |
|
|
| - | - | - | - | - | - | - | - |
|
|
| Keyboard | X | C | Z | Space | WASD | Arrow keys | TFGH |
|
|
|
|
### Other shortcuts
|
|
| Keys | Action |
|
|
| - | - |
|
|
| F1 | Toggle menubar |
|
|
| F11 | Fullscreen |
|
|
| Tab | Toggle Alternate assets |
|
|
| Ctrl+R | Reset |
|
|
|
|
### 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 `starship.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.
|
|
|
|
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)
|
|
|
|
# Development
|
|
### Building
|
|
|
|
If you want to manually compile Starship, please consult the [building instructions](https://github.com/HarbourMasters/Starship/blob/main/docs/BUILDING.md).
|
|
|
|
<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>
|