---------------------------------------------------------
BRK v1.2 by Jim Flynn, copyright 1996. -FREEWARE-
---------------------------------------------------------

BRK is useful for decomposing DOOM II wads into resources organized
into subdirectories, where they can be edited.

BRK takes a single parameter, the name of a wad file. The wad is
broken into its component resources and stored into subdirectories by
category. BRK also writes a text file of the same name as the wad
with extension .RES, listing the resources extracted in sections,
just like a MAK text file. In fact the output of BRK can be used by
MAK to reconstruct the wad. See MAK.TXT for details on the format of
this file.

        <<<<<<<>>>>>>>>
        LUMPS directory         
        <<<<<<<>>>>>>>>

The engine only recognizes resources corresponding to the filenames
shown below. Each file is a binary image of the resource contents in
the wad file.

PLAYPAL.LMP                     14 palettes, each 256 X 3
COLORMAP.LMP                    34 256 wide color intensity lookups
ENDOOM.LMP                      4000 char text/attr screen on game exit
DEMO1.LMP                       first built-in demo
DEMO2.LMP                       second built-in demo
DEMO3.LMP                       third built-in demo
GENMIDI.LMP                     midi patch info
DMXGUSC.LMP                     gus sound card memory size patch lookup


        <<<<<<<<>>>>>>>>
        LEVELS directory
        <<<<<<<<>>>>>>>>

Each engine in the DOOM family only recognizes certain levels. For
DOOM II, the only supported engine at this time, these correspond to
the files shown below. Each must be a fully built and rejected wad
file containing the level implied by its name.

MAP01.WAD                       Level definitions
...
MAP32.WAD               

Note that named levels can be used with MAK, but BRK always writes
them to MAPnn.WAD where nn is the level number.


        <<<<<<<<>>>>>>>>
        SOUNDS directory
        <<<<<<<<>>>>>>>>

The engine only recognizes sound resources by the names shown below.
The .TXT files seem to be output streams for the PC speaker port freq
and/or timing. The .WAV files are standard 8 bit format except the
11025Hz sampling rate, and are limited to 65535 bytes of sound data.

DP*.TXT                         PC speaker sound effects
DS*.WAV                         Sound card sound effects

Sound Name                      Function
---------------------------------------------------------------------
PISTOL                          Pistol shot
SHOTGN                          Shotgun shot
SGCOCK                          Shotgun cock
SAWUP                           Chainsaw fired
SAWIDL                          Chainsaw not fired
SAWFUL                          Chainsaw engaged
SAWHIT                          Chainsaw shot
RLAUNC                          Rocket Launcher shot
RXPLOD                          Rocket explodes
FIRSHT                          Fireball misses
FIRXPL                          Fireball hits
PSTART                          Platform starts to move
PSTOP                           Platform stops
DOROPN                          Door opens slowly
DORCLS                          Door closes slowly
STNMOV                          Floor rising sound
SWTCHN                          Low switch clunk
SWTCHX                          High switch clunk
PLPAIN                          Player damaged
DMPAIN                          Monster pain 1
POPAIN                          Imp pain 2
SLOP                            Messy decomposition sound
ITEMUP                          Pickup item
WPNUP                           Pickup weapon
OOF                             Falling sound
TELEPT                          Teleporter sound
POSIT1                          Imp sees player 1
POSIT2                          Imp sees player 2
POSIT3                          Imp sees player 3
BGSIT1                          Badguy sees player 1
BGSIT2                          Badguy sees player 2
SGTSIT                          Demon sees player
BRSSIT                          Baron sees player
SGTATK                          Demon attacks player
CLAW                            Imp close attack - clawing
PLDETH                          Player dies 1
PDIEHI                          Player dies 2
PODTH1                          Imp dies 1
PODTH2                          Imp dies 2
PODTH3                          Imp dies 3
BGDTH1                          Badguy dies 1
BGDTH2                          Badguy dies 2
SGTDTH                          Demon dies
BRSDTH                          Baron dies
POSACT                          Imp activates
BGACT                           Badguy activates
DMACT                           Monster activates
NOWAY                           Push wall sound
BAREXP                          Barrel explosion
PUNCH                           Punching sound
TINK                            High pitched "tink"??
BDOPN                           Fast door open
BDCLS                           Fast door close
ITMBK                           Respawining item
GETPOW                          Pick power-up
PLASMA                          Plasma rifle shot
BFG                             BFG shot
CACSIT                          Caco sees player
CYBSIT                          Cyber sees player
SPISIT                          Spider sees player
SKLATK                          Soul attack player
CACDTH                          Caco dies
SKLDTH                          Soul dies
CYBDTH                          Cyber dies
SPIDTH                          Spider dies
HOOF                            Cyber clomp
METAL                           Shot hitting metal?
DSHTGN                          Double barreled shot
DBOPN                           Double barrel open
DBCLS                           Double barrel close
DBLOAD                          Double barrel load
VIPAIN                          Vile hurt
MNPAIN                          Mancubus hurt
PEPAIN                             Pain Elemental hurt
BSPSIT                          Arachnotron sees player
KNTSIT                          Hell Knight sees player
VILSIT                          Vile sees player
MANSIT                          Mancubus sees player
PESIT                           Pain Elemental sees player
SKEPCH                          Revenant close attack
VILATK                          Vile attacks player
SKESWG                          Revenant swings and misses
BSPDTH                          Arachnotron dies
VILDTH                          Vile dies
KNTDTH                          Hell Knight dies
PEDTH                           Pain Elemental dies
SKEDTH                          Revenant dies
BSPACT                          Arachnotron active
BSPWLK                          Arachnotron walks
VILACT                          Vile active
FLAME                           Flame sound
FLAMST                          Flame out
BOSPIT                          Box spits out of Icon
BOSCUB                          Cube gives birth
BOSSIT                          Icon sees player
BOSPN                           Icon hurt
BOSDTH                          Icon dies
MANATK                          Mancubus attacks
MANDTH                          Mancubus dies
SSSIT                           Wolf soldier sees player
SSDTH                           Wolf soldier dies
KEENPN                          Keen hurt
KEENDT                          Keen dies
SKEACT                          Revenant active
SKESIT                          Revenant sees player
SKEATK                          Revenant fire ball
RADIO                           Message sound - triple bleep

        <<<<<<<<>>>>>>>>
        MUSICS directory
        <<<<<<<<>>>>>>>>

The engine only recognizes music resources by the names shown below.
The files are in .MUS format, similar to but different from MIDI.

Music name      Used for
-----------------------------------------------
D_RUNNIN.MUS    Map01
D_STALKS.MUS    Map02
D_COUNTD.MUS    Map03
D_BETWEE.MUS    Map04
D_DOOM.MUS      Map05
D_THE_DA.MUS    Map06
D_SHAWN.MUS     Map07
D_DDTBLU.MUS    Map08
D_IN_CIT.MUS    Map09
D_DEAD.MUS      Map10
D_STLKS2.MUS    Map11
D_THEDA2.MUS    Map12
D_DOOM2.MUS     Map13
D_DDTBL2.MUS    Map14
D_RUNNI2.MUS    Map15
D_DEAD2.MUS     Map16
D_STLKS3.MUS    Map17
D_ROMERO.MUS    Map18
D_SHAWN2.MUS    Map19
D_MESSAG.MUS    Map20
D_COUNT2.MUS    Map21
D_DDTBL3.MUS    Map22
D_AMPIE.MUS     Map23
D_THEDA3.MUS    Map24
D_ADRIAN.MUS    Map25
D_MESSG2.MUS    Map26
D_ROMER2.MUS    Map27
D_TENSE.MUS     Map28
D_SHAWN3.MUS    Map29
D_OPENIN.MUS    Map30
D_EVIL.MUS      Map31
D_ULTIMA.MUS    Map32
D_READ_M.MUS    readme music
D_DM2TTL.MUS    title music
D_DM2INT.MUS    intermission music

        <<<<<<<<>>>>>>>>>>
        GRAPHICS directory
        <<<<<<<<>>>>>>>>>>

The engine only recognizes graphics resources by the names shown below.
The files are in .BMP format.

Full screen images
---------------------------------------------------------------
HELP.BMP                        Help screen on F1
TITLEPIC.BMP                    Screen when game first run
CREDIT.BMP                      Screen showing credits
BOSSBACK.BMP                    End of game screen

Various size and style numbers for status bar
--------------------------------------------------------------------------
AMMNUM0.BMP AMMNUM1.BMP AMMNUM2.BMP AMMNUM3.BMP AMMNUM4.BMP        grey ammo
AMMNUM5.BMP AMMNUM6.BMP AMMNUM7.BMP AMMNUM8.BMP AMMNUM9.BMP         numbers

STBAR.BMP                                                          status bar

STGNUM0.BMP STGNUM1.BMP STGNUM2.BMP STGNUM3.BMP STGNUM4.BMP        gray weapon
STGNUM5.BMP STGNUM6.BMP STGNUM7.BMP STGNUM8.BMP STGNUM9.BMP         numbers

STTMINUS.BMP                                                       minus sign
STTNUM0.BMP STTNUM1.BMP STTNUM2.BMP STTNUM3.BMP STTNUM4.BMP        large red
STTNUM5.BMP STTNUM6.BMP STTNUM7.BMP STTNUM8.BMP STTNUM9.BMP         numbers
STTPRCNT.BMP                                                       pct sign %

STYSNUM0.BMP STYSNUM1.BMP STYSNUM2.BMP STYSNUM3.BMP STYSNUM4.BMP   yel shadow
STYSNUM5.BMP STYSNUM6.BMP STYSNUM7.BMP STYSNUM8.BMP STYSNUM9.BMP    numbers

STKEYS0.BMP STKEYS1.BMP STKEYS2.BMP                                key icons
STKEYS3.BMP STKEYS4.BMP STKEYS5.BMP 

STDISK.BMP STCDROM.BMP                                          disk,cd icons

STARMS.BMP                                                      weapons frame

Message and map level name font - numbers are ASCII
-----------------------------------------------------------------------------
STCFN033.BMP STCFN034.BMP STCFN035.BMP STCFN036.BMP STCFN037.BMP STCFN038.BMP 
STCFN039.BMP STCFN040.BMP STCFN041.BMP STCFN042.BMP STCFN043.BMP STCFN044.BMP 
STCFN045.BMP STCFN046.BMP STCFN047.BMP STCFN048.BMP STCFN049.BMP STCFN050.BMP 
STCFN051.BMP STCFN052.BMP STCFN053.BMP STCFN054.BMP STCFN055.BMP STCFN056.BMP 
STCFN057.BMP STCFN058.BMP STCFN059.BMP STCFN060.BMP STCFN061.BMP STCFN062.BMP 
STCFN063.BMP STCFN064.BMP STCFN065.BMP STCFN066.BMP STCFN067.BMP STCFN068.BMP 
STCFN069.BMP STCFN070.BMP STCFN071.BMP STCFN072.BMP STCFN073.BMP STCFN074.BMP 
STCFN075.BMP STCFN076.BMP STCFN077.BMP STCFN078.BMP STCFN079.BMP STCFN080.BMP 
STCFN081.BMP STCFN082.BMP STCFN083.BMP STCFN084.BMP STCFN085.BMP STCFN086.BMP 
STCFN087.BMP STCFN088.BMP STCFN089.BMP STCFN090.BMP STCFN091.BMP STCFN092.BMP 
STCFN093.BMP STCFN094.BMP STCFN095.BMP STCFN121.BMP 

Background color tiles
------------------------------------------------------------------------------
STFB1.BMP STFB0.BMP STFB2.BMP STFB3.BMP STPB1.BMP STPB0.BMP STPB2.BMP STPB3.BMP 

Player face images                                              Health
------------------------------------------------------------------------------
STFST01.BMP STFST00.BMP STFST02.BMP                             81-100
STFTL00.BMP STFTR00.BMP STFOUCH0.BMP STFEVL0.BMP STFKILL0.BMP   
STFST11.BMP STFST10.BMP STFST12.BMP                             61-80
STFTL10.BMP STFTR10.BMP STFOUCH1.BMP STFEVL1.BMP STFKILL1.BMP 
STFST21.BMP STFST20.BMP STFST22.BMP                             41-60
STFTL20.BMP STFTR20.BMP STFOUCH2.BMP STFEVL2.BMP STFKILL2.BMP 
STFST31.BMP STFST30.BMP STFST32.BMP                             21-40
STFTL30.BMP STFTR30.BMP STFOUCH3.BMP STFEVL3.BMP STFKILL3.BMP 
STFST41.BMP STFST40.BMP STFST42.BMP                             1-20
STFTL40.BMP STFTR40.BMP STFOUCH4.BMP STFEVL4.BMP STFKILL4.BMP
STFGOD0.BMP STFDEAD0.BMP                                        iddqd, dead

Menu images
------------------------------------------------------------------------------
M_DOOM.BMP M_RDTHIS.BMP M_OPTION.BMP M_QUITG.BMP M_NGAME.BMP M_SKULL1.BMP 
M_SKULL2.BMP M_THERMO.BMP M_THERMR.BMP M_THERMM.BMP M_THERML.BMP M_ENDGAM.BMP 
M_PAUSE.BMP M_MESSG.BMP M_MSGON.BMP M_MSGOFF.BMP M_EPISOD.BMP M_EPI1.BMP 
M_EPI2.BMP M_EPI3.BMP M_HURT.BMP M_JKILL.BMP M_ROUGH.BMP M_SKILL.BMP 
M_NEWG.BMP M_ULTRA.BMP M_NMARE.BMP M_SVOL.BMP M_OPTTTL.BMP M_SAVEG.BMP 
M_LOADG.BMP M_DISP.BMP M_MSENS.BMP M_GDHIGH.BMP M_GDLOW.BMP M_DETAIL.BMP 
M_DISOPT.BMP M_SCRNSZ.BMP M_SGTTL.BMP M_LGTTL.BMP M_SFXVOL.BMP M_MUSVOL.BMP 
M_LSLEFT.BMP M_LSCNTR.BMP M_LSRGHT.BMP 

Screen borders
------------------------------------------------------------------------------
BRDR_TL.BMP BRDR_T.BMP BRDR_TR.BMP BRDR_L.BMP 
BRDR_R.BMP BRDR_BL.BMP BRDR_B.BMP BRDR_BR.BMP 

End screen text and images
------------------------------------------------------------------------------
WIOSTK.BMP WIOSTI.BMP WIF.BMP WIMSTT.BMP WIOSTS.BMP WIOSTF.BMP WITIME.BMP
WIPAR.BMP WIMSTAR.BMP WIMINUS.BMP WIPCNT.BMP WINUM0.BMP WINUM1.BMP
WINUM2.BMP WINUM3.BMP WINUM4.BMP WINUM5.BMP WINUM6.BMP WINUM7.BMP
WINUM8.BMP WINUM9.BMP WICOLON.BMP WISUCKS.BMP WIFRGS.BMP WIP1.BMP WIP2.BMP
WIP3.BMP WIP4.BMP WIBP1.BMP WIBP2.BMP WIBP3.BMP WIBP4.BMP WIKILRS.BMP
WIVCTMS.BMP WISCRT2.BMP WIENTER.BMP 

End screen level names
------------------------------------------------------------------------------
CWILV00.BMP CWILV01.BMP CWILV02.BMP CWILV03.BMP CWILV04.BMP CWILV05.BMP 
CWILV06.BMP CWILV07.BMP CWILV08.BMP CWILV09.BMP CWILV10.BMP CWILV11.BMP 
CWILV12.BMP CWILV13.BMP CWILV14.BMP CWILV15.BMP CWILV16.BMP CWILV17.BMP 
CWILV18.BMP CWILV19.BMP CWILV22.BMP CWILV21.BMP CWILV20.BMP CWILV23.BMP 
CWILV25.BMP CWILV26.BMP CWILV27.BMP CWILV28.BMP CWILV29.BMP CWILV24.BMP 
CWILV30.BMP CWILV31.BMP 

Intermission picture
------------------------------------------------------------------------------
INTERPIC.BMP 


        <<<<<<<<<>>>>>>>>
        SPRITES Directory
        <<<<<<<<<>>>>>>>>

        *.BMP files containing sprites

        <<<<<<<>>>>>>>>
        FLATS Directory
        <<<<<<<>>>>>>>>

        *.BMP files containing flats

        <<<<<<<<<>>>>>>>>
        PATCHES Directory
        <<<<<<<<<>>>>>>>>

        *.BMP files containing patches
