summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorColin Okay <okay@toyful.space>2020-04-02 10:58:33 -0500
committerColin Okay <cbeok@protonmail.com>2020-10-12 09:37:42 -0500
commit3e4a4eadfb79551ee5a4c239d0c6b30c90268c19 (patch)
tree8193e2ab3ef88d05c60677349de386297da8bae7
parent14dfa43f22589bdc96ddecbf1758eaba9d4071c1 (diff)
readme
-rw-r--r--README.org15
1 files changed, 9 insertions, 6 deletions
diff --git a/README.org b/README.org
index 728d7df..41e2eb1 100644
--- a/README.org
+++ b/README.org
@@ -1,12 +1,15 @@
-* =imbricate= makes tilesheets for (Lisp) games
+* =imbricate= Makes Tilesheets For Games
- The =imbricate= turns a directory, with possible nexted directories,
- containing images of varying sizes into a single tile sheet. The tool also
- produces file containing a list of property lists that includes a location and
- a name for each image within the sheet.
+ The =imbricate= produces tile sheets from a directory tree the
+ leaves of which are PNG image files.
- The property list outputs either a list of plists, or a json file.
+ The PNG files can be of any size. The =imbricate= tool will attempt
+ to pack the tiles into a square tile sheet.
+
+ Imbricate also produces an "index file" for the tilesheet, providing
+ a name and a location of each individual image. The index can be in
+ Lisp or JSON formats.
** Example