Skip to content

Commit 2b0af54

Browse files
Readme stuff (#313)
* Fixed Gyroscopy Settings & Drift * readme stuff
1 parent 90f849d commit 2b0af54

3 files changed

Lines changed: 58 additions & 39 deletions

File tree

BUILDING.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
## Windows
44

5-
1. Install [Python](https://www.python.org/ftp/python/3.10.2/python-3.10.2-amd64.exe)
5+
1. Install [Python](https://www.python.org/downloads/) >= 3.6.
66
2. Install [Visual Studio 2022 Community Edition](https://visualstudio.microsoft.com/vs/community/)
7-
2b. In the Visual Studio Installer, install `MSVC v142 - VS 2019 C++`.
7+
3. In the Visual Studio Installer, install `MSVC v142 - VS 2019 C++`.
88
4. Clone the Ship of Harkinian repository.
99
5. Place one or more [compatible](#compatible-roms) roms in the `OTRExporter` directory with namings of your choice.
1010
6. Run `OTRExporter/OTRExporter.sln`.
@@ -51,3 +51,16 @@ make -j $(nproc) OPTFLAGS=-O0 DEBUG=0
5151
OOT_PAL_GC checksum 0x09465AC3
5252
OOT_PAL_GC_DBG1 checksum 0x871E1C92 (debug non-master quest)
5353
```
54+
55+
# OTRExporter Usage
56+
57+
The OTRExporter exports an `oot.otr` archive file which Ship of Harkinian requires to play.
58+
59+
Use the `extract_assets.py` script file to run the exporter using any of the following methods:
60+
61+
1. Double click on the script after placing one or more roms in the directory.
62+
2. Drag & Drop a rom onto the script.
63+
3. In a terminal run `python3 extract_assets.py` after placing one or more roms in the directory.
64+
4. In a terminal run `python3 extract_assets.py <path_to_rom>`
65+
66+
If the script finds multiple roms the user is prompted which to use. Selection is done using the number keys and then pressing the carriage return key.

README.md

Lines changed: 42 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The Ship does not include assets and as such requires a prior copy of the game t
66

77
## Quick Start
88

9-
1) Download The Ship of Harkinian from Discord.
9+
1) Download The Ship of Harkinian from [Discord](https://discord.com/invite/BtBmd55HVH).
1010
2) Requires a supported copy of the game (See supported games below).
1111
3) Use the OTRGui to generate an `oot.otr` archive file.
1212
4) Launch `soh.exe`
@@ -18,9 +18,9 @@ Build team: `zelda@srd022j`
1818
Build date: `03-02-21 00:49:18` (year-month-day)
1919
sha1: cee6bc3c2a634b41728f2af8da54d9bf8cc14099
2020
```
21-
Ocarina of Time Pal Gamecube
21+
Ocarina of Time PAL GameCube
2222
```
23-
sha1: d0c95b2cb3c6682a171db267932af7af8cf5fa82
23+
sha1: 0227d7c0074f2d0ac935631990da8ec5914597b4
2424
```
2525

2626
Congratulations, you are now sailing with the Ship of Harkinian! Have fun!
@@ -67,39 +67,45 @@ Refer to the [building instructions](BUILDING.md) to compile SoH.
6767

6868
## The Harbour Masters Are...
6969

70-
Kenix | Lead Developer/Public Relations - Resource Management Programmer, Audio System Programmer, and General Programmer
71-
Jack Walker | Lead Developer - OTR Format Programmer, Resource Load Programmer, and General Programmer
72-
Louist103 | Developer - Save System Programmer and General Programmer
73-
Emil | Developer - Fast3D Programmer
74-
m4xw | Developer - Shipwright, Throwing Baguettes, and General Programmer
75-
MelonSpeedruns | Developer - General Programmer
76-
Rozlette | Developer - General Programmer
77-
JoshDuMan | Developer - General Programmer
78-
KiritoDev/Lywx | Developer - General Programmer
79-
Theo3 | Developer - General Programmer
80-
Random06457 | Developer - Linux Build
70+
Kenix | Lead Developer/Public Relations - Resource Management Programmer, Audio System Programmer, and General Programmer
71+
Jack Walker | Lead Developer - OTR Format Programmer, Resource Load Programmer, and General Programmer
72+
Louist103 | Developer - Save System Programmer and General Programmer
73+
Emil | Developer - Fast3D Programmer
74+
m4xw | Developer - Shipwright, Throwing Baguettes, and General Programmer
75+
MelonSpeedruns | Developer - General Programmer
76+
Rozlette | Developer - General Programmer
77+
JoshDuMan | Developer - General Programmer
78+
KiritoDev/Lywx | Developer - General Programmer
79+
Theo3 | Developer - General Programmer
80+
Random06457 | Developer - Linux Build
8181

8282
## Special Thanks
8383

84-
Decomp & ZAPD | Made this project even possible in the first place!
85-
MNGoldenEagle | Patiently explained audio data formats, encouragement, and founding ZSO which was the first source of the game's code and resource format documentation.
86-
Rrrrry123 | Speedbunner, encouragement, and community moderation
87-
Fierce deity | Encouragement and community moderation
88-
mzxrules | For his contributions to decomp
89-
zel. | For his contributions to decomp
90-
Aloxado | Developer - General Programmer
91-
MegaMech | Developer - General Programmer
92-
Revo | Tester - GCC support and General Testing
93-
zfg | Tester - General Testing
94-
Horseless Headman | Tester - General Testing
95-
Steven Pritchett | Tester - General Testing
96-
Trenton May | Tester - General Testing
97-
Zeldaboy14 | Tester - General Testing, encouragement, and community moderation
98-
Koby Howell | Tester - General Testing
99-
Logg | Tester - General Testing
100-
Taylor Daley | Graphic Design
101-
Can't Sleep | Graphic Design
102-
MicTheMicrophone | Voice actor for the King
103-
Amphibibro | Voice actor for Link
104-
105-
Lemons
84+
Decomp & ZAPD | Made this project even possible in the first place!
85+
MNGoldenEagle | Patiently explained audio data formats, encouragement, and founding ZSO which was the first source of the game's code and resource format documentation.
86+
Rrrrry123 | Speedbunner, encouragement, and community moderation
87+
Fierce deity | Encouragement and community moderation
88+
mzxrules | For his contributions to decomp
89+
zel. | For his contributions to decomp
90+
Aloxado | Developer - General Programmer
91+
MegaMech | Developer - General Programmer
92+
Revo | Tester - GCC support and General Testing
93+
zfg | Tester - General Testing
94+
Horseless Headman | Tester - General Testing
95+
Steven Pritchett | Tester - General Testing
96+
Trenton May | Tester - General Testing
97+
Zeldaboy14 | Tester - General Testing, encouragement, and community moderation
98+
Koby Howell | Tester - General Testing
99+
Logg | Tester - General Testing
100+
Taylor Daley | Graphic Design
101+
Can't Sleep | Graphic Design
102+
103+
## Video Credits
104+
Kenix | Producer / Writer
105+
rainbow_fash | Executive Producer
106+
TheLegendOfXela | Editor
107+
MicTheMicrophone | Gwonam / The King
108+
Amphibibro | Link
109+
AceHeart | Zelda
110+
111+
###### Lemons

soh/src/boot/build.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
const char gBuildVersion[] = "DECKARD ALFA (1.0.0)";
1+
const char gBuildVersion[] = "ROY ALFA (2.0.0)";
22
const char gBuildTeam[] = "github.com/harbourmasters";
33
const char gBuildDate[] = __DATE__ " " __TIME__;
44
const char gBuildMakeOption[] = "";

0 commit comments

Comments
 (0)