diff options
| author | inspectredc <78732756+inspectredc@users.noreply.github.com> | 2024-06-25 04:17:36 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-06-24 23:17:36 -0400 |
| commit | 791064e870bbad100a28a58bc8167c2a0707c7a7 (patch) | |
| tree | 24e972cd8d793f3ac59fbb0086b21a3d0eaa6fcf /README.md | |
| parent | 0d4e554ac6c0c2f5431138cd2af3365d69334aa7 (diff) | |
Add Basic README (#664)
* Add basic readme
* Update README.md
---------
Co-authored-by: Archez <Archez@users.noreply.github.com>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 74 |
1 files changed, 74 insertions, 0 deletions
@@ -1,8 +1,82 @@ +[comment]: <> (Todo: Make Light Mode Image) +[comment]: <> (Todo: Make Dark Mode Image) + # 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](docs/supportedHashes.json). + +### 2. Download The Ship of Harkinian from [Releases](https://github.com/HarbourMasters/2Ship2Harkinian/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: +* [**retro - OTR and O2R generator**](https://github.com/HarbourMasters64/retro) +* [**fast64 - Blender plugin (Note that MM is not fully supported at this time)**](https://github.com/HarbourMasters/fast64) + +# Development +### Building + +If you want to manually compile 2S2H, please consult the [building instructions](docs/BUILDING.md). + + ### 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](https://nightly.link/HarbourMasters/2ship2harkinian/workflows/main/develop/2ship-windows.zip) * [Linux](https://nightly.link/HarbourMasters/2ship2harkinian/workflows/main/develop/2ship-linux.zip) * [Mac](https://nightly.link/HarbourMasters/2ship2harkinian/workflows/main/develop/2ship-mac.zip) + +<a href="https://github.com/Kenix3/libultraship/"> + <picture> + <source media="(prefers-color-scheme: dark)" srcset="./docs/poweredbylus.darkmode.png"> + <img alt="Powered by libultraship" src="./docs/poweredbylus.lightmode.png"> + </picture> +</a> |
