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 22:07:10 +00:00
parent d7a56abd79
commit edc8bbacc1
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -20,7 +20,9 @@ Reskit assumes a best-practice entity-component engine design and the objects de
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. 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. By default, reskit will attach one component to each entity: `position`, which is generated from the position set in Tiled Editor. 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.
By default, reskit will attach one component to each entity: `position`, which is generated from the position set in Tiled Editor. This component has two 16-bit values: x and y position on the map (in pixels, 0,0 is top left of the map).
## Configuration TOML ## Configuration TOML
This is provided on the command line via `-c, --config-file`. This argument is required. The configuration 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]`. This is provided on the command line via `-c, --config-file`. This argument is required. The configuration 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]`.