Shipwright/README.md

177 lines
8.3 KiB
Markdown
Raw Normal View History

2022-03-21 22:16:08 -04:00
# Welcome to the Ship of Harkinian!
2022-03-22 17:10:35 -04:00
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!
2022-03-21 22:16:08 -04:00
2022-03-22 17:10:35 -04:00
The Ship does not include assets and as such requires a prior copy of the game to play.
2022-03-21 22:16:08 -04:00
## Quick Start (Windows)
2022-03-21 22:16:08 -04:00
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 PAL GC (not Master Quest)
> Currently the recommended option
2022-03-22 17:10:35 -04:00
```
2022-03-23 01:00:02 -04:00
Build team: `zelda@srd022j`
Build date: `03-02-21 00:49:18` (year-month-day)
2022-03-22 17:10:35 -04:00
sha1: cee6bc3c2a634b41728f2af8da54d9bf8cc14099
```
#### Ocarina of Time PAL GameCube
> May lead to crashes and instability
```
sha1: 0227d7c0074f2d0ac935631990da8ec5914597b4
```
#### Ocarina of Time Debug PAL GC MQ (Dungeons will be Master Quest)
```
Build team: `zelda@srd022j`
Build date: `03-02-21 00:16:31` (year-month-day)
sha1: 079b855b943d6ad8bd1eb026c0ed169ecbdac7da (Produced by decomp)
sha1: 50bebedad9e0f10746a52b07239e47fa6c284d03 (Alternate)
```
2022-03-21 22:16:08 -04:00
2022-03-22 17:10:35 -04:00
Congratulations, you are now sailing with the Ship of Harkinian! Have fun!
2022-03-21 22:16:08 -04:00
2022-03-22 17:10:35 -04:00
## Additional Setup Information
2022-03-21 22:16:08 -04:00
2022-03-22 17:10:35 -04:00
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`.
2022-03-21 22:16:08 -04:00
### Windows Rom Extraction
2022-03-21 22:16:08 -04:00
* Open OTRGui.exe, and select one of the supported roms listed above, to generate the `oot.otr` archive file.
* If a second button already exits 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.
2022-03-22 17:10:35 -04:00
* When the process completes, place `oot.otr` beside `soh.exe` if it is not already.
2022-03-21 22:16:08 -04:00
2022-03-22 17:10:35 -04:00
This packaging process can take up to **5 minutes**.
2022-03-21 22:16:08 -04:00
2022-03-22 17:10:35 -04:00
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.
2022-03-21 22:16:08 -04:00
### Linux Rom Extraction
* Place one of the supported roms in the same folder as the appimage.
* When you run the soh appimage, it should begin generating the `oot.otr` archive file.
* When the process completes, place `oot.otr` in the same folder as the appimage, if it is not already, then run the appimage.
The packaging process can take up to **5 minutes**.
If you get any errors, then you might have selected the wrong rom. Make sure to use a rom consistent with the above checksum.
### MacOS Rom Extraction
* Run `soh.app`, and when prompted, select one of the supported roms listed above.
* 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.
The packing process can take up to **5 minutes**.
If you get an error saying `Incompatible ROM hash`, you have selected the wrong rom, make sure the checksum matches one of the ones listed above.
### Nintendo Switch Rom Extraction
* Download the latest PC release of the Ship of Harkinian, and follow the instructions above for generating the `oot.otr` archive on that platform.
* Place the `.nro` and the `oot.otr` archive into a folder called `soh` in your Switch folder on your Switch
### Nintendo Wii U Rom Extraction
* Download the latest PC release of the Ship of Harkinian, and follow the instructions above for generating the `oot.otr` archive on that platform.
* Copy the `.rpx` and the `oot.otr` archive to `wiiu/apps/soh`
---
2022-03-22 17:10:35 -04:00
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.
2022-03-21 22:16:08 -04:00
2022-03-22 17:10:35 -04:00
### Running The Ship of Harkinian
2022-03-21 22:16:08 -04:00
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.
2022-03-21 22:16:08 -04:00
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 |
| F10 | Fullscreen (OpenGL) |
| Alt+Enter | Fullscreen (DirectX) |
2022-06-28 08:57:42 -04:00
| Ctrl+R | Reset |
2022-07-18 19:24:20 -04:00
Currently, DirectX 11 and OpenGL are supported. Change the renderer by opening the `shipofharkinian.json` configuration file in notepad and add `sdl` to the quotes in `"GfxBackend": ""` for OpenGL or leave blank for DirectX.
2022-03-21 22:16:08 -04:00
2022-03-22 17:10:35 -04:00
## 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.
2022-03-21 22:16:08 -04:00
2022-03-22 17:10:35 -04:00
## Discord
2022-03-21 22:16:08 -04:00
2022-03-22 17:10:35 -04:00
Official Discord: https://discord.com/invite/BtBmd55HVH
2022-03-21 22:16:08 -04:00
2022-03-22 17:10:35 -04:00
## Building The Ship of Harkinian
2022-03-21 22:16:08 -04:00
Refer to the [building instructions](BUILDING.md) to compile SoH.
2022-11-07 14:34:03 -05:00
## Getting CI to work on your fork
The CI works via [Github Actions](https://github.com/features/actions) where we mostly make use of machines hosted by Github; except for the very first step of the CI process called "Extract assets". This steps extracts assets from the game file and generates an "assets" folder in `soh/`.
To get this step working on your fork, you'll need to add a machine to your own repository as a self-hosted runner via "Settings > Actions > Runners" in your repository settings. If you're on macOS or Linux take a look at `macports-deps.txt` or `apt-deps.txt` to see the dependencies expected to be on your machine. For Windows, deps get installed as part of the CI process. To setup your runner as a service read the docs [here](https://docs.github.com/en/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service?platform=linux).
2022-03-22 17:10:35 -04:00
## Troubleshooting The Exporter
- Confirm that you have an `/assets` folder filled with XMLs in the same directory as OTRGui.exe
- Confirm that `zapd.exe` exists in the `/assets/extractor` folder
2022-03-21 22:16:08 -04:00
## Nightly Builds
Nightly builds of Ship of Harkinian are available [here](https://builds.shipofharkinian.com/)
2022-03-21 22:16:08 -04:00
2022-03-22 17:10:35 -04:00
## The Harbour Masters Are...
2022-03-21 22:16:08 -04:00
Kenix | Lead Developer/Public Relations - Resource Management Programmer, Audio System Programmer, and General Programmer
Jack Walker | Lead Developer - OTR Format Programmer, Resource Load Programmer, and General Programmer
Louist103 | Developer - Save System Programmer and General Programmer
Emil | Developer - Fast3D Programmer
m4xw | Developer - Shipwright, Throwing Baguettes, and General Programmer
MelonSpeedruns | Developer - General Programmer
Rozlette | Developer - General Programmer
JoshDuMan | Developer - General Programmer
KiritoDev/Lywx | Developer - General Programmer
Theo3 | Developer - General Programmer
Random06457 | Developer - Linux Build
2022-03-21 22:16:08 -04:00
2022-03-22 17:10:35 -04:00
## Special Thanks
2022-03-21 22:16:08 -04:00
Decomp & ZAPD | Made this project even possible in the first place!
MNGoldenEagle | Patiently explained audio data formats, encouragement, and founding ZSO which was the first source of the game's code and resource format documentation.
Rrrrry123 | Speedbunner, encouragement, and community moderation
Fierce deity | Encouragement and community moderation
mzxrules | For his contributions to decomp
zel. | For his contributions to decomp
Aloxado | Developer - General Programmer
MegaMech | Developer - General Programmer
Revo | Tester - GCC support and General Testing
zfg | Tester - General Testing
Horseless Headman | Tester - General Testing
Steven Pritchett | Tester - General Testing
Trenton May | Tester - General Testing
Zeldaboy14 | Tester - General Testing, encouragement, and community moderation
Koby Howell | Tester - General Testing
Logg | Tester - General Testing
Taylor Daley | Graphic Design
Can't Sleep | Graphic Design
## Video Credits
Kenix | Producer / Writer
2022-09-19 23:27:16 -04:00
briaguya | Writer
rainbow_fash | Executive Producer
2022-06-09 17:26:41 -04:00
ReveriePass | Editor
MicTheMicrophone | Gwonam / The King
Amphibibro | Link
AceHeart | Zelda