From 0c4d66e38c8d2bf8112e1875e9a9411a34f3c96d Mon Sep 17 00:00:00 2001 From: Ashley N Date: Mon, 4 Sep 2023 16:51:33 +0000 Subject: [PATCH] Update Design Doc: `level` tool --- Design-Doc%3A-%60level%60-tool.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/Design-Doc%3A-%60level%60-tool.md b/Design-Doc%3A-%60level%60-tool.md index 42005b9..e102c97 100644 --- a/Design-Doc%3A-%60level%60-tool.md +++ b/Design-Doc%3A-%60level%60-tool.md @@ -7,3 +7,12 @@ 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 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 | +