Add README files for most directories.

Let's make the project easier to explore and understand.
This commit is contained in:
Simon Howard 2015-12-24 18:19:25 +01:00
parent 991ff8180e
commit 05bdf65ee2
10 changed files with 107 additions and 11 deletions

12
bootstrap/README Normal file
View file

@ -0,0 +1,12 @@
This is the bootstrap WAD builder.
Deutex requires an IWAD to build wads and will refuse to build a WAD if
an IWAD is not provided. The script here creates a minimal IWAD file that
contains all the lumps deutex needs: PLAYPAL (the freedoom PLAYPAL),
an empty TEXTURE1 lump and a PNAMES lump with one lump in (deutex needs
PNAMES lumps to have at least one entry)
Because deutex includes all textures from the parent iwad when building
WADs, it is important that the bootstrap wad has as few textures as
possible.

View file

@ -1,11 +0,0 @@
This is the bootstrap wad builder.
Deutex requires an IWAD to build wads. This creates the wad that
contains all the lumps deutex needs: PLAYPAL (the freedoom PLAYPAL),
an empty TEXTURE1 lump and a PNAMES lump with one lump in (deutex needs
PNAMES lumps to have at least one entry)
deutex includes all textures from the parent iwad when building wads so
it is important the bootstrap wad has as few textures as possible.

9
flats/README Normal file
View file

@ -0,0 +1,9 @@
This directory contains the flats (floor and ceiling textures). More
information about flats can be found on the Doom wiki:
<http://doomwiki.org/wiki/Flat>
GIF files placed in this directory will not be automatically included
in the build; the lump name must also be added into buildcfg.txt in
the top-level directory in the section named [flats].

18
graphics/README Normal file
View file

@ -0,0 +1,18 @@
This directory contains "miscellaneous" graphics that are not textures
or sprites. For the most part these are elements of the user interface,
but it also includes full-screen artwork images such as the title
screen (TITLEPIC), intermission screen background (INTERPIC) and story
screens.
Many of the files for this directory are automatically generated by the
textgen script (see the textgen/ subdirectory).
In general, here's a simple guide to most of the contents of this
directory, based on filename:
* m_*.gif - Elements of the main menu
* stcfn*.gif - Characters used for displaying on-screen messages
seen during gameplay
* st*.gif - Elements of the status bar
* wi*.gif - Elements of the intermission screens

4
graphics/titlepic/README Normal file
View file

@ -0,0 +1,4 @@
This directory contains a shell script that uses ImageMagick to layer
some text information about the build version onto the game's title
screen. The same is performed for each of the three IWADs.

7
levels/README Normal file
View file

@ -0,0 +1,7 @@
This directory contains the game levels. The files are named by the IWAD
into which they are included:
* cXmY.wad - Freedoom: Phase 1
* mapXY.wad - Freedoom: Phase 2
* dmXY.wad - FreeDM

21
musics/README Normal file
View file

@ -0,0 +1,21 @@
This directory contains the background music heard during play. The
files are in General MIDI (.mid) format, but are renamed to .mus because
of the limitations of the deutex tool.
In general, most files are per-level music files:
* d_eXmY.mus - Freedoom: Phase 1 music for cXmY.
* d_mapXY.mus - Freedoom: Phase 2 music for mapXY.
* d_dmXY.mus - FreeDM music for level XY.
There are a few other MIDI files:
* d_intro.mus / d_introa.mus - Freedoom: Phase 1 title music
* d_inter.mus - Freedoom: Phase 1 intermission music
* d_bunny.mus - Freedoom: Phase 1 Chapter 3 end music
* d_victor.mus - Freedoom: Phase 1 victory screen music
* d_dm2ttl.mus - Freedoom: Phase 2 / FreeDM title music
* d_dm2int.mus - Freedoom: Phase 2 / FreeDM intermission music
* d_read_m.mus - Freedoom: Phase 2 / FreeDM text screen music

12
patches/README Normal file
View file

@ -0,0 +1,12 @@
This directory contains patch textures. These are composited together to
make up the in-game wall textures. More information can be found in the
Doom wiki:
<http://doomwiki.org/wiki/Patch>
Placing a GIF file in this directory will not cause it to be included in
the built IWADs; the name of the new patch must be used in at least one
texture in the configuration file `lumps/textures/textures.cfg'. Patches
are automatically included in the IWADs based on the texture lump
configuration.

16
sounds/README Normal file
View file

@ -0,0 +1,16 @@
This directory contains the in-game sound effects. There are two types
of sound effect found here:
* ds*.wav files are digital (PCM) sound effects, the sound effects
usually heard when playing the game.
* dp*.txt files are PC speaker sound effects, heard when playing with a
source port that support PC speaker effects and configured to do so.
Because of the limitations of deutex it is important that sound effects
should be in 8-bit PCM format and not anything more elaborate. Some more
information about Doom's sound effect support can be found on the Doom
wiki:
<http://doomwiki.org/wiki/Sound>

8
sprites/README Normal file
View file

@ -0,0 +1,8 @@
This directory contains the sprites used to represent the in-game
monsters and other objects encountered within the game ("things"). There
are a lot of of sprites because a lot of objects, particularly monsters,
can be viewed from up to 8 different angles. The filenames follow very
a specific naming convention. For more information, see the Doom wiki:
<http://doomwiki.org/wiki/Sprite>