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

Clarify recommendation wording in README.md

Browse source
This commit is contained in:
mightypanders 2022-05-14 20:52:55 +02:00
commit 7c3d81d9c0
1 changed files with 33 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -6,24 +6,30 @@ The Ship does not include assets and as such requires a prior copy of the game t
## Quick Start
1) Download The Ship of Harkinian from [Discord](https://discord.com/invite/BtBmd55HVH).
2) Requires a supported copy of the game (See supported games below).
3) Use the OTRGui to generate an `oot.otr` archive file.
4) Launch `soh.exe`
1. Download The Ship of Harkinian from [Discord](https://discord.com/invite/BtBmd55HVH).
2. Requires a supported copy of the game (See supported games below).
3. Use the OTRGui to generate an `oot.otr` archive file.
4. Launch `soh.exe`
### Supported Games
Ocarina of Time Debug (not Master Quest)
#### Ocarina of Time Debug (not Master Quest)
> Currently the recommended option
```
Build team: `zelda@srd022j`
Build date: `03-02-21 00:49:18` (year-month-day)
sha1: cee6bc3c2a634b41728f2af8da54d9bf8cc14099
```
> Currently the recommended option
Ocarina of Time PAL GameCube
#### Ocarina of Time PAL GameCube
> May lead to crashes and instability
```
sha1: 0227d7c0074f2d0ac935631990da8ec5914597b4
```
> May lead to crashes
Congratulations, you are now sailing with the Ship of Harkinian! Have fun!
@ -33,9 +39,9 @@ The Ship of Harkinian uses a proprietary versioning system consisting of a sci-f
### 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.
- 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**.
@ -51,6 +57,7 @@ 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.
## 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.
@ -63,10 +70,10 @@ Official Discord: https://discord.com/invite/BtBmd55HVH
Refer to the [building instructions](BUILDING.md) to compile SoH.
## Troubleshooting The Exporter
- Affirm that you have an `/assets` folder filled with XMLs in the same directory as OTRGui.exe
- Affirm that `zapd.exe` exists in the `/assets/extractor` folder
## The Harbour Masters Are...
Kenix | Lead Developer/Public Relations - Resource Management Programmer, Audio System Programmer, and General Programmer
@ -103,6 +110,7 @@ Refer to the [building instructions](BUILDING.md) to compile SoH.
Can't Sleep | Graphic Design
## Video Credits
Kenix | Producer / Writer
rainbow_fash | Executive Producer
TheLegendOfXela | Editor