Building Ship of Harkinian

Windows

Requires Python >= 3.6.
Install Visual Studio 2022 Community Edition
In the Visual Studio Installer, install MSVC v142 - VS 2019 C++.
Clone the Ship of Harkinian repository.
Place one or more compatible roms in the OTRExporter directory with namings of your choice.
Run OTRExporter/OTRExporter.sln.
Switch the solution to Release x64.
Build the solution.
Launching OTRExporter/extract_assets.py will generate an oot.otr archive file in OTRExporter/oot.otr.
Run soh/soh.sln
Switch the solution to Release x86 or Release x64.
Build the solution.
Copy the OTRExporter/oot.otr archive file to soh/Release.
Launch soh.exe.

Linux

# Clone the repo
git clone https://github.com/HarbourMasters/Shipwright.git
cd Shipwright
# Copy the baserom to the OTRExporter folder
cp <path to your ROM> OTRExporter
# Build the docker image
sudo docker build . -t soh
# Run the docker image with the working directory mounted to /soh
sudo docker run --rm -it -v $(pwd):/soh soh /bin/bash

Inside the Docker container:

cd soh
# Extract the assets/Compile the exporter/Run the exporter
make setup -j$(nproc) OPTFLAGS=-O2 DEBUG=0
# Compile the code
make -j $(nproc) OPTFLAGS=-O2 DEBUG=0

macOS

Requires Xcode (or xcode-tools) && sdl2, libpng, glew, cmake, pkgconfig, dylibbundler (can be installed via homebrew, macports, etc)

# Clone the repo
git clone https://github.com/HarbourMasters/Shipwright.git
cd ShipWright
# Copy the baserom to the OTRExporter folder
cp <path to your ROM> OTRExporter

cd soh
# Extract the assets/Compile the exporter/Run the exporter
# -jX defines number of cores to use for compilation - lower or remove entirely if having issues
make setup -j8 DEBUG=0
# Compile the code (watch the -j parameter as above)
make -j8 DEBUG=0
# Create macOS app bundle
make appbundle

Copy your OTR file to ~/Library/Application\ Support/com.shipofharkinian.soh
Launch soh app in the soh folder!

Compatible Roms

OOT_PAL_GC      checksum 0x09465AC3
OOT_PAL_GC_DBG1 checksum 0x871E1C92 (debug non-master quest)

OTRExporter Usage

The OTRExporter exports an oot.otr archive file which Ship of Harkinian requires to play.

Use the extract_assets.py script file to run the exporter using any of the following methods:

Double click on the script after placing one or more roms in the directory.
Drag & Drop a rom onto the script.
In a terminal run python3 extract_assets.py after placing one or more roms in the directory.
In a terminal run python3 extract_assets.py <path_to_rom>

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.

2.9 KiB Raw Blame History