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 23:02:10 +00:00
parent d57d314818
commit d0c28b78e1
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -53,32 +53,34 @@ health = {
} }
``` ```
## .bin Format (Tiles) ## Artifact File Formats
### .bin Format (Tiles)
This is a system-specific binary format of tiles formatted for your target system. Normally you would take this data and DMA it to the VRAM in your homebrew. This is a system-specific binary format of tiles formatted for your target system. Normally you would take this data and DMA it to the VRAM in your homebrew.
### `--console md` #### `--console md`
* Output format is identical to `tileset` i.e. it is a colour palette followed by a set of tiles in tile order. Two .bin files are output in `--console md` mode: by default, they are named `plane_b.bin` and `plane_a.bin`. This allows you to manually place them along 128KB boundaries so that DMA works properly. * Output format is identical to `tileset` i.e. it is a colour palette followed by a set of tiles in tile order. Two .bin files are output in `--console md` mode: by default, they are named `plane_b.bin` and `plane_a.bin`. This allows you to manually place them along 128KB boundaries so that DMA works properly.
## .map Format (Tile Map) ### .map Format (Tile Map)
While the above format contains the graphics, this contains the nametable settings for each layer i.e. pointers to entries in the above list of tiles for each region of the screen. Normally you would take this data and DMA it to the VRAM in your homebrew, where the pattern map nametable is set. While the above format contains the graphics, this contains the nametable settings for each layer i.e. pointers to entries in the above list of tiles for each region of the screen. Normally you would take this data and DMA it to the VRAM in your homebrew, where the pattern map nametable is set.
### `--console md` #### `--console md`
* This contains entries in [VDP nametable format](https://md.railgun.works/index.php?title=VDP#Nametables), in tile layer B followed by tile layer A, sized according to your settings in Tiled Map Editor. DMA this to the nametable location in each respective layer. * This contains entries in [VDP nametable format](https://md.railgun.works/index.php?title=VDP#Nametables), in tile layer B followed by tile layer A, sized according to your settings in Tiled Map Editor. DMA this to the nametable location in each respective layer.
## .lvc Format (Level Collision Map) ### .lvc Format (Level Collision Map)
The collision map is just an array of 8-bit unsigned integers laid out with the same tile dimensions as your visible layers. 0 is a free area, while 1 is a collision area. The collision map is just an array of 8-bit unsigned integers laid out with the same tile dimensions as your visible layers. 0 is a free area, while 1 is a collision area.
## .ent Format (Entity-Component System) ### .ent Format (Entity-Component System)
This file contains the entity-component system defined by the [attributes](#entity-component-system) set in Tiled Map Editor's object layer(s). This file contains the entity-component system defined by the [attributes](#entity-component-system) set in Tiled Map Editor's object layer(s).
### Entity Data #### Entity Data
``` ```
2 bytes: Number of entities 2 bytes: Number of entities
For (number of entities): For (number of entities):
* 2 bytes: Entity ID * 2 bytes: Entity ID
``` ```
### Component Definitions #### Component Definitions
``` ```
* 2 bytes: Number of component definitions * 2 bytes: Number of component definitions
For (number of component definitions): For (number of component definitions):
@ -87,7 +89,7 @@ For (number of component definitions):
* Note: Order of fields are identical to order of fields in configuration TOML. * Note: Order of fields are identical to order of fields in configuration TOML.
``` ```
### Component Data #### Component Data
``` ```
* 2 bytes: Number of component instances * 2 bytes: Number of component instances
For (number of component instances): For (number of component instances):