mirror/Shipwright
1
0
Fork 0
mirror of https://github.com/HarbourMasters/Shipwright.git synced 2024-12-12 11:12:20 -05:00
Code Issues Projects Releases Wiki Activity

fix readme link formatting (#4576)

Browse Source 
* fix readme link formatting

* Update README.md

* Update README.md

* Update README.md

* Update README.md
This commit is contained in:
briaguya 2024-11-25 13:21:45 -05:00 committed by GitHub
parent 8926d8f784
commit 7662fa4c3c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -9,7 +9,7 @@ Official Website: https://www.shipofharkinian.com/
Official Discord: https://discord.com/invite/shipofharkinian 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. If you're having any trouble after reading through this `README`, feel free to ask for help in the Support text channels. Please keep in mind that we do not condone piracy.
# Quick Start # Quick Start
@ -73,7 +73,7 @@ Congratulations, you are now sailing with the Ship of Harkinian! Have fun!
# Project Overview # Project Overview
Ship of Harkinian (SOH) is built atop a custom library dubbed libultraship (LUS). Back in the N64 days, there was an SDK distributed to developers named libultra; LUS is designed to mimic the functionality of libultra on modern hardware. In addition, we are dependant on the source code provided by the OOT decompilation project. Ship of Harkinian (SOH) is built atop a custom library dubbed libultraship (LUS). Back in the N64 days, there was an SDK distributed to developers named libultra; LUS is designed to mimic the functionality of libultra on modern hardware. In addition, we are dependant on the source code provided by the OOT decompilation project.
In order for the game to function, you will require a **legally aquired** ROM for Ocarina of Time. Click [here](https://ship.equipment/) to check the compatability of your specific rom. Any copyrighted assets are extracted from the ROM and reformated as a .otr archive file which the code uses. In order for the game to function, you will require a **legally acquired** ROM for Ocarina of Time. Click [here](https://ship.equipment/) to check the compatibility of your specific rom. Any copyrighted assets are extracted from the ROM and reformatted as a .otr archive file which the code uses.
### Graphics Backends ### 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. 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.
@ -99,13 +99,13 @@ If you want to playtest a continuous integration build, you can find them at the
* [Linux](https://nightly.link/HarbourMasters/Shipwright/workflows/generate-builds/develop/soh-linux.zip) * [Linux](https://nightly.link/HarbourMasters/Shipwright/workflows/generate-builds/develop/soh-linux.zip)
### Further Reading ### Further Reading
More detailed documentation can be found in the 'docs' directory, including the afformentioned [building instructions](docs/BUILDING.md). More detailed documentation can be found in the 'docs' directory, including the aforementioned [building instructions](docs/BUILDING.md).
*[Credits](docs/CREDITS.md) * [Credits](docs/CREDITS.md)
*[Custom Music](docs/CUSTOM_MUSIC.md) * [Custom Music](docs/CUSTOM_MUSIC.md)
*[Controler Maping](docs/GAME_CONTROLLER_DB.md) * [Controller Mapping](docs/GAME_CONTROLLER_DB.md)
*[Modding](docs/MODDING.md) * [Modding](docs/MODDING.md)
*[Versioning](docs/VERSIONING.md) * [Versioning](docs/VERSIONING.md)
<a href="https://github.com/Kenix3/libultraship/"> <a href="https://github.com/Kenix3/libultraship/">
<picture> <picture>