A PC port of OoT allowing you to enjoy the game with modern controls, enhanced resolution, and a bunch of new features! Setup is simple, let's get started!
A PC port of OoT allowing you to enjoy the game with modern controls, widescreen, high-resolution, gyroscopy and other great features! Setup is simple, let's get started!
The Ship does not include assets and as such requires a prior copy of the game to play.
The Ship of Harkinian cannot be played by itself. It needs assets from an OoT ROM to run. We have a special tool that extracts these assets for you. To use it, you will need a few things.
### Here's what's needed to run the Ship of Harkinian:
- The Ship of Harkinian: ([Available here](https://github.com/HarbourMasters/Shipwright/releases/latest))
- A ZRET OoT Debug ROM.
## Quick Start
1) Download [The Ship of Harkinian](https://github.com/HarbourMasters/Shipwright/releases/latest) from releases.
2) Get a ZRET OoT Debug ROM
Build date: `zelda@srd022j 03-02-21 00:49:18`
The Ship of Harkinian uses a proprietary versioning system consisting of a sci-fi film name and a color. The motion-picture name represents a **Major** release version which increments with the addition of many new features and bug fixes. The color represents a **Minor** release version which increments with small updates mainly comprised of bug fixes.
## Extracting the Ship of Harkinian
The Ship of Harkinian is packed in a `.zip` file. It is ***paramount*** that you extract that `.zip` file. We recommend extracting its contents somewhere safe, like in a folder on your Desktop.
Once that is done, we are going to run the OTRGUI tool, which will allow us to extract the needed assets from an OoT ROM. Doing this will allow us to play the Ship of Harkinian.
## Using the extraction tool
Launch `OTRGui.exe` by double-clicking it. Once the OTRGUI tool has launched, you will be met with a classy, yet easy-to-use interface.
There will be 2 buttons:
- Open OoT Rom
- Open Ship Folder
Start by clicking on `Open OoT Rom`. After doing that, a window should open, asking you to open an OoT ROM. Simply navigate through your folders and find your ZRET OoT Debug ROM that you have obtained legitimately. Simply double-click on the file, and the prompt should close.
After that, click on `Open Ship Folder`. Another window will open, but this time, it will ask you to select a folder. Simply select the folder that you extracted from the Ship of Harkinian `.zip` file.
After that, a command-line window should open. Don't worry, this is perfectly normal. The tool will proceed to extract the assets from the ROM and compile them into a format the Ship of Harkinian can understand.
The whole process can take up to **5 minutes**. Depending on your PC specs, this process may be shorter.
After that, a `Done!` message should show up. At that point, simply press on the `X` of the OTRGUI tool at the top-right.
If you get another message, then you might have selected a wrong ROM. Simply retry again with another ROM.
If you still cannot get the tool to work, join our [Discord Server](https://discord.com/invite/BtBmd55HVH) and ask for help in the `#support` text channel. Keep in mind that we do not condome piracy in any way.
## Running the Ship of Harkinian
Simply double-click on `soh.exe` to launch the game. If the window immediately closes, or if there are visual artifacts, you might have selected a wrong ROM in the OTRGUI tool. Simply retry again with another ROM.
3) Use the OTRGui to generate an `oot.otr` archive file.
4) Launch `soh.exe`
Congratulations, you are now sailing with the Ship of Harkinian! Have fun!
# Building the Ship of Harkinian
## Additional Setup Information
The Ship of Harkinian uses a proprietary versioning system consisting of a sci-fi film character followed by a phonetic alphabet code word. The film character represents a major release version which increments with the addition of many new features and bug fixes. The code word represents a minor release version which increments with small updates mainly comprised of bug fixes. For example, `DECKARD ALFA`.
### The Extraction Tool
* Open a rom to initiate generating the `oot.otr` archive file.
* If a second button exists then `oot.otr` already exists. To prevent overwriting the old `oot.otr` use this button to choose a new game directory. The new directory must not already contain an `oot.otr` to prevent an error.
* When the process completes, place `oot.otr` beside `soh.exe` if it is not already.
This packaging process can take up to **5 minutes**.
Close the OTRGui when the `Done!` message appears.
If you get another message, then you might have selected the wrong rom. Make sure to use a rom consistent with the above checksum.
If you still cannot get the tool to work, join our [Discord Server](https://discord.com/invite/BtBmd55HVH) and ask for help in the `#support` text channel. Keep-in-mind that we do not condone piracy in any way.
### Running The Ship of Harkinian
Launch the game. If the window immediately closes, or if there are visual artifacts, you may have selected the wrong rom in the OTRGui tool.
Currently, DirectX 11 and OpenGL is supported. Change the renderer by opening the `shipofharkinian.ini` configuration file in notepad and add `sdl` to `gfx backend` for OpenGL or leave blank for DirectX.
## Take The Survey
Want to use cartridge readers in tandem with the OTRGui?
Take [this survey](https://retroarchopenhardware.com/survey.php) to increase chances of this becoming reality.
Official Discord: https://discord.com/invite/BtBmd55HVH