diff --git a/Design-Doc%3A-%60level%60-tool.md b/Design-Doc%3A-%60level%60-tool.md index 9e1462a..51dd1b3 100644 --- a/Design-Doc%3A-%60level%60-tool.md +++ b/Design-Doc%3A-%60level%60-tool.md @@ -8,6 +8,13 @@ This document details some approaches for implementing the `level` tool. ## What is `level`? `level` is a tool for reskit that converts [Tiled Map Editor](https://www.mapeditor.org/) tilesets and maps to a binary format accessible to C or assembly language engines. It distinguishes itself from other available homebrew tools by offering support for Tiled's native tmx/tsx XML formats, and user-specified entity-component system definitions. +## Tilesets and Maps +To convert a Tiled map and tileset: +``` +reskit level -i map.tmx -c mapping.toml +``` +Reskit will compile and output a .lvl file which you can then bundle into your game project. (More information on .lvl format TBD) + ## Entity-Component System Reskit assumes a best-practice entity-component engine design and the objects defined in your .tmx file effectively serve as the entities.