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-07 21:30:56 +00:00
parent b00cd968bb
commit c19b2f6e90
1 changed files with 1 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -37,18 +37,13 @@ Reskit assumes a best-practice entity-component engine design and the objects de
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). The array index of this component will be one more than the last index listed by the designer. 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). The array index of this component will be one more than the last index listed by the designer.
On your object layer in Tiled, you can also use property `reskit-system[x]` to define systems, where x is the index of the system applying to the whole object layer. In your game engine design, each system should iterate only over entities sharing components relevant to the system.
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. 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.
## 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-system[x]` or 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 property identifier such as `reskit-component[x]`.
### Example ### Example
```toml ```toml
[systems]
gameplay = { id = 0 }
[components] [components]
player = { id = 0 } player = { id = 0 }
health = { health = {