h5-cryptum-markup-parser

[Halo 5] Cryptum - Markup Parser

What is this?

Markup Parser converts .bin markup files to JSON. These markups are used in Halo 5 by the game mode options system to list and define allowed settings for a selected game base variant.

But, why?

Once converted, each value for each setting is human-readable and may be used in game variant blob files to inject non-supported ones. Examples: No Weapon Start, Extended Motion Sensor (91m), Weapons Damage Disabled, and many others. Right, mod is the word.

How can I retrive a markup?

Everything you need might be found on the content-hacs API. Few examples: Slayer Markup (EN), Capture The Flag Markup (EN), and Strongholds Markup (FR).

How-to use

ES6:

import MarkupParser from 'h5-cryptum-markup-parser'

MarkupParser
.setFilePath('path/markup_file.bin')
.setOutputFolder('path/output') // Not mandatory
.setFileEncoding('utf-8') // Not mandatory
.readFile((err, result) => console.log(err, result));

ES5:

var MarkupParser = require('h5-cryptum-markup-parser').default;

MarkupParser
.setFilePath('path/markup_file.bin')
.setOutputFolder('path/output') // Not mandatory
.setFileEncoding('utf-8') // Not mandatory
.readFile(function(err, result) {
	return console.log(err, result);
});

Want to contribute?

Feel free to open a pull request on GitHub!

Licence

MIT