diff --git a/example.json b/example.json new file mode 100644 index 0000000..fc3f994 --- /dev/null +++ b/example.json @@ -0,0 +1,11 @@ +{ + "name": "Example", + "fonts": { + "Melissa 8": "melissa8.json" + }, "scripts": { + "test.txt": { + "max_tiles_per_line": 8, + "font": "Melissa 8" + } + } +} \ No newline at end of file diff --git a/readme.txt b/readme.txt index 74ec24b..0ff370a 100644 --- a/readme.txt +++ b/readme.txt @@ -1,16 +1,12 @@ Smeargle 0.4.0 readme --------------------- -Usage: smeargle.py font.json script.txt +Usage: smeargle.py game.json -font.json is a JSON document which describes the font and provides a mapping -of characters to font indexes and font widths. - -script.txt is a plaintext document without formatting which is rendered as an -image in PNG with a limited palette. +game.json is a file which follows the Game JSON format outlined below. Output ------ -Smeargle outputs three files, at present: +Smeargle outputs three files per script, at present: *