From 254602c6dbf53d06e77e69a5f32c744d15221368 Mon Sep 17 00:00:00 2001 From: Simon Howard Date: Thu, 24 Dec 2015 12:29:25 +0100 Subject: [PATCH] lumps: Add README files for some directories. These deserve to be documented. --- lumps/colormap/README | 10 ++++++++++ lumps/playpal/README | 15 +++++++++++++++ lumps/textures/README | 12 ++++++++++++ 3 files changed, 37 insertions(+) create mode 100644 lumps/colormap/README create mode 100644 lumps/playpal/README create mode 100644 lumps/textures/README diff --git a/lumps/colormap/README b/lumps/colormap/README new file mode 100644 index 00000000..a59befcc --- /dev/null +++ b/lumps/colormap/README @@ -0,0 +1,10 @@ +This directory contains the generator script for the COLORMAP lump. The +COLORMAP lump is used to calculate Doom's lighting; it translates normal +colors into darkened versions in 32 different levels of light. Some more +details can be found on the Doom wiki: + + + +Boom extends the COLORMAP to allow the addition of extra colormap lumps; +these can be used to apply colored lighting and other effects. + diff --git a/lumps/playpal/README b/lumps/playpal/README new file mode 100644 index 00000000..c3c12cdd --- /dev/null +++ b/lumps/playpal/README @@ -0,0 +1,15 @@ +This directory contains the palette generation script. The output of the +script is the PLAYPAL lump. + +The Doom engine operates in a palettized screen mode where only 256 +different colors can be shown on screen at a given time. By applying +alternate palettes, special effects can be generated (eg. the red tint +when taking damage, or the green tint when wearing the radsuit). More +information can be found on the Doom wiki: + + + +The input for the script is playpal-base.lmp which contains the default +palette seen during normal gameplay. The script translates this palette +into the various other forms which are shown in different situations. + diff --git a/lumps/textures/README b/lumps/textures/README new file mode 100644 index 00000000..e8b46311 --- /dev/null +++ b/lumps/textures/README @@ -0,0 +1,12 @@ +This directory contains the texture lump generation script. This is used +to generate the TEXTURE1, TEXTURE2 and PNAMES lumps. The Doom engine uses +these lumps on startup to build the game's wall textures from individual +patch textures. More information can be found on the Doom wiki: + + + +The deutex tool contains its own texture builder. However, due to the +specific requirements of the Freedoom project, we have implemented our +own texture lump builder. See the header comments in the build-textures +script for more information. +