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 16:51:33 +00:00
parent c04567397e
commit 0c4d66e38c
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -7,3 +7,12 @@ This document details some approaches for implementing the `level` tool.
# What is `level`? # 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 event objects (e.g. "drop enemy", "open door") that your custom engine can read and apply. `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.
# Events
By adding an object layer and object in Tiled, and adding the property `reskit-event`, you can define an event triggered in certain scenarios depending on additional `reskit-*` properties.
| Object Property | Description |
|-------------------------|--------------------------------------------------------------------------------------------------------|
| reskit-event | String. Defines an event type to use (see Event Types) |
| reskit-character | String. Target character defined for a particular event type |