Lump filtering
Lump filtering is a feature for directory-structured archives that allows loading of lumps depending on the game or gametype.
The engine makes use of a special filter/ directory which houses lump filters. These filters are directories which bear the name of the game or gametype for which to load their contents, and they must follow the directory structure.
When the filters are loaded, they will be renamed to strip out the filter/<game-or-gametype>/ part and will be ordered so they take precedence over any lumps not inside a filter/ directory. Filters that do not match the criteria, will be ignored.
Filters are not necessarily mutually exclusive. For instance, if there are two filters, one for any Doom-based game and another for Doom II: Hell on Earth, both will be loaded when playing Doom II: Hell on Earth, but only the former filter will be loaded if playing any of the other Doom-based games.
| Note: as of GZDoom 4.1.0, the names of the Doom games filters doom.doom1 and doom.doom2 are deprecated in favor of the new names doom.id.doom1 and doom.id.doom2, respectively. As such, the old names should not be used in future projects nor mixed with the new names. |
Filter names
The following is a listing of game and gametype filter names:
Game-based
- doom
- Any Doom game.
- doom.id
- Any commercial Doom game.
- doom.id.doom2
- Any Doom 2 game.
- doom.id.doom2.commercial
- Doom 2: Hell on Earth.
- doom.id.doom2.commercial.french
- Doom 2: L'Enfer sur Terre.
- doom.id.doom2.commercial.xbox
- Doom 2: XBox Edition.
- doom.id.doom2.unity
- Doom 2: Unity Edition.
- doom.id.doom2.bfg
- Doom 2: BFG Edition.
- doom.id.doom2.plutonia
- Final Doom: Plutonia Experiment.
- doom.id.doom2.plutonia.unity
- Final Doom: Plutonia Experiment: Unity Edition.
- doom.id.doom2.tnt
- Final Doom: TNT - Evilution.
- doom.id.doom2.tnt.unity
- Final Doom: TNT - Evilution: Unity Edition.
- doom.id.doom2.wadsmoosh
- doom.id.wadsmoosh (New from 4.6.0)
- DOOM: Complete: WadSmoosh.
- doom.id.doom1
- Any original Doom game.
- doom.id.doom1.registered
- Doom Registered.
- doom.id.doom1.ultimate
- The Ultimate Doom.
- doom.id.doom1.ultimate.xbox
- Doom: XBox Edition.
- doom.id.doom1.unity
- Doom: Unity Edition.
- doom.id.doom1.bfg
- Doom: BFG Edition.
- doom.freedoom
- Any Freedoom game.
- doom.freedoom.demo
- Freedoom: Demo Version.
- doom.freedoom.phase1
- Freedoom: Phase 1.
- doom.freedoom.phase2
- Freedoom: Phase 2.
- doom.freedoom.freedm
- FreeDM
- heretic
- Any Heretic game.
- heretic.heretic
- Heretic.
- heretic.shadow
- Heretic: Shadow of the Serpent Riders.
- blasphemer
- Blasphemer.
- hexen
- Any Hexen game.
- hexen.hexen
- Hexen: Beyond Heretic.
- hexen.deathkings
- Hexen: Deathkings of the Dark Citadel.
- strife
- Any Strife game.
- strife.strife
- Strife: Quest for the Sigil.
- strife.veteran
- Strife: Veteran Edition.
- chex
- Any Chex Quest game.
- chex.chex1
- Chex(R) Quest.
- chex.chex3
- Chex(R) Quest 3.
- urbanbrawl
- Action Doom 2: Urban Brawl.
- hacx
- Any Hacx game.
- hacx.hacx1
- Hacx: Twitch'n Kill.
- hacx.hacx2
- Hacx 2.0.
- harmony
- Harmony.
- square
- Any The Adventures of Square game.
- square.squareware
- The Adventures of Square (Square-ware).
- square.square
- The Adventures of Square.
- delaweare
- Delaweare.
- woolball
- Any Shadow Of The Wool Ball game. (Verification needed)
- woolball.rotwb
- Rise Of The Wool Ball.
Gametype-based
- game-raven
- Any Heretic or Hexen game.
- game-doomstrifechex
- Any Doom, Strife or Chex Quest game.
- game-doomchex
- Any Doom or Chex Quest game.
- game-doom
- Any Doom game.
- game-heretic
- Any Heretic game.
- game-hexen
- Any Hexen game.
- game-strife
- Any Strife game.
- game-chex
- Any Chex Quest game.
