gdritter repos palladio / 4baba94
Starting to write bad docs for the file format Getty Ritter 6 years ago
1 changed file(s) with 14 addition(s) and 0 deletion(s). Collapse all Expand all
+14
-0
docs/file_format.rst less more
1 This is the documentation of the Palladio file format.
2
3 Basic Structure
4 ===============
5
6 The Palladio file format is stored with the `.palladio` file extension. It is stored as a standard `.zip` file with a particular internal structure. The ordering of these components is irrelevant to parsing, but the naming must be consistent.
7
8 - The tileset for a Palladio file is stored in the file itself as a file called `tileset.png`, and must be PNG-encoded.
9 - The file-level configuration data is stored as a JSON file called `metadata.json`. It must be a JSON object with the following fields:
10 - `tile_width`, whose value must be a number which can be interpreted as a sixteen-bit unsigned integer
11 - `tile_height`, whose value must be a number which can be interpreted as a sixteen-bit unsigned integer
12 - `config_loop_forever`, whose value must be a boolean
13 - The rule data is stored as a JSON file called `rules.json`. It must be a JSON object.
14 - A Palladio file *may* contain a file called `info.txt` which contains human-readable metadata about the origin of the Palladio file (such as the version of the application used to produce it). Its contents are never used in parsing.