|
| 1 | +# makecode |
| 2 | +makecode is a cli that prints PrimeHack's mods ported to Gecko codes. |
| 3 | + |
| 4 | +## Table of Contents |
| 5 | +- [Info](#info) |
| 6 | +- [Building](#building) |
| 7 | +- [Credits](#credits) |
| 8 | +- [License](#license) |
| 9 | + |
| 10 | +## Info |
| 11 | +PrimeHack has modifications that you can enable at runtime to do things like unlock hypermode difficulty, disable bloom |
| 12 | +, etc. This tool is a port of these mods to Gecko codes. It can print a code based on the game and region. |
| 13 | + |
| 14 | +makecode can print code(s) to the format for Dolphin (`[Gecko]\n$Code Name\ncode`), Ocarina (`GAMEID\nGame Name\n\n |
| 15 | +Code Name\ncode`), and raw (`code`). |
| 16 | + |
| 17 | +## Building |
| 18 | +Simply run `./compile.sh` at root directory of project. This script uses GCC to compile the sources. It also computes |
| 19 | +the md5, sha1, and sha256 hash of the compiled result afterwards using `md5sum`, `sha1sum`, and `sha256sum`. You can |
| 20 | +pass `asan` as the first argument to the script to build a debug build with AddressSanitizer (this isn't supported on a |
| 21 | +Windows build). For building for Windows, run `./compile.sh` with MSYS2 MinGW x64 or run `.\compile.bat`. |
| 22 | + |
| 23 | +## Credits |
| 24 | +- Shio, SirMangler, and many others for their work on PrimeHack, a modification of Dolphin Emulator to allow for FPS |
| 25 | +controls and other things on the Metroid Prime series [here](https://github.com/shiiion/dolphin). |
| 26 | + |
| 27 | +## License |
| 28 | +``` |
| 29 | +MIT License |
| 30 | +
|
| 31 | +Copyright (c) 2022 Yonder |
| 32 | +
|
| 33 | +Permission is hereby granted, free of charge, to any person obtaining a copy |
| 34 | +of this software and associated documentation files (the "Software"), to deal |
| 35 | +in the Software without restriction, including without limitation the rights |
| 36 | +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 37 | +copies of the Software, and to permit persons to whom the Software is |
| 38 | +furnished to do so, subject to the following conditions: |
| 39 | +
|
| 40 | +The above copyright notice and this permission notice shall be included in all |
| 41 | +copies or substantial portions of the Software. |
| 42 | +
|
| 43 | +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 44 | +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 45 | +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 46 | +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 47 | +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 48 | +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 49 | +SOFTWARE. |
| 50 | +
|
| 51 | +``` |
0 commit comments