From 2cf731bdbfc63195e4075f4b7a4f4bd8f2c4ad1f Mon Sep 17 00:00:00 2001 From: Colin Okay Date: Thu, 2 Apr 2020 10:58:33 -0500 Subject: readme --- README.org | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) (limited to 'README.org') 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 -- cgit v1.2.3