mirror of https://github.com/HarbourMasters/2ship2harkinian.git synced 2024-11-23 05:59:40 +00:00

Go to file

Garrett Cox 0129959d7b Fix fairy container and seahorse rendering (#804 )		2024-10-10 13:38:58 -05:00
.github	Fix pr-artifacts fetch script after version update (#786 )	2024-10-01 15:32:03 -04:00
CMake	Bump LUS (#625 )	2024-05-31 19:50:36 -05:00
docs	Change recommended build tools from 142 to 143, minimum VS to 2022. (#762 )	2024-08-30 14:46:04 -04:00
libultraship@4160fa0aa0	bump lus (#782 )	2024-10-01 12:15:30 -04:00
mm	Fix fairy container and seahorse rendering (#804 )	2024-10-10 13:38:58 -05:00
OTRExporter@854685155a	fix zora magic shield alpha (#768 )	2024-09-12 16:32:19 -04:00
ZAPDTR@b002f28757	update to latest lus main (#614 )	2024-05-30 23:30:05 -04:00
.clang-format	Initial commit for 2S2H	2024-05-22 09:04:51 -05:00
.clang-tidy	Initial commit for 2S2H	2024-05-22 09:04:51 -05:00
.gitattributes	Initial commit for 2S2H	2024-05-22 09:04:51 -05:00
.gitignore	PowerShell clang fix (#714 )	2024-06-24 23:42:12 -04:00
.gitmodules	Bump LUS and use nlohmann json from package manager (#254 )	2024-05-22 09:05:03 -05:00
CMakeLists.txt	Merge remote-tracking branch 'origin/develop' into merge-develop-rika	2024-07-11 22:05:15 -04:00
Dockerfile	Audio Works (#180 )	2024-05-22 09:05:01 -05:00
LICENSE	Initial commit for 2S2H	2024-05-22 09:04:51 -05:00
README.md	Fix crash with graphics menu index out of bounds (#738 )	2024-07-08 23:47:42 -04:00
run-clang-format.ps1	PowerShell clang fix (#714 )	2024-06-24 23:42:12 -04:00
run-clang-format.sh	clang format (#447 )	2024-05-22 09:05:05 -05:00
run-docker.sh	Initial commit for 2S2H	2024-05-22 09:04:51 -05:00

README.md

2 Ship 2 Harkinian

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 2 Ship 2 Harkinian Support text channels. Please keep in mind that we do not condone piracy.

Quick Start

2Ship 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://2ship.equipment/. If you'd prefer to manually validate your ROM dump, you can cross-reference its sha1 hash with the hashes here.

2. Download 2 Ship 2 Harkinian from Releases

3. Launch the Game!

Windows

Extract the zip
Launch 2ship.exe

Linux

Place your supported copy of the game in the same folder as the appimage.
Execute 2ship.appimage. You may have to chmod +x the appimage via terminal.

macOS

Run 2ship.app.
When prompted, select your supported copy of the game.

4. Play!

Congratulations, you are now sailing with 2 Ship 2 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
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 2ship2harkinian.json file by finding the line "Backend":{... and changing the id value to 3 and set the Name to OpenGL. DirectX 11 with id 2 is the default on Windows. Metal with id 4 is the default on macOS.

Custom Assets

Custom assets are packed in .o2r or .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 .o2r/.otr files, check out the following tools:

Development

Building

If you want to manually compile 2S2H, 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.