diff --git a/README.md b/README.md index e5bbd98..da0c543 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # tmx2gba # -tmx2gba is a simple command line utility that converts [Tiled](http://www.mapeditor.org/) .tmx maps to Game Boy Advance compatible charmaps. -Originally developed for my own personal use, I've thrown it up on glorious Github/Gitlab/whatever in case this is of use to anyone else. +tmx2gba is a simple command line utility that converts [Tiled](http://www.mapeditor.org/) .tmx maps to Game Boy Advance formatted charmaps. +Originally developed for my own personal use, I've thrown it up in case this is of use to anyone else. If you find a bug, please open an issue. @@ -17,27 +17,26 @@ Enjoy! tmx2gba [-h] [-r offset] [-lyc name] [-p 0-15] <-i inpath> <-o outpath> ``` -Command | Required | Notes -------------|----------|---------------------------------------------------------------------- --h | N/A | Display help & command info. --l (name) | No | Name of layer to use (default first layer in TMX). --y (name) | No | Layer for palette mappings. --c (name) | No | Output a separate 8bit collision map of the specified layer. --r (offset) | No | Offset tile indices (default 0). --p (0-15) | No | Select which palette to use for 4-bit tilesets. --m (name;id)| No | Map an object name to an ID, will enable object exports. --i (path) | *Yes* | Path to input TMX file. --o (path) | *Yes* | Path to output files. --f | No | Command line instructions list for easy integration with buildscripts +| Command | Required | Notes | +|--------------|----------|-----------------------------------------------------------------------| +| -h | N/A | Display help & command info. | +| -l (name) | No | Name of layer to use (default first layer in TMX). | +| -y (name) | No | Layer for palette mappings. | +| -c (name) | No | Output a separate 8bit collision map of the specified layer. | +| -r (offset) | No | Offset tile indices (default 0). | +| -p (0-15) | No | Select which palette to use for 4-bit tilesets. | +| -m (name;id) | No | Map an object name to an ID, will enable object exports. | +| -i (path) | *Yes* | Path to input TMX file. | +| -o (path) | *Yes* | Path to output files. | +| -f | No | Command line instructions list for easy integration with buildscripts | ### How do I build it? ### Dependencies for building are CMake 3.x and a C++11 compliant compiler, all other dependencies are in-tree so you should be able to build with: ```bash -mkdir build && cd build -cmake .. -make +cmake -B build +make -C build -j$(nproc --all) ``` Optionally, to make it convenient for my dkp projects: @@ -47,11 +46,9 @@ sudo cp tmx2gba $DEVKITPRO/tools/bin/tmx2gba ### Todo list ### * Add support for multi-SBB prepared charmaps. -* Test CMakeLists for Windows compatibility. * Check if this works for NDS as well. * Compression support. -* Prehaps use GNU style getopt_long? -* Refactor & Fix bugs. *(duh)* +* Support for less common TMX formats. ### License ### [tmx2gba](https://github.com/ScrelliCopter/tmx2gba) is licensed under the zlib license.