github/Shipwright
1
0
Fork 0
mirror of https://github.com/HarbourMasters/Shipwright.git synced 2025-08-20 21:33:40 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
TAKStation 2022-04-05 06:51:24 +04:30 • committed by GitHub
commit 918250f1f5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -1,12 +1,13 @@
# Welcome to the Ship of Harkinian! # Welcome to the Ship of Harkinian - TAK Edition!
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! A Modification of the PC port of OoT
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 does not include assets and as such requires a prior copy of the game to play.
## Quick Start ## Quick Start
1) Download The Ship of Harkinian from Discord. 1) Download The Ship of Harkinian from Releases
2) Requires an `oot debug` rom (not Master Quest). 2) Requires an `oot debug` rom (not Master Quest).
``` ```
Build team: `zelda@srd022j` Build team: `zelda@srd022j`
@ -14,26 +15,23 @@ Build date: `03-02-21 00:49:18` (year-month-day)
sha1: cee6bc3c2a634b41728f2af8da54d9bf8cc14099 sha1: cee6bc3c2a634b41728f2af8da54d9bf8cc14099
``` ```
3) Use the OTRGui to generate an `oot.otr` archive file. 3) Use the OTRGui to generate an `oot.otr` archive file.
4) Launch `soh.exe` 4) Use patch otr files and put them in "mods" folder.
5) Launch `soh.exe`
Congratulations, you are now sailing with the Ship of Harkinian! Have fun! Congratulations, you are now sailing with the Ship of Harkinian! Have fun!
## 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 ### The Extraction Tool
* Open a rom to initiate generating the `oot.otr` archive file. * 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. * 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. * When the process completes, place `oot.otr` beside `soh.exe` if it is not already.
This packaging process can take up to **5 minutes**. This packaging process can take up to **5-10 minutes**.
Close the OTRGui when the `Done!` message appears. 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 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. Keep-in-mind that we do not condone piracy in any way.
### Running The Ship of Harkinian ### Running The Ship of Harkinian
@ -41,14 +39,6 @@ Launch the game. If the window immediately closes, or if there are visual artifa
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. 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.
## Discord
Official Discord: https://discord.com/invite/BtBmd55HVH
## Building The Ship of Harkinian ## Building The Ship of Harkinian
1. Install [Python](https://www.python.org/ftp/python/3.10.2/python-3.10.2-amd64.exe) 1. Install [Python](https://www.python.org/ftp/python/3.10.2/python-3.10.2-amd64.exe)