archives/freedoom
2
0
Fork 0
mirror of https://github.com/freedoom/freedoom.git synced 2025-09-03 19:25:45 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

BUILD-SYSTEM: Update to current state of the project

Browse source 
Some directory names changed, we don't build resource WADs anymore,
cpp variables changed to PHASE1 and PHASE2.
This commit is contained in:
Mike Swanson 2019-09-01 18:49:58 -07:00
parent a31450f5b9
commit 40f9cbf0d6
1 changed files with 26 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

57
BUILD-SYSTEM.adoc
View file

@ -51,8 +51,8 @@ following diagram illustrates the process:
The following are the resulting WAD files generated by the build The following are the resulting WAD files generated by the build
system: system:
* +freedoom1.wad+: Phase 1, the _Ultimate Doom_ IWAD file. * +freedoom1.wad+: Phase 1, the _Ultimate Doom_-compatible IWAD file.
* +freedoom2.wad+: Phase 2, the _Doom II_ IWAD file. * +freedoom2.wad+: Phase 2, the _Doom II_-compatible IWAD file.
* +freedm.wad+: FreeDM IWAD file, containing deathmatch levels * +freedm.wad+: FreeDM IWAD file, containing deathmatch levels
== Source configuration files == Source configuration files
@ -71,9 +71,8 @@ The +buildcfg.txt+ file is processed using a Python script named
tool (C Preprocessor). Variables are defined on the command line, tool (C Preprocessor). Variables are defined on the command line,
based on the type of output target desired: based on the type of output target desired:
* +DOOM2+: Build for a Doom II WAD. * +PHASE1+: Build for the Phase 1 IWAD.
* +DOOM1+: Build for a Doom I WAD. * +PHASE2+: Build for the Phase 2 IWAD.
* +ULTDOOM+: Include episode four levels.
=== Texture configuration file (+lumps/textures/textures.cfg+) === Texture configuration file (+lumps/textures/textures.cfg+)
@ -83,20 +82,19 @@ patch names) and +texture2.lmp+ (Doom I only). They are generated
by the +build-textures+ script; deutex’s internal texture builder by the +build-textures+ script; deutex’s internal texture builder
is deliberately not used for compatibility reasons. is deliberately not used for compatibility reasons.
Similarly to the build configuration file, different textures are Unlike id’s Doom games, Freedoom includes nearly every texture
included depending on the output WAD type. The file is passed through possible in all three of its IWADs. There are a handful of textures
the +simplecpp+ script to include the appropriate textures. Command that must differ between Phase 1 and 2 for compatibility with Doom 1
line variables are defined based on the desired build settings: and 2 mods, since their definitions changed in the Doom games. We
also include logo textures for FreeDM levels. The file is passed
through the +simplecpp+ script to account for the variant textures.
Command line variables are defined based on the desired build
settings:
* +DOOM1+: Include textures that only exist in Doom I. * +DOOM1_VERSIONS+: Include textures in Phase 1 that would conflict
* +DOOM2+: Include textures that only exist in Doom II. with Phase 2.
* +ULTDOOM+: Include textures that only exist in Ultimate Doom.
* +FREEDM+: Include textures that are needed for FreeDM. * +FREEDM+: Include textures that are needed for FreeDM.
Note that +DOOM1+ and +DOOM2+ are not mutually exclusive, and the
default for a Doom II build is to include all of the textures for
both.
== Generated files == Generated files
The following files are generated automatically by automated scripts The following files are generated automatically by automated scripts
@ -118,8 +116,8 @@ configurations for each IWAD file.
[frame="topbot",grid="none",options="header"] [frame="topbot",grid="none",options="header"]
|=============================================================== |===============================================================
| Subdirectory | WAD File | CPP Variables | Subdirectory | WAD File | CPP Variables
| +lumps/textures/phase1/+ | +freedoom1.wad+ | DOOM1, ULTDOOM | +lumps/textures/phase1/+ | +freedoom1.wad+ | PHASE1
| +lumps/textures/phase2/+ | +freedoom2.wad+ | DOOM1, DOOM2 | +lumps/textures/phase2/+ | +freedoom2.wad+ | PHASE2
| +lumps/textures/freedm/+ | +freedm.wad+ | FREEDM | +lumps/textures/freedm/+ | +freedm.wad+ | FREEDM
|=============================================================== |===============================================================
@ -135,9 +133,8 @@ WAD files that are built:
[frame="topbot",grid="none",options="header"] [frame="topbot",grid="none",options="header"]
|=============================================================== |===============================================================
| Filename | WAD File | CPP Variables | Filename | WAD File | CPP Variables
| +wadinfo.txt+ | Resource WAD files | DOOM2 | +wadinfo_phase1.txt+ | +freedoom1.wad+ | PHASE1
| +wadinfo_phase1.txt+ | +freedoom1.wad+ | DOOM1, ULTDOOM | +wadinfo_phase2.txt+ | +freedoom2.wad+ | PHASE2
| +wadinfo_phase2.txt+ | +freedoom2.wad+ | DOOM2
| +wadinfo_freedm.txt+ | +freedm.wad+ | FREEDM | +wadinfo_freedm.txt+ | +freedm.wad+ | FREEDM
|=============================================================== |===============================================================
@ -180,19 +177,17 @@ It reads level names from the dehacked lumps.
=== +playpal.py+ === +playpal.py+
Found in +lumps/cph/misc-lumps+, this script builds the +PLAYPAL+ Found in +lumps/playpal+, this script builds the +PLAYPAL+ lump which
lump which contains the 256-color palettes used for special contains the 256-color palettes used for special effects (injured
effects (injured “red” flash, the green “radiation suit” effect, “red” flash, the green “radiation suit” effect, etc.)
etc.)
=== +colormap.py+ === +colormap.py+
Found in +lumps/cph/misc-lumps+, this script builds the +COLORMAP+ Found in +lumps/colormap+, this script builds the +COLORMAP+ lump that
lump that is used for the diminished lighting within the game. is used for the diminished lighting within the game. This script is
This script is also reused to generate additional colormaps that also reused to generate additional colormaps that can be used for
can be used for special effects. It has a number of command line special effects. It has a number of command line options that allow it
options that allow it to do various different colorizing and to do various different colorizing and “fog” effects.
“fog” effects.
=== +mkgenmidi+ === +mkgenmidi+