mirror of
https://github.com/HarbourMasters/Shipwright.git
synced 2024-12-18 06:12:20 -05:00
62713bb551
* Added Project Overview to README This is a couple additional lines of text clarifying the high-level structure of the project, mostly for the benefit of anyone new joining the project. * Added "Further Reading" section Points out and lists the contents of the "docs" directory for ease of access to the documentation therein.
116 lines
5.3 KiB
Markdown
116 lines
5.3 KiB
Markdown
|
|
|
|
|
|
## Website
|
|
|
|
Official Website: https://www.shipofharkinian.com/
|
|
|
|
## 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 Support text channels. Please keep in mind that we do not condone piracy.
|
|
|
|
# Quick Start
|
|
|
|
The Ship does not include any copyrighted assets. You are required to provide a supported copy of the game.
|
|
|
|
### 1. Verify your ROM dump
|
|
You can verify you have dumped a supported copy of the game by using the compatibility checker at https://ship.equipment/. If you'd prefer to manually validate your ROM dump, you can cross-reference its `sha1` hash with the hashes [here](docs/supportedHashes.json).
|
|
|
|
### 2. Download The Ship of Harkinian from [Releases](https://github.com/HarbourMasters/Shipwright/releases)
|
|
|
|
### 3. Launch the Game!
|
|
#### Windows
|
|
* Extract the zip
|
|
* Launch `soh.exe`
|
|
|
|
#### Linux
|
|
* Place your supported copy of the game in the same folder as the appimage.
|
|
* Execute `soh.appimage`. You may have to `chmod +x` the appimage via terminal.
|
|
|
|
#### macOS
|
|
* Run `soh.app`. When prompted, select your supported copy of the game.
|
|
* You should see a notification saying `Processing OTR`, then, once the process is complete, you should get a notification saying `OTR Successfully Generated`, then the game should start.
|
|
|
|
#### Nintendo Switch
|
|
* Run one of the PC releases to generate an `oot.otr` and/or `oot-mq.otr` file. After launching the game on PC, you will be able to find these files in the same directory as `soh.exe` or `soh.appimage`. On macOS, these files can be found in `/Users/<username>/Library/Application Support/com.shipofharkinian.soh/`
|
|
* Copy the files to your sd card
|
|
```
|
|
sdcard
|
|
└── switch
|
|
└── soh
|
|
├── oot-mq.otr
|
|
├── oot.otr
|
|
├── soh.nro
|
|
└── soh.otr
|
|
```
|
|
* Launch via Atmosphere's `Game+R` launcher method.
|
|
|
|
### 4. Play!
|
|
|
|
Congratulations, you are now sailing with the Ship of Harkinian! 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 |
|
|
| F5 | Save state |
|
|
| F6 | Change state |
|
|
| F7 | Load state |
|
|
| F9 | Toggle Text-to-Speech (Windows and Mac only) |
|
|
| F11 | Fullscreen |
|
|
| Tab | Toggle Alternate assets |
|
|
| Ctrl+R | Reset |
|
|
|
|
# Project Overview
|
|
Ship of Harkinian (SOH) is built atop a custom library dubbed libultraship (LUS). Back in the N64 days, there was an SDK distributed to developers named libultra; LUS is designed to mimic the functionality of libultra on modern hardware. In addition, we are dependant on the source code provided by the OOT decompilation project.
|
|
|
|
In order for the game to function, you will require a **legally aquired** ROM for Ocarina of Time. Click [here](https://ship.equipment/) to check the compatability of your specific rom. Any copyrighted assets are extracted from the ROM and reformated as a .otr archive file which the code uses.
|
|
|
|
### 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 `shipofharkinian.json` file by finding the line `gfxbackend:""` and changing the value to `sdl` for OpenGL. DirectX 11 is the default on Windows.
|
|
|
|
# Custom Assets
|
|
|
|
Custom assets are packed in `.otr` archive files. To use custom assets, place them in the `mods` folder.
|
|
|
|
If you're interested in creating and/or packing your own custom asset `.otr` files, check out the following tools:
|
|
* [**retro - OTR generator**](https://github.com/HarbourMasters64/retro)
|
|
* [**fast64 - Blender plugin**](https://github.com/HarbourMasters/fast64)
|
|
|
|
# Development
|
|
### Building
|
|
|
|
If you want to manually compile SoH, please consult the [building instructions](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.
|
|
|
|
* [Windows](https://nightly.link/HarbourMasters/Shipwright/workflows/generate-builds/develop/soh-windows.zip)
|
|
* [macOS](https://nightly.link/HarbourMasters/Shipwright/workflows/generate-builds/develop/soh-mac.zip)
|
|
* [Linux](https://nightly.link/HarbourMasters/Shipwright/workflows/generate-builds/develop/soh-linux.zip)
|
|
|
|
### Further Reading
|
|
More detailed documentation can be found in the 'docs' directory, including the afformentioned [building instructions](docs/BUILDING.md).
|
|
|
|
*[Credits](docs/CREDITS.md)
|
|
*[Custom Music](docs/CUSTOM_MUSIC.md)
|
|
*[Controler Maping](docs/GAME_CONTROLLER_DB.md)
|
|
*[Modding](docs/MODDING.md)
|
|
*[Versioning](docs/VERSIONING.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>
|