README

!Ship of Harkinian
!Ship of Harkinian

 Website
 Discord

If you're having any trouble after reading through this README, feel free to 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.

 2. Download The Ship of Harkinian from Releases

 3. Launch the Game!
 Windows
 Extract the zip
 Launch soh.exe

 Linux
 Execute soh.appimage.  You may have to chmod +x the appimage via terminal.
 When prompted, select your supported copy of the game.
 Saves, settings and oot.o2r are stored in ~/.local/share/soh/. If the folder you launch from already has shipofharkinian.json, oot.o2r or oot-mq.o2r, that folder is used instead. Set SHIP_HOME to choose another folder.

 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.

 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 |
| - | - |
| ESC | Toggle menu |
| F2 | Toggle capture mouse input |
| F5 | Save state |
| F6 | Change state |
| F7 | Load state |
| F9 | Toggle Text-to-Speech |
| 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 dependent on the source code provided by the OOT decompilation project.

In order for the game to function, you will require a legally acquired ROM for Ocarina of Time. Click here to check the compatibility of your specific rom. Any copyrighted assets are extracted from the ROM and reformatted as a .o2r 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 asse

Top issues

Latest release

Download

  
    
    
  


  
    
    
  


  
    
    
  


 Setup Guide
https://www.shipofharkinian.com/setup-guide

 Changes
Relatively quiet patch release from 9.3.0 release feedback. Fixed typos, couple crashes, couple logic gaps, & cleaned up UX around wincon revamp. Last of which is particularly important for races

 What's Changed


 Fix name of Fire Trial silver rupee by @f1ana in https://github.com/HarbourMasters/Shipwright/pull/7328
 Unfreeze Link on forced text skip by @f1ana in https://github.com/HarbourMasters/Shipwright/pull/7338
 Show message w