- C 88.6%
- C++ 9.7%
- CMake 1.1%
- Python 0.1%
- HLSL 0.1%
- Other 0.1%
67e561c6b8
* Add `BossDefeated` event to final bowser * Add new hooks * actual achievement work; clang * fix star counts for getting total stars when determining achievements * implemented racing achievement * clang * implemented metal cap achievement; added save support for metal cap (+ coins); (mostly) stick with event Mario state instead of `gMarioState`; added color support for achievement histograms; clang |
||
|---|---|---|
| .github | ||
| actors | ||
| assets/ymls | ||
| cmake | ||
| data | ||
| docs | ||
| include | ||
| ios | ||
| levels | ||
| lib/src | ||
| libultraship@e0c1b1fc35 | ||
| port | ||
| sound | ||
| src | ||
| Torch@98331e4908 | ||
| wiki | ||
| .clang-format | ||
| .clang-tidy | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| assets.json | ||
| charmap.txt | ||
| charmap_menu.txt | ||
| CMakeLists.txt | ||
| config.yml | ||
| ExecutableResource.h | ||
| extract_assets.py | ||
| format.sh | ||
| formatyamls.py | ||
| Ghostship.desktop | ||
| ghostship.ico | ||
| ghostship.manifest | ||
| Info.plist | ||
| LICENSE.md | ||
| logo.png | ||
| Makefile | ||
| nx-logo.jpg | ||
| properties.h.in | ||
| README.md | ||
| rename_sym.sh | ||
| Resource.rc | ||
| run-clang-format.ps1 | ||
| run-clang-format.sh | ||
Ghostship
Lead Developers:
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 Ghostship Support text channels. Please keep in mind that we do not condone piracy.
Quick Start
Ghostship does not include any copyrighted assets. You are required to provide a supported copy of the game.
1. Verify your ROM dump
The supported ROMs are US and JP versions. You can verify you have dumped a supported copy of the game by using the SHA-1 File Checksum Online at https://www.romhacking.net/hash/.
- The SHA-1 hash for a US ROM is 9bef1128717f958171a4afac3ed78ee2bb4e86ce.
- The SHA-1 hash for a JP ROM is 8a20a5c83d6ceb0f0506cfc9fa20d8f438cafe51.
2. Verify your ROM is in .z64 format
Your ROM needs to be in .z64 format. If it's in .n64 format, use the following to convert it to a .z64: https://hack64.net/tools/swapper.php
2. Download Ghostship from Releases
3. Generating the OTR from the ROM and Play!
Windows
- Extract every file from the zip into a folder of your choosing.
- Run Ghostship.exe and select your US or JP ROM.
Linux
- Extract every file from the zip into a folder of your choosing.
- Execute Ghostship.appimage. You may have to chmod +x the appimage via terminal.
MacOS
- Extract every file from the zip into a folder of your choosing.
- Run Ghostship and select your US or JP ROM.
Nintendo Switch
- Run one of the PC releases to generate an
sm64.o2rfile. After launching the game on PC, you will be able to find these files in the same directory asGhostship.exeorGhostship.appimage. - Copy the files to your sd card
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 |
|---|---|
| Esc | Toggle menu |
| Ctrl+R | Reset (inside levels) |
| F11 | Fullscreen |
| Tab | Toggle Alternate assets |
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 Ghostship.cfg.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 Ghostship, 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.
Special Thanks:
- Kenix3 : for helping with the Engine development that were brought into other ports.
- HM64 Team : for creating Libultraship and helping with various issues.
- garrettjoecox : for contributing with fixes to this port.
- inspectredc : for contributing to the extraction of the game's assets.
- Malkierian : for contributing to the extraction of the game's assets.