Go to file
Christopher Leggett bf0935a5a2
Gravedigging tour fix (#388)
* Fixes the Gravedigging Tour heartpiece bug.

Basically just causes Dampe's Gravedigging Tour Heart Piece to set a Collect flag on the Graveyard Scene when collected instead of a GetItemInf flag when it's spawned. I did this by simply the result of Item_DropCollectible to a variable called reward and running reward->collectibleFlag = 0x19 if the reward was a heartpiece.

There may be a better way to do this. This is unlike most of the other dropped items with collectible flags in the game, which have some binary operations performed on the item to be dropped before passing it into Item_DropCollectible. See z_en_geldb.c and z_bg_haka_tubo.c for examples of this. I tried to find some way to do something more like that here but I was unable to wrap my head around the binary operations being performed. I may revisit this in the future.

* Reimplements vanilla bug, adds cvar and checkbox for the fix.

* Adds some newlines to the Tooltip

* Shortens ImGui tooltip.

* Removes the hardcoded Purple Rupee/Heart Piece reward.

* Sets collectibleFlag whether cvar is on or not to prevent duping.

* Sets Gravedigging Tour Fix to enabled by default

* Simplifies logic for whether or not to spawn heart piece

* Adds TempClear flag set and check for heart piece.

This originally introduced a bug where the player could spawn multiple
heart pieces by simply not collecting the one that spawns and continuing
to dig up spots. This fixes that by checking a temp clear flag before
spawning the heart piece and setting it when the heart piece spawns.

Since this is a temp clear flag it will not stay set if the player
exits the scene, so this still does fix the bug of locking the
player out of the heart piece when spawning it and leaving without
picking it up.

As far as I can tell this temp clear flag isn't used anywhere else
in this scene. The only one used in this scene I could find is that
killing the first Poe in this scene sets flag 0x02 (or maybe it's
0x01, not sure if the flags start at 1 or 0).

* Replaces magic numbers with constants defined in z_en_tk.h

* Updates comment explaining changed code.

* Replaces another magic number I forgot to replace last commit.

* Replaces TempClear flag with local variable

* Removes TempClearFlag const and moves others out of .h to .c (felt like they made more sense there)
2022-06-16 20:36:13 -04:00
OTRExporter Additional fixes 2022-06-16 20:35:52 -04:00
OTRGui Corrects tooltip on otrgui (#305) 2022-05-12 20:46:05 -04:00
StormLib Fixed StormLib Forward Slash BackSlash issues 2022-06-16 20:35:52 -04:00
ZAPDTR GC PAL Audio XML 2022-06-16 20:35:52 -04:00
libultraship Gravedigging tour fix (#388) 2022-06-16 20:36:13 -04:00
soh Gravedigging tour fix (#388) 2022-06-16 20:36:13 -04:00
.gitignore Linux/GCC Support (#28) 2022-05-11 13:18:24 -04:00
BUILDING.md https for cloning repo (#415) 2022-06-06 19:23:29 -04:00
Dockerfile Linux/GCC Support (#28) 2022-05-11 13:18:24 -04:00
Jenkinsfile Get rid of timeout 2022-05-11 16:02:22 -04:00
README.md Add control/hotkey info to README (#193) 2022-06-11 12:05:51 -04:00

README.md

Welcome to the Ship of Harkinian!

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!

The Ship does not include assets and as such requires a prior copy of the game to play.

Quick Start

  1. Download The Ship of Harkinian from Discord.
  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)

Currently the recommended option

Build team: `zelda@srd022j`
Build date: `03-02-21 00:49:18` (year-month-day)
sha1: cee6bc3c2a634b41728f2af8da54d9bf8cc14099

Ocarina of Time PAL GameCube

May lead to crashes and instability

sha1: 0227d7c0074f2d0ac935631990da8ec5914597b4

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

  • 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.

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 still cannot get the tool to work, join our Discord Server and ask for help in the #support text channel. Keep-in-mind that we do not condone piracy in any way.

Running The Ship of Harkinian

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.

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)

Currently, DirectX 11 and OpenGL are 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 to increase chances of this becoming reality.

Discord

Official Discord: https://discord.com/invite/BtBmd55HVH

Building The Ship of Harkinian

Refer to the building instructions to compile SoH.

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

Nightly Builds

Nightly builds of Ship of Harkinian are available here

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
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

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 | 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
rainbow_fash | Executive Producer
ReveriePass | Editor
MicTheMicrophone | Gwonam / The King
Amphibibro | Link
AceHeart | Zelda
Lemons