ashley
/
reskit
1
0
Fork 0
Code Issues 4 Pull Requests Packages Projects Releases Wiki Activity

Update Design Doc: `level` tool

master
Ashley N. 2023-09-04 19:14:11 +00:00
parent e8093027fc
commit 27a1cc2849
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Design-Doc%3A-%60level%60-tool.md

@ -9,7 +9,11 @@ This document details some approaches for implementing the `level` tool.
`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 event objects (e.g. "drop enemy", "open door") that your custom engine can read and apply.
## 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. By adding a property `reskit-component[x]`, where x is the index of the component in an array, you can attach various components to the target entity. What your game does with this information is entirely up to you: reskit just compiles the information on which entities are where and what components are attached to them.
Reskit assumes a best-practice entity-component engine design and the objects defined in your .tmx file effectively serve as the entities.
By adding a property `reskit-component[x]`, where x is the index of the component in an array, you can attach various components to the target entity. Each component may have various properties you choose to define, which can be formatted as Tiled property `reskit-component[x].y`, where x is the index of the component and y is the property name for that component.
What your game does with this information is entirely up to you: reskit just compiles the information on which entities are where and what components are attached to them.
## Map TOML
This is provided on the command line via `--map-config-file`. The Map TOML primarily is a mapping of string identifiers to numeric identifiers, which are better suited for use on 8-bit and 16-bit systems. You must define numeric identifiers for each string you use as a `reskit-component[x]`.