X Tutup
Skip to content

Commit e402763

Browse files
committed
improved sdk + misc doc fixes
1 parent fdbaaee commit e402763

File tree

5 files changed

+303
-204
lines changed

5 files changed

+303
-204
lines changed

README.md

Lines changed: 59 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ This repository contains everything required to produce a DOOM-like using PICO8,
88
* Triggers (opening/closing doors, elevators, light...)
99
* Keys
1010
* Multiple weapons (bullets & projectiles)
11+
* Sector palettes
12+
* Vertical texture offsets
1113

1214
Level building and monster logic uses standard DOOM concepts & editors and is fully modable.
1315

@@ -37,7 +39,7 @@ ZDoom Wiki (outstanding content folks!)
3739
3. (optional) Create a Python virtual env:
3840
```shell
3941
python -m venv env
40-
sandbox/script/activate
42+
env/script/activate
4143
```
4244
4. Install WAD compiler:
4345
```shell
@@ -66,7 +68,7 @@ ZDoom Wiki (outstanding content folks!)
6668
--dump-sprites Writes all sprites to a single image with their 16x16 tile overlay.
6769
```
6870

69-
## Compile & Run Poom
71+
## Compile & Run Poom (Single Map)
7072
1. Open a Python command prompt at repo location (e.g. where DECORATE file is)
7173
2. (optional) Enable Python virtual env
7274
3. Generate a PICO8 multi-cart game with a sample level in carts folder:
@@ -85,6 +87,18 @@ python -m wad_reader --pico-home d:\pico-8_0.2.0 --carts-path carts --mod-name p
8587
pico8 -home <path to repo> poom_0.p8
8688
```
8789

90+
## Compile & Run Poom (All Maps)
91+
1. Same as above, without the map switch (see ZMAPINFO below on how to declare multiple maps)
92+
93+
```shell
94+
python -m wad_reader --pico-home <path to PICO8> --carts-path <path to carts folder> --mod-name <mod name>
95+
```
96+
Example:
97+
```shell
98+
cd poom-sdk
99+
python -m wad_reader --pico-home d:\pico-8_0.2.0 --carts-path carts --mod-name poom
100+
```
101+
88102
# Controls
89103

90104
Note: mouse support requires Pico8 version 0.2.2+, not yet officially out at the time of writing.
@@ -125,7 +139,8 @@ The toolkit supports folder-based DOOM archive only.
125139
Archive structure:
126140
* :file_folder: maps/ contains levels WAD files
127141
* :file_folder: graphics/ contains image assets (inc. menu)
128-
* :page_facing_up: PLAYPAL game palette ramp
142+
* :page_facing_up: PLAYPAL game colormap
143+
* :page_facing_up: PLAYPAL_RRGGBB sector colormap (optional)
129144
* :page_facing_up: PAINPAL pain palette ramp
130145
* :page_facing_up: DECORATE define actors & behaviors
131146
* :page_facing_up: TEXTURES defines floor & wall textures
@@ -289,10 +304,51 @@ The game support 2 palettes:
289304
* Game palette - used to shade textures & things
290305
* Pain palette - used to fade to red screen when player gets hit
291306

307+
Pico8 can only display 16 colors to be chosen from:
308+
309+
|Number| Hex Color |Name|
310+
|:------|:----------|:--------|
311+
|00 | <span style="#000000">&#9724;</span>|black|
312+
|01 | <span style="#1D2B53">&#9724;</span>|dark blue|
313+
|02 | <span style="#7E2553">&#9724;</span>|dark purple|
314+
|03 | <span style="#008751">&#9724;</span>|dark green|
315+
|04 | <span style="#AB5236">&#9724;</span>|brown|
316+
|05 | <span style="#5F574F">&#9724;</span>|dark gray|
317+
|06 | <span style="#C2C3C7">&#9724;</span>|light gray|
318+
|07 | <span style="#FFF1E8">&#9724;</span>|white|
319+
|08 | <span style="#FF004D">&#9724;</span>|red|
320+
|09 | <span style="#FFA300">&#9724;</span>|orange|
321+
|10 | <span style="#FFFF27">&#9724;</span>|yellow|
322+
|11 | <span style="#00E756">&#9724;</span>|green|
323+
|12 | <span style="#29ADFF">&#9724;</span>|blue|
324+
|13 | <span style="#83769C">&#9724;</span>|indigo|
325+
|14 | <span style="#FF77A8">&#9724;</span>|pink|
326+
|15 | <span style="#FFCCAA">&#9724;</span>|peach|
327+
|128 | <span style="#291814">&#9724;</span>|onyx|
328+
|129 | <span style="#111D35">&#9724;</span>|midnight|
329+
|130 | <span style="#422136">&#9724;</span>|plum|
330+
|131 | <span style="#125359">&#9724;</span>|forest|
331+
|132 | <span style="#742F29">&#9724;</span>|chocolate|
332+
|133 | <span style="#49333B">&#9724;</span>|eggplant|
333+
|134 | <span style="#A28879">&#9724;</span>|beige|
334+
|135 | <span style="#F3EF7D">&#9724;</span>|lemon|
335+
|136 | <span style="#BE1250">&#9724;</span>|burgundy|
336+
|137 | <span style="#FF6C24">&#9724;</span>|pumpkin|
337+
|138 | <span style="#A8E72E">&#9724;</span>|lime|
338+
|139 | <span style="#00B543">&#9724;</span>|jade|
339+
|140 | <span style="#065AB5">&#9724;</span>|royal|
340+
|141 | <span style="#754665">&#9724;</span>|mauve|
341+
|142 | <span style="#FF6E59">&#9724;</span>|coral|
342+
|143 | <span style="#FF9D81">&#9724;</span>|salmon|
343+
292344
### Game Palette
293345

294346
Must be a 16x16 image using *only* colors from row 0 of pain palette.
295347

348+
Colors are sorted top down (color 0 on row 0, color 1 on row 1...), each row is a color ramp.
349+
350+
Each color ramp goes from dark to bright, left to right.
351+
296352
Default palette:
297353

298354
![Game palette](docs/playpal.png)

0 commit comments

Comments
 (0)
X Tutup