- Fork this repository
- Add the information about a game to gameInfo.js One entry for each slug. See the Comments in gameInfo.js for details about which fields are mandatory and how the structure of an entry should look like.
- Add the Higscore structure to gameMaps.js Check the comments in gameMaps.js for details about all the fields.
- If the game uses a special character Map add it to charMaps.js
- Commit your changes and submit a pull request. When submitting a Pull request add a screenshot of the highscore screen and the stringified data from the games *.hi file. Make sure that the names in the submitted highscore screens include, numbers, upper/lower case letters and special symbols if available. This makes testing on my side a lot easier. Also include if a new formatter needs to be written.
- asIs: Mainly used for scores. 0x00013538 is decoded to: 13538.
- reverseDecimal: Mainly used for scores. 0x000412 is decoded to: 120400.
- bcd: Mainly used for scores. 0x01FF03 is decoded to: 12563.
- fromCharMap: Mainly used for names. If this format is set, the field also needs a setting with the used char map. 0x01 is decoded to the first character of the Char map 0x05 to the fifth and so on.
- ascii: mainly used for names. Default ASCII encoded. 0x41313f is decoded to A1?.
- hexToDecimal: Plain hex to decimal conversion. 0x027616 is decoded to 161302.
- specialOnly: Only use special mappings. Special mappings need to be provided int the settings.
- append: Mainly used for scores. Appends the given characters after formatting.
- ignoreBytes: Ignore specific bytes of a range. Mainly used for spaced names.
- add: Add an integer to a formatted value.