Data Types

TOML Formatting

Quartermaster is intended to be usable by non-programmers, which is why it uses Tom's Obvious Minimal Language (TOML) for data and configuration files. (Also because JSON doesn't support comments, and is less friendly.) Users are encouraged to read the TOML spec, but it's not necessary to use the program. This wiki page will cover the bare necessities, most of which have been copied from the TOML spec page.

Comments

A hash mark '#' at the beginning of a line denotes a comment. Everything on that line after the hash mark will not be parsed by the program. The exception to this is hash marks inside strings.

# This is a full-line comment
key = "value"  # This is a comment at the end of a line
another = "# This is not a comment"

Key/Value Pair

Key/value pairs are the primary form of data in TOML files. The key goes to the left of the equals sign, and the value should be enclosed in double quotes.

key = "value"

Single quotes denote a string literal instead of a regular string, and should not be used in Quartermaster files. Double quotes denote basic strings. Basic strings may only contain valid UTF-8 characters. Quotation marks and backslashes must be escaped using a backslash. If you don't know what that means, don't worry about it and just don't put quotation marks or backslashes in your strings.

Tables

Ingredients

(Unfinished)

Recipes

(Unfinished)

People

(Unfinished)

Groups

(Unfinished)