diff --git a/README.md b/README.md index 3fef512..1af076d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,48 @@ -# tmx2gba -A simple command line utility to convert .tmx files to GBA-compatible charmaps. +# tmx2gba # +tmx2gba is a simple command line utility that converts Tiled .tmx maps to GBA-compatible charmaps. + +### How do I use it? ### +``` +tmx2gba [-h] [-r offset] [-lc name] [-p 0-15] <-i inpath> <-o outpath> +``` + +Command | Required | Notes +------------|----------|------------------------------------------------------------- +-h | N/A | Display help & command info. +-l | No | Name of layer to use (default first layer in TMX). +-c | No | Output a separate 8bit collision map of the specified layer. +-r | No | Offset tile indices (default 0). +-p <0-15> | No | Select which palette to use for 4-bit tilesets. +-i | *Yes* | Path to input TMX file. +-o | *Yes* | Path to output files. + +### Todo list ### +* Add support for multi-SBB prepared charmaps. +* Test on Linux. + +### License ### +tmx2gba is licensed under the zlib license. +RapidXML is licensed under the Boost & MIT licenses. +René Nyffenegger's base64.cpp is licensed under the zlib license. +XGetopt & miniz are both public domain software. + +``` + Copyright (C) 2015 Nicholas Curtis + + This software is provided 'as-is', without any express or implied + warranty. In no event will the authors be held liable for any damages + arising from the use of this software. + + Permission is granted to anyone to use this software for any purpose, + including commercial applications, and to alter it and redistribute it + freely, subject to the following restrictions: + + 1. The origin of this software must not be misrepresented; you must not + claim that you wrote the original software. If you use this software + in a product, an acknowledgment in the product documentation would be + appreciated but is not required. + 2. Altered source versions must be plainly marked as such, and must not be + misrepresented as being the original software. + 3. This notice may not be removed or altered from any source distribution. + +```