diff --git a/assets.md b/assets.md new file mode 100644 index 0000000..7682244 --- /dev/null +++ b/assets.md @@ -0,0 +1,30 @@ +# Assets + +PPM files that may be converted into the game's raw data format. + +## Map + +The `assets/map.ppm` file contains a representation of the initial state of the map. +The corresponding tile values are: + +PPM 8bits channels | Tile +-- | -- +`0x00_00_00` | `0` (Empty) +`0xFF_00_00` | `1` (Wall) +`0xFF_FF_00` | `2` (Coin) + +## Sprites + +The corresponding in-game color values are: + +PPM 8bits channels | In-game `RRRGGGBB` value | Name +-- | -- | -- +`0x00_00_00` | `000_000_00` | Black +`0x00_00_FF` | `000_000_11` | Blue +`0x00_FF_00` | `000_111_00` | Green +`0x77_77_77` | `010_011_10` | Gray +`0xFF_00_00` | `111_000_00` | Red +`0xFF_00_FF` | `111_000_11` | Pink +`0xFF_80_00` | `111_100_00` | Orange +`0xFF_FF_00` | `111_110_00` | Yellow +`0xFF_FF_FF` | `111_111_11` | White diff --git a/readme.md b/readme.md index 5fe95ae..a68efc9 100755 --- a/readme.md +++ b/readme.md @@ -24,33 +24,7 @@ Usage example: The script is build over Deno's API, so you'll need to have a `deno` binary in your PATH to use it that way. -## Assets +## Documentation -PPM files that may be converted into the game's raw data format. - -### Map - -The `assets/map.ppm` file contains a representation of the initial state of the map. -The corresponding tile values are: - -PPM 8bits channels | Tile --- | -- -`0x00_00_00` | `0` (Empty) -`0xFF_00_00` | `1` (Wall) -`0xFF_FF_00` | `2` (Coin) - -### Sprites - -The corresponding in-game color values are: - -PPM 8bits channels | In-game `RRRGGGBB` value | Name --- | -- | -- -`0x00_00_00` | `000_000_00` | Black -`0x00_00_FF` | `000_000_11` | Blue -`0x00_FF_00` | `000_111_00` | Green -`0x77_77_77` | `010_011_10` | Gray -`0xFF_00_00` | `111_000_00` | Red -`0xFF_00_FF` | `111_000_11` | Pink -`0xFF_80_00` | `111_100_00` | Orange -`0xFF_FF_00` | `111_110_00` | Yellow -`0xFF_FF_FF` | `111_111_11` | White \ No newline at end of file +- [Assets](assets.md) +- [Visuals](visuals.md) diff --git a/visuals.md b/visuals.md index 7e54d03..70e00bc 100644 --- a/visuals.md +++ b/visuals.md @@ -2,22 +2,25 @@ ## Pixel mode resolutions -0. 80x60 -1. 160x120 -2. 256x192 -3. 320x240 -4. 640x480 -5. 800x600 -6. 920x720 -7. 1024x768 +Resolution ID | Resolution +-- | -- +`0` | `80x60` +`1` | `160x120` +`2` | `256x192` +`3` | `320x240` +`4` | `640x480` +`5` | `800x600` +`6` | `920x720` +`7` | `1024x768` -## Map size +## Map sizes ### 15x11 Pro: The width and hight are odd, allowing the map to have a central column and row. -Tile size per resolution: -0. 5x5 pixels, with a reminder of 5 pixels en width and 5 pixels in height. -1. 10x10 pixels, with a reminder of 10w and 10h -2. 17x17 pixels, no reminder +Resolution ID | Tile size (in pixels) | Comment +-- | -- | -- +`0` | `5x5` | with a reminder of 5 pixels en width and 5 pixels in height. +`1` | `10x10` | with a reminder of 10w and 10h +`2` | `17x17` | no reminder