freedoom
/
freedoom
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Remove PWAD references in BUILD-SYSTEM and minor touchups

master
Mike Swanson 2014-01-07 05:32:58 -08:00
parent bfb95753bd
commit 193d844236
1 changed files with 24 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
BUILD-SYSTEM.asc
View File

@ -1,4 +1,3 @@
= Build system
This is an explanation of the functioning of the Freedoom build
@ -9,7 +8,7 @@ system.
Freedoom is built using 'deutex', which is a command-line tool for
automated building of Doom WAD files. However, multiple different WAD
files are built from the Freedoom material. Therefore, the Freedoom
build system is more complicated than a "normal" deutex build would
build system is more complicated than a ``normal'' deutex build would
otherwise be.
A top-level +Makefile+ controls the build system and executes the
@ -55,18 +54,10 @@ following diagram illustrates the process:
The following are the resulting WAD files generated by the build
system:
* +freedoom.wad+ : Resource PWAD file containing all of the Freedoom
resources except for the levels.
* +freedoom_levels.wad+ : Resource PWAD containing the (Doom II) levels.
* +freedoom_sprites.wad+ : Resource PWAD containing the sprites.
* +freedoom_sounds.wad+ : Resource PWAD containing the (Doom II)
music and sound effects.
* +freedoom_textures.wad+ : Resource PWAD containing the (Doom II)
textures.
* +doom2.wad+ : Doom II IWAD file.
* +doom.wad+ : "Ultimate" Doom I IWAD file.
* +freedm.wad+ : FreeDM IWAD file, containing deathmatch levels, and
with all monsters replaced by dummy graphics.
* +doom2.wad+: Doom II IWAD file.
* +doom.wad+: ``Ultimate'' Doom I IWAD file.
* +freedm.wad+: FreeDM IWAD file, containing deathmatch levels, and
with all monsters replaced by dummy graphics.
== Source configuration files
@ -84,9 +75,9 @@ The +buildcfg.txt+ file is processed using a Python script named
tool (C Preprocessor). Variables are defined on the command line,
based on the type of output target desired:
* +DOOM2+ : Build for a Doom II WAD.
* +DOOM1+ : Build for a Doom I WAD.
* +ULTDOOM+ : Include episode four levels.
* +DOOM2+: Build for a Doom II WAD.
* +DOOM1+: Build for a Doom I WAD.
* +ULTDOOM+: Include episode four levels.
=== Texture configuration file (+textures/combined.txt+)
@ -99,10 +90,10 @@ included depending on the output WAD type. The file is processed by
the +simplecpp+ script to include the appropriate textures. Command
line variables are defined based on the desired build settings:
* +DOOM1+ : Include textures that only exist in Doom I.
* +DOOM2+ : Include textures that only exist in Doom II.
* +ULTDOOM+ : Include textures that only exist in Ultimate Doom.
* +FREEDM+ : Include textures that are needed for FreeDM.
* +DOOM1+: Include textures that only exist in Doom I.
* +DOOM2+: Include textures that only exist in Doom II.
* +ULTDOOM+: Include textures that only exist in Ultimate Doom.
* +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
@ -207,7 +198,7 @@ default behavior.
This script processes the texture file (+texture1.txt+) and outputs a
list of the names of all the required patches. This is used to
generate a file named +pnames.txt+ that is included in the
+wadinfo.txt+ configuration file in a section named "[patches]".
+wadinfo.txt+ configuration file in a section named ``[patches]''.
== deutex
@ -215,18 +206,18 @@ generate a file named +pnames.txt+ that is included in the
file typically named +wadinfo.txt+, reading files from the following
directories to generate the WAD:
* +flats+ : Floor and ceiling textures.
* +graphics+ : Graphics for the menu, heads up display and status bar, etc.
* +levels+ : The levels. Files are named eg. map01.wad or e1m1.wad
* +flats+: Floor and ceiling textures.
* +graphics+: Graphics for the menu, heads up display and status bar, etc.
* +levels+: The levels. Files are named eg. map01.wad or e1m1.wad
for Doom II and Doom I levels, with FreeDM levels named eg.
dm01.wad.
* +lumps+ : Miscellaneous lumps.
* +musics+ : Music files, in MUS or MIDI format.
* +patches+ : Patch graphics that are used to compose wall textures.
* +sounds+ : Sound effects, in WAV format.
* +sprites+ : Graphics for the in-game sprites (monsters, power-ups,
* +lumps+: Miscellaneous lumps.
* +musics+: Music files, in MUS or MIDI format.
* +patches+: Patch graphics that are used to compose wall textures.
* +sounds+: Sound effects, in WAV format.
* +sprites+: Graphics for the in-game sprites (monsters, power-ups,
weapons, decorations, etc.)
* +textures+ : Texture definitions.
* +textures+: Texture definitions.
=== Idiosyncrasies
@ -234,7 +225,7 @@ deutex is an old tool and has various quirks that must be worked
around. Some of them are listed here.
* The default background color for sprites is magenta. The
"standard" background color of cyan is used instead by providing
``standard'' background color of cyan is used instead by providing
the +-rgb 0 255 255+ command line parameter.
* By default, deutex attempts to convert sound effects to 11,025Hz
@ -251,8 +242,6 @@ around. Some of them are listed here.
* deutex requires an existing IWAD file in order to build WAD files,
and includes the contents of the +TEXTURE1+ lump from the IWAD in
any +TEXTURE1+ lumps it generates. To work around this, a "dummy"
any +TEXTURE1+ lumps it generates. To work around this, a ``dummy''
IWAD file containing an empty +TEXTURE1+ lump is contained inside
the +dummy+ directory.