forked from HarbourMasters/Shipwright
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request HarbourMasters#58 from MelonSpeedruns/readme-changes
README + Remove the need to copy the "packages" folder
- Loading branch information
Showing
2 changed files
with
112 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| # Welcome to the Ship! | ||
|
|
||
| The Ship of Harkinian is a PC port of OoT that will allow you to enjoy the game with modern controls, enhanced resolution, and a bunch of other features! It is designed to be very simple to setup, so let's get started! | ||
|
|
||
| # Requirements | ||
|
|
||
| The Ship of Harkinian cannot be played by itself. It needs assets from an OoT ROM to be able to run. To get the needed assets, we're going to need a tool that's going to do all the work for you. | ||
|
|
||
| The OTRGUI tool was made with simplicity in mind, all while having a classy look! To use the OTRGUI tool, you will be needing a few things. | ||
|
|
||
| ### Here's what's needed to run the Ship of Harkinian: | ||
|
|
||
| - The latest version of the Ship of Harkinian. ([Available here](https://www.google.com/)) | ||
| - The OTRGUI tool itself! ([Available here](https://www.google.com/)) | ||
| - A 2020 OoT Debug ROM that's ***NOT*** Master Quest. | ||
|
|
||
| The build date for the ROM should be: `zelda@srd022j 03-02-21 00:49:18` | ||
|
|
||
| When downloading the Ship of Harkinian, you might be confused by the version numbers we have, so here's how it works: You might see a familiar name from a sci-fi movie, along with a color. The name represents a **Major** release version, which is updated when we release a big update with lots of new features and bug fixes. The color represents a **Minor** release version, which is updated when we release a small update, mostly comprised of bug fixes. | ||
|
|
||
| ## Extracting the Ship of Harkinian | ||
|
|
||
| The Ship of Harkinian tool will be 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 simple to use interface. | ||
| There will be 2 buttons: | ||
|
|
||
| - Open OoT Rom | ||
| - Open Ship Folder | ||
|
|
||
| We'll 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 2020 OoT Debug ROM that you have obtained legitimately. Simple double click on the file, and the window 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---- | ||
|
|
||
| After that, a commandline 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 for you. | ||
|
|
||
| The whole process can take up to 5 minutes. Depending on your PC specs, this process might 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. | ||
|
|
||
| ## 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. | ||
|
|
||
| Congraluations, you are now sailing with the Ship of Harkinian! Have fun! | ||
|
|
||
| # Building the Ship of Harkinian | ||
|
|
||
| Please only follow those steps if you're a developer planning on helping with the project. | ||
|
|
||
| 1. Install [Python](https://www.python.org/ftp/python/3.10.2/python-3.10.2-amd64.exe) | ||
| 2. Install [Visual Studio 2022 Community Edition](https://visualstudio.microsoft.com/vs/community/) | ||
| 3. Clone the Ship of Harkinian repository. | ||
| 4. Put your 2020 OoT Debug ROM in the `soh` folder. | ||
| 5. Launch `fixbaserom.py` from the `soh` folder with the following command: `python3 fixbaserom.py`. | ||
| 6. Launch `extract_baserom.py` from the `soh` folder with the following command: `python3 extract_baserom.py`. | ||
| 7. Copy the `baserom` folder from the `soh` folder into the `OTRExporter` folder. | ||
| 8. Run `OTRExporter.sln`. | ||
| 9. Switch the solution to `Release x64`. | ||
| 10. Build the solution. | ||
| 11. Double click on `extract_assets.py` in the `OTRExporter` folder. | ||
| 12. Run `soh.sln` | ||
| 13. Switch the solution to `Release x86`. | ||
| 14. Build the solution. | ||
| 15. Copy the `oot.otr` file from the `OTRExporter` folder into the `Release` folder of the `soh` folder | ||
| 16. Launch `soh.exe`. | ||
|
|
||
| # The harbour masters are... | ||
|
|
||
| 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 | ||
| Louist | 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 | ||
| mzxrules | For his contributions to decomp | ||
| KiritoDev/Lywx | Developer - General Programmer | ||
| Aloxado | Developer - General Programmer | ||
| Theo3 | Developer - General Programmer | ||
| MegaMech | Developer - General Programmer | ||
| Random | Developer - Linux Build | ||
|
|
||
| # Special Thanks | ||
|
|
||
| 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 | Encouragement and community moderation | ||
| Zeldaboy14 | Encouragement and community moderation | ||
| Fierce deity | Encouragement and community moderation | ||
| MicTheMicrophone | Voice actor for the King | ||
| Amphibibro | Voice actor for Link |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters