mirror of
https://github.com/HarbourMasters/Shipwright.git
synced 2024-11-26 03:12:18 -05:00
c25089b98f
* skip learning song of storms * don't set flag when getting goron tunic as child * Initiates prelude check when master sword unloads. Not quite how N64 rando does it but so far it's the only way I've found to make it trigger without also triggering the time travel again. * Stops Shadow Temple lore prompts from appearing in rando. * Skips cutscene of royal tomb explosion in rando. Explosion sound doesn't play correctly and I think the debris appears in the wrong place, but the functionality is here. * Improves visual of exploding gravestone. * Adds some comments explaining the rando differences * Skip ruto text box in jabu blue warp For rando * skip intro cutscene in dodongo's cavern * load spoiler files on boot, fix spoilerfile existing check when making new saves * name entry dropped spoiler logic * make sure to actually init the cvar * no chime on load * uncomment * Skip ganondrof cutscene Skip to scream part of the death animation, skipping the text boxes etc. For rando * Update z_boss_ganondrof.c * skip owl flight cutscenes in rando * Fixes skipped text so it only applies to shadow temple. Earlier fix inadvertently applied to some other text as well, changed logic so that only specified sceneNums and textIds can have this enabled, and text skipped by sceneNum can have the skip overriden by textId if needed. Currently there are no overrides so the textId section of the logic is commented out to avoid compilation errors. * Adds a default to the switch case statements that leaves the randoSkipText variable unchanged, just in case. * TEST: Text for item * Adding ganon flavor text * ADD: AMMO Count * format ganon text/hint text * Autoskip the tower cutscene if settings call for tower collapse. * ganon hint text logic * Improved prelude after time travel fix * swapped the sizes between ganon hint text and ganon text, as they were set to the wrong things. * this is all i did * not the cleanest code ever but it's working * ADD: GS Count * ADD: Wallter (crash for now) * TWEAK: Wallet check * FIX: Use DrawItem instread of DrawUpgrade... b-baka! * Fixes some vanilla bugs introduced by rando code. * Added cutscene skip for zelda escaping Using the debug cutscene skipping function. Also added a conditional so the bridge doesn't spawn closed when cutscene is ready to trigger * ADD: X Spacing + Placeholders for song * ADD: default case for items * TWEAK: Spacing * FIX: Light Arrow * ADD: Ammo Option * use groups instead * ADD: More spacing logic * songs and names * TWEAK: Color on wallet * colors * Added flags cutscene before nabooru fight * ADD: ChromaKey text * First attempt skip cs after nabooru defeat * Better implementation for specific rando cutscene skips * use pulseaudio defaults * spaces/tabs * move color push/pop to stop crash * make the colors work again * the real bottle fix * pulseaudio values tuned for n64 audio at 44.1khz * update tlength * remove one hardcoded samplerate * Cleaned up and fixed zelda escape skip The if statement is a freaking monster, but unless we want to skip more cutscenes in the same way later, this is the most compact way of doing it that I know of. * Revert one line to match original nothing functional * another hint line that breaks autonewline logic * don't autospawn epona if we don't have the song/ocarina * Trying to use iron knuckle death effects not working yet * Streamlined OoT cutscene skip for future additions Also cleaned up if statement in general * Made if statement more readable Also added clarity for what cutscene was skipped * Fixed typo in comment * Janky nabooru defeat cs skip * altar text formatting (gonna need help shortening some of the french ones) * more altar text formatting * english altar text formatting complete * make gtg blocking guard check for card not bridge * FIX: Typo! * FIX: Uppercases * FIX: Typo * TWEAK: Alter + some names * TWEAK: More caps! * ADD: Missing string TWEAK more uppercases and namefixe s * Hide nabooru death by covering her in flames * bandaid fix for death crash issue * Twinrova defeat cs skip Skips the animation and manually calls the function to show the "beam" around the sisters * fix crash * fix caps to match * fix great fairy reward mashing/shielding issue * TWEAK : Typo clé to Clé * TWEAK: Some Altar hints TWEAK: Some capitals * TWEAK: Unmatching text + some cap again * TWEAK: More tweaks * fix build * remove extra json.hpp, add hint * Update randomizer_item_tracker.cpp * TWEAK: Double Defense with RedParticles instead of white * make sure we don't optimize out the check to ensure a spoilerfile exists * vanilla ganon boss key hint formatting * TWEAK: FR- better way of the hero text * fix * and again * Initializes dungeonsDone items in gSaveContext to 0. * Replaces sizeof calculation with a NUM_DUNGEONS constant. * Fixes Saria's Gift on the LW Bridge from getting killed when holding shield. * More airtight fix for Saria's Gift on the Bridge. * Lifts one of the conditions in the if statement a little higher to prevent unnecessary lookups of getItemId. * Invalidate text box icon before drawing * Fixes the case where Saria's gift is an Ice Trap. We still get the Ice Trap once, but never again. This does mean you can now hold R while walking in to avoid the ice trap, but everything else seems to work fine. * Initial commit Might need changing when we change the settings in the future * Fixes Door of Time opening cutscene after warping with prelude. * Initial waterfall skip Very rudimentary way of doing things but it seems to work so 🤷 * inital rework * fixed default rotation for 2D sprites * fix tab/space issues * 3d drops rando merge fix again * Allows Impa to appear in the Lullaby check post drawbridge escape. * Changes Ganon's Trials Count setting to a checkbox The checkbox is whether or not to skip all of them. Leaving the box unchecked will mean doing all of them. Eventually this will be switched back to a slider once we implement the logic for which trials start out completed. * Sets all Ganon's Trials to incomplete in new saves. Fixes https://github.com/briaguya-ai/rando-issue-tracker/issues/131 * fix castle guards when oot throw cutscene has already played in rando * Properly removes the beams when trials are cleared. * Removes Question Mark from Skip Ganon's Trials UI. * Adds a todo comment about when to change back to slider. * make deku seeds check for bullet bag * Various tweaks TWEAK: Altar Text TWEAK: Hint names TWEAK: Replace more problematic œ to oe * upgrade ocarina on both child and adult equips * FIX: Jabu Item * update equipped hookshot/longshot when obtained as other age * add hint * don't give the bgs check without the claim check * Skips Darunia Cutscene in Fire Temple * Added a TODO note about not skipping the cutscene. There is a setting we will want to have eventually that will require this cutscene to not be skipped since it is used during a glitch. * remove todo * restore fast ocarina option in imgui that was lost in merge * Fixes grey screen issue + tooltip for 2 handed shield * update to use dg instead of g for textures in item tracker * TWEAK: Default color for cosmetic RAND button was not the corect one * fix texture crash, remove unused item tracker code * don't open mask shop until we get zelda's letter * Update README.md * Prevents "correct" chime under incorrect conditions. * Fixes typo in conditional and adds "bonk" sound effect. "Bonk" sound is NA_SE_SY_OCARINA_ERROR and it plays when conditions for the Door of Time have not been met after playing Song of Time. This is only possible in rando's "Intended" Door of Time option, in which the Ocarina of Time and all 3 spritual stones are required to open the door, instead of the vanilla requirements of just having the song of time. * remove modify dpad equips toggle, replace with checks for dpad menu * remove extra check * add ability to hold c-up to assign to dpad when dpad menuing is enabled * disable d-pad navigation on item menu when holding c-up to equip * dpad+c-up stuff for equipment menu * ADD: Checbox for songs colors * TWEAK: RandoColors for normal songs * kind of quick and dirty but it works * TWEAK: Clarity of the tooltip Co-authored-by: briaguya <briaguya@alice> Co-authored-by: Christopher Leggett <chris@leggett.dev> Co-authored-by: aMannus <mannusmenting@gmail.com> Co-authored-by: PurpleHato <linkvssangoku.jr@gmail.com> Co-authored-by: Dog <5172592+Dog@users.noreply.github.com> Co-authored-by: Vague Rant <vaguerant@users.noreply.github.com> Co-authored-by: Baoulettes <perlouzerie@hotmail.fr> Co-authored-by: Ada <60364512+GreatArgorath@users.noreply.github.com>
131 lines
5.6 KiB
Markdown
131 lines
5.6 KiB
Markdown
# 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](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)
|
|
> 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](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.
|
|
|
|
### 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) |
|
|
| Ctrl+R | Reset |
|
|
|
|
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](https://retroarchopenhardware.com/survey.php) 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](BUILDING.md) 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](https://builds.shipofharkinian.com/job/SoH_Multibranch/job/develop)
|
|
|
|
|
|
## 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
|