gdritter repos palladio / master docs / file_format.rst
master

Tree @master (Download .tar.gz)

file_format.rst @masterraw · history · blame

This is the documentation of the Palladio file format.

Basic Structure
===============

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.

- The tileset for a Palladio file is stored in the file itself as a file called `tileset.png`, and must be PNG-encoded.
- The file-level configuration data is stored as a JSON file called `metadata.json`. It must be a JSON object with the following fields:
    - `tile_width`, whose value must be a number which can be interpreted as a sixteen-bit unsigned integer
    - `tile_height`, whose value must be a number which can be interpreted as a sixteen-bit unsigned integer
    - `config_loop_forever`, whose value must be a boolean
- The rule data is stored as a JSON file called `rules.json`. It must be a JSON object.
- 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.