c4f34624ba
* Hook into flagset hooks for processing check tracking. Has some manual workarounds (some breaks still need to be found). Remove areaChecks and looping functionality as redundant. * Additional vanilla handling. * Fix tracker not showing MQ checks in MQ non-rando. Fix tracker marking non-MQ variants of dungeon checks (e.g. map chest, etc) when collecting in MQ. * Set all areas to spoiled if not rando. * Revert attempt to spoil in randomizer based on MQ dungeon count as I don't know how that works at the moment. * Restore and update spoiling based on MQ dungeon settings (none, selection, or count of 12). Fix Anju As Adult check. * Remove Anchor-specific code :baguette: * Use `ClearAreaTotals()` in `Teardown()` instead of the duplicate code there. * Update to `ClearAreaChecksAndTotals()` with `vec.clear()` added. * Fix type spoiling again. Now spoils on 0 MQ dungeons, not rando, if the option is enabled in check tracker settings, selection, or set number of 12. Fix vanilla checks being marked collected in MQ dungeons. * Fix 100 GS check. * ACTUALLY fix 100 GS: change flag type to `RandomizerInf()` in `item_location.cpp`, add RC to RandoInf for it to the table. Also don't send GI for flag if father, falsely triggers ZR frogs minigame. * Fix gravedigging tour tracking. * Fix membership card check tracking. Change scene and flag values to any existing enums. Clarifying formatting for the checking loop vOrMQ conditions. * Fix Gravedigging Tour tracking. Simplify Always Win Gravedigging Tour and Fix Gravedigging Tour Glitch applications. Modified all necessary paths to use vanilla GDT PoH collection flag instead of randomizer variant. * Fix Kak Potion Shop being "seen" when entering as child. |
||
|---|---|---|
| .devcontainer | ||
| .github/workflows | ||
| CMake | ||
| docs | ||
| libultraship@59427a67bf | ||
| OTRExporter@04b85b95fa | ||
| scripts | ||
| soh | ||
| ZAPDTR@eff2903611 | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| CMakeLists.txt | ||
| copy-existing-otrs.cmake | ||
| Dockerfile | ||
| README.md | ||
Website
Official Website: https://www.shipofharkinian.com/
Discord
Official Discord: https://discord.com/invite/shipofharkinian
If you're having any trouble after reading through this README, feel free ask for help in the Support text channels. Please keep in mind that we do not condone piracy.
Quick Start
The Ship does not include any copyrighted assets. You are required to provide a supported copy of the game.
1. Verify your ROM dump
You can verify you have dumped a supported copy of the game by using the compatibility checker at https://ship.equipment/. If you'd prefer to manually validate your ROM dump, you can cross-reference its sha1 hash with the hashes here.
2. Download The Ship of Harkinian from Releases
3. Launch the Game!
Windows
- Extract the zip
- Launch
soh.exe
Linux
- Place your supported copy of the game in the same folder as the appimage.
- Execute
soh.appimage. You may have tochmod +xthe appimage via terminal.
macOS
- Run
soh.app. When prompted, select your supported copy of the game. - You should see a notification saying
Processing OTR, then, once the process is complete, you should get a notification sayingOTR Successfully Generated, then the game should start.
Nintendo Switch
- Run one of the PC releases to generate an
oot.otrand/oroot-mq.otrfile. After launching the game on PC, you will be able to find these files in the same directory assoh.exeorsoh.appimage. On macOS, these files can be found in/Users/<username>/Library/Application Support/com.shipofharkinian.soh/ - Copy the files to your sd card
sdcard
└── switch
└── soh
├── oot-mq.otr
├── oot.otr
├── soh.nro
└── soh.otr
- Launch via Atmosphere's
Game+Rlauncher method.
4. Play!
Congratulations, you are now sailing with the Ship of Harkinian! Have fun!
Configuration
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 |
| F9 | Toggle Text-to-Speech (Windows and Mac only) |
| F11 | Fullscreen |
| Tab | Toggle Alternate assets |
| Ctrl+R | Reset |
Graphics Backends
Currently, there are three rendering APIs supported: DirectX11 (Windows), OpenGL (all platforms), and Metal (MacOS). You can change which API to use in the Settings menu of the menubar, which requires a restart. If you're having an issue with crashing, you can change the API in the shipofharkinian.json file by finding the line gfxbackend:"" and changing the value to sdl for OpenGL. DirectX 11 is the default on Windows.
Custom Assets
Custom assets are packed in .otr files. To use custom assets, place them in the mods folder.
If you're interested in creating and/or packing your own custom asset .otr files, check out the following tools:
Development
Building
If you want to manually compile SoH, please consult the building instructions.
Playtesting
If you want to playtest a continuous integration build, you can find them at the links below. Keep in mind that these are for playtesting only, and you will likely encounter bugs and possibly crashes.
- Windows
- macOS
- Linux (performance) (requires
glibc 2.35or newer, but will be more performant than the compatibility build.) - Linux (compatibility) (compatible with most Linux distributions, but may not be as performant as the performance build.)
- Switch
- Wii U
