Differences

This shows you the differences between two versions of the page.

--- systems:gzdoom [2022/10/04 03:28] – created maioni
+++ systems:gzdoom [2023/03/09 06:08] (current) – old revision restored (2023/02/07 00:42) - revert proposed changes, old version is correct for v36 maximumentropy
@@ Line 10: / Line 10: @@
 ====== GZDoom ======
-ZDoom is a source port. Based off ATB Doom and NTDoom, has since added practically full support for Boom, Chex Quest, Heretic, Hexen and Strife; and several games have been developed specifically for it. It has added many additional features, including slopes, uncapped fps and z-clipping.
+GZDoom is a source port. Based off ATB Doom and NTDoom, has since added practically full support for Boom, Chex Quest, Heretic, Hexen and Strife; and several games have been developed specifically for it. It has added many additional features, including slopes, uncapped fps and z-clipping.
 "The demons... they are everywhere. Must... kill them all!". Doomguy from DOOM.
@@ Line 32: / Line 32: @@
   * **Emulator:** GZDoom
   * **Folder:** ''roms/gzdoom/''
-  * **Accepted ROM formats:** ''.wad'', ''.iwad'', ''pk3'',''.ipk3'', ''.zip'' or ''.7zip''
+  * **Accepted ROM formats:** ''.wad'', ''.iwad'', ''.pwad'', ''.gzdoom''
 ===== BIOS =====
@@ Line 42: / Line 42: @@
 Place your GZDoom ROMs in ''/userdata/roms/gzdoom/''.
-.WAD and .PK3
+Files MD5 sums: https://doomwiki.org/wiki/Doom_files
+==== .WAD and .PK3 (non compressed files)====
 Each game needs a .WAD (Where's all data?) or .IWAD (Internal WAD), it's the main resource file for a Doom-engine game, containing all the game's original sounds, levels, and graphics.
-Some files have conflicting names; ZDoom provides you with possible aliases.
+Some files have conflicting names; GZDoom provides you with possible aliases.
-.IWAD and .IPK3
+==== .IWAD, .IPK3 and .PWAD (info lumps) ====
 In addition, some "total conversion"-type mods, can be played as their own IWAD; an IWAD is actually identified by its content rather than its name.
@@ Line 54: / Line 56: @@
 In order to play a custom level designed for any of the above games you have to have that particular game's full IWAD. If you do not have the necessary IWAD, you will get an error message on startup.
-Custom IWADs can be detected. These custom IWADs need to have the .iwad or alternatively .ipk3 (not the traditional .wad and .pk3) extension, and they need to include an IWADINFO lump.
+Custom IWADs can be detected. These custom IWADs need to have the .iwad or alternatively .ipk3 (not the traditional .wad and .pk3) extension, and they need to include an IWADINFO lump.  It can also contain DEFBINDS, DEFCVARS, and KEYCONF lumps.
 IWad:
+<code>
 {
 	Name = "My Kickass Custom Game"
@@ Line 65: / Line 68: @@
 	BannerColors = "ff ff ff", "c9 00 00"
 }
+</code>
-.ZIP, .7ZIP, .PK3 or .PK7
+A PWAD, patch wad, is a WAD containing lumps of data created by a user as an add-on.
-The PK3 file format is the same as the ZIP file format, and is treated exactly the same by ZDoom.
+==== .ZIP, .7ZIP, .PK3 or .PK7 (compressed files) ====
+The PK3 file format is the same as the ZIP file format, and is treated exactly the same by GZDoom.
+==== Custom mods ====
+Custom mods can be used by creating a new text file named after the game with the extension ''.gzdoom''. For example:
+<file - Aliens Eradication.gzdoom>
+-iwad DOOM2.WAD -file ALIENS_ERADICATION_TC_2_0.pk3 ERADICATION_MAPSET_2_0.wad
+</file>
+<WRAP center round info>
+The command must be on one line and the casing of the filenames and extensions must match exactly.
+</WRAP>
+Additional music can be added to ''system/configs/gzdoom'' in the ''fm_banks'' & ''soundfonts'' folders respectively.
+===== Supported games =====
 ==== Commercial games ====
-^ Game       ^ Name                                  ^ File Name     ^ Alias                          ^
+^ Game        ^ Name                                   ^ File Name     ^ Alias                         ^
-| DOOM       | Doom (Registered)                     | doom.wad      |                                |
+| DOOM        | Doom (Registered)                      | doom.wad      |                               |
-| DOOM       | The Ultimate Doom                     | doom.wad      | doomu.wad                      |
+| DOOM        | The Ultimate Doom                      | doom.wad      | doomu.wad                     |
-| DOOM       | Doom "BFG Edition"                    | doom.wad      | doombfg.wad or bfgdoom.wad     |
+| DOOM        | Doom "BFG Edition"                     | doom.wad      | doombfg.wad or bfgdoom.wad    |
-| DOOM II    | Doom II                               | doom2.wad     | doom2.wad                      |
+| DOOM II     | Doom II                                | doom2.wad     | doom2.wad                     |
-| DOOM II    | Doom II "BFG Edition"                 | doom2.wad     | doom2bfg.wad or bfgdoom2.wad   |
+| DOOM II     | Doom II "BFG Edition"                  | doom2.wad     | doom2bfg.wad or bfgdoom2.wad  |
-| DOOM II    | Final Doom — TNT: Evilution           | tnt.wad       |                                |
+| DOOM II     | Final Doom — TNT: Evilution            | tnt.wad       |                               |
-| DOOM II    | Final Doom — The Plutonia Experiment  | plutonia.wad  |                                |
+| DOOM II     | Final Doom — The Plutonia Experiment   | plutonia.wad  |                               |
-| DOOM II    | French Doom II                        | doom2f.wad    |                                |
+| DOOM II     | French Doom II                         | doom2f.wad    |                               |
-| Heretic    | Heretic (Registered or Commercial)    | heretic.wad   | hereticsr.wad                  |
+| Heretic     | Heretic (Registered or Commercial)     | heretic.wad   | hereticsr.wad                 |
-| Hexen      | Hexen (Full)                          | hexen.wad     |                                |
+| Hexen       | Hexen (Full)                           | hexen.wad     |                               |
-| Hexen      | Hexen: Deathkings of the Dark Citadel | hexdd.wad     |                                |
+| Hexen       | Hexen: Deathkings of the Dark Citadel  | hexdd.wad     |                               |
-| Strife     | Strife (Full)                         | strife1.wad   | strife.wad                     |
+| Strife      | Strife (Full)                          | strife1.wad   | strife.wad                    |
-| Strife     | Strife: Veteran Edition               | sve.wad       |                                |
+| Strife      | Strife: Veteran Edition                | sve.wad       |                               |
-| Chez Quest | Chex Quest                            | chex.wad      |                                |
+| Chex Quest  | Chex Quest                             | chex.wad      |                               |
 ==== Free games ====
@@ Line 98: / Line 120: @@
 | FreeDoom   | Freedoom: Phase 2                     | freedoom2.wad | freedoom.wad                   |
 | FreeDoom   | FreeDM                                | freedm.wad    |                                |
-| Blasphemer |                                       | heretic.wad   | blasphem.wad or blasphemer.wad |
+| Blasphemer | Blasphemer                            | heretic.wad   | blasphem.wad or blasphemer.wad |
 | Chez Quest | Chex Quest 3                          | chex3.wad     |                                |
-|  |                           |      |                                |
+| Urban Brawl| Action Doom 2: Urban Brawl            | action2.wad   |                                |
-|  |                           |      |                                |
+| Harmony    | Harmony v1.1                          | harm1.wad     |                                |
-Action Doom 2: Urban Brawl
+| Hacx       | Hacx v1.2                             | hacx.wad      |                                |
+| Hacx       | Hacx v2.0                             | hacx2.wad     |                                |
+| Square     | The Adventures of Square              | square1.pk3   |                                |
-doombfg.wad or bfgdoom.wad
+| Delaweare  | Delaweare                             | delaweare.wad |                                |
-Files from game folder /Duke Nukem 3D or /ATOMINST or /Duke Nukem 3D/gameroot or Duke Nukem 3D Twentieth Anniversary World Tour/ or /data
+| Rise Of The Wool Ball   | Rise Of The Wool Ball    | rotwb.wad     |                                |
-<code>
-/userdata/roms/eduke32/duke/
-                           |── DUKE3D.GRP (The World Tour's extra features will requires the whole game installation)
-                           └── DUKE.RTS
-</code>
-Note: For Duke Nukem games it is possible to install High-Definition Packs and Music Packs: http://hrp.duke4.net/download.php
-Some files have versions for Eduke32 emulator and others for Eduke32 emulator, make sure to download the correct one.
-=== Duke It Out in D.C. (expansion) ===
-<file - Duke It Out in D.C..eduke32>
-FILE  = /duke/DUKE3D.GRP
-FILE+ = /duke/DUKEDC.GRP
-</file>
-Files from game folder /Duke Nukem 3D and /Duke Nukem 3D/gameroot/addons/dc or DUKEDC/
-<code>
-/userdata/roms/eduke32/duke/
-                           ├── DUKE3D.GRP (Atomic Edition)
-                           └── DUKEDC.GRP (DUKEDCPP.SSI can be converted to GRP: https://forums.duke4.net/topic/998-xp-trying-to-get-duke-it-out-in-dc-please-help/)
-</code>
-=== Duke Caribbean: Life's a Beach (expansion) ===
-<file - Duke It Out in D.C..eduke32>
-FILE  = /duke/DUKE3D.GRP
-FILE+ = /duke/VACATION.GRP
-</file>
-Files from game folder /Duke Nukem 3D and /Duke Nukem 3D/gameroot/addons/vacation or CARIBBEA/VACATION/
-<code>
-/userdata/roms/eduke32/duke/
-                           ├── DUKE3D.GRP
-                           └── VACATION.GRP (VACA15.SSI can be converted to GRP: https://forums.duke4.net/topic/998-xp-trying-to-get-duke-it-out-in-dc-please-help/)
-</code>
-=== Duke: Nuclear Winter (expansion) ===
-<file - Duke - Nuclear Winter.eduke32>
-FILE  = /duke/DUKE3D.GRP
-FILE+ = /duke/NWINTER.GRP
-</file>
-Files from game folder /Duke Nukem 3D and /Duke Nukem 3D/gameroot/addons/nw
-<code>
-/userdata/roms/eduke32/duke/
-                           ├── DUKE3D.GRP
-                           └── NWINTER.GRP
-</code>
-=== Duke Nukem Atomic Edition ===
-<file - Duke Nukem Atomic Edition.eduke32>
-FILE  = /duke/DUKE3D.GRP
-FILE+ = /duke/DUKE3DA.GRP
-</file>
-Files from game folder /Duke Nukem Atomic Edition or /ATOMINST
-<code>
-/userdata/roms/eduke32/duke/
-                           ├── DUKE3D.GRP
-                           └── DUKE3DA.GRP
-</code>
-=== Duke ZONE 2 ===
-<file - Duke!Zone II.eduke32> (Atomic)
-FILE  = /duke/DUKE!ZON.GRP
-FILE+ = /duke/DUKEZONE2.GRPINFO
-</file>
-<file - Duke!Zone II.eduke32> (World Tour)
-FILE  = /duke/DUKE!ZON.GRP
-FILE+ = /duke/DUKEZONE2_WT.GRPINFO
-</file>
-Files from game folder /Duke Zone 2
-<code>
-/userdata/roms/eduke32/dukezone2/
-               |       ├── DUKE!ZON.GRP
-               |       ├── DUKEZONE2.GRPINFO (Atomic) OR DUKEZONE2_WT.GRPINFO (World Tour)
-               |       └── FIXED CON FILES: https://hrp.duke4.net/download.php
-               |           ├── GAME.CON (Replaces DZ-GAME.CON)
-               |           ├── DEFS.CON (Replaces DZ-DEFS.CON)
-               |           ├── USER.CON (Replaces DZ-USER.CON)
-               |           └── E3L1.MHK
-               └── Duke!Zone II.eduke32
-</code>
-=== Duke Assault ===
-Copy the ASSAULT directory from the CD to your EDuke32 directory.
-Copy the two TILES014.ART and TILES015.ART files from ART directory to the ASSAULT directory.
-Select your map from the user map selection: New Game > User Map > Navigate to /userdata/roms/eduke/assault/ and select the desired map to play.
-^   ^
-| {{:systems:dukenukemusermap1.png?direct&400 |}}{{:systems:dukenukemusermap2.png?direct&400 |}}{{:systems:dukenukemassault1.png?direct&400 |}} |
-<file - Duke Assault.eduke32>
-FILE  = /duke/DUKE3D.GRP
-</file>
-Files from game folder Duke Nukem 3D/, /Duke Assault CD/ASSAULT and /Duke Assault CD/ART
-<code>
-/userdata/roms/eduke32/duke/
-               |       ├── ASSAULT/
-               |       |   ├── *.MAP (1640 MAP files!)
-               |       |   ├── TILES014.ART
-               |       |   └── TILES015.ART
-               |       └── DUKE3D.GRP
-               └── Duke Assalt.eduke32
-</code>
-=== Duke Nukem's Penthouse Paradise (expansion) ===
-<file - Duke Nukem's Penthouse Paradise.eduke32>
-FILE  = /duke/DUKE3D.GRP
-FILE+  = /duke/PENTHOUS.GRP
-</file>
-Files from game folder /Duke Nukem 3D and /penthous
-<code>
-/userdata/roms/eduke32/duke/
-               |       ├── DUKE3D.GRP
-               |       └── PENTHOUS.GRP
-               └── Duke Nukem's Penthouse Paradise.eduke32
-</code>
-=== Duke!Zone (expansion) ===
-<file - Red Zone.eduke32>
-FILE  = /duke/DUKE3D.GRP
-FILE+  = /duke/ZONE.GRP
-</file>
-Files from game folder /Duke Nukem 3D and /redzone
-<code>
-/userdata/roms/eduke32/duke/
-               |       ├── DUKE3D.GRP
-               |       └── Zone.GRP
-               └── Duke!Zone.eduke32
-</code>
-=== Duke Nukem: Plug 'N' Pray Remake Episodes (expansion) ===
-<file - Red Zone.eduke32>
-FILE  = /duke/DUKE3D.GRP
-FILE+  = /duke/PNP.GRP
-</file>
-Files from game folder /Duke Nukem 3D and /pnp
-<code>
-/userdata/roms/eduke32/duke/
-               |       ├── DUKE3D.GRP
-               |       └── PNP.GRP
-               └── Plug 'N' Pray.eduke32
-</code>
-=== Duke Nukem: Zero Hour (expansion) ===
-<file - Duke Nukem Zero Hour.eduke32>
-FILE  = /duke/DUKE3D.GRP
-FILE+  = /duke/ZEROHOUR.GRP
-</file>
-Files from game folder /Duke Nukem 3D and /zerohour
-<code>
-/userdata/roms/eduke32/duke/
-               |       ├── DUKE3D.GRP
-               |       └── ZEROHOUR.GRP
-               └── Duke Nukem Zero Hour.eduke32
-</code>
-=== Duke Xtreme ===
-Copy the DKXTRM directory from the CD to your EDuke32 directory.
-In DKXTRM/PACK14, rename DKEXGAME.CON to GAME.CON, DKEXDEFS.CON to DN3DDEFS.CON, and DKEXUSER.CON to DN3DUSER.CON.
-Select your map from the user map selection: New Game > User Map > Navigate to /userdata/roms/eduke/dkxtrm/ and select the desired map to play at DMMAPS or SPMAPS folder.
-^   ^
-| {{:systems:dukenukemusermap1.png?direct&400 |}}{{:systems:dukenukemusermap2.png?direct&400 |}}{{:systems:dukenukemxtreme1.png?direct&400 |}}{{:systems:dukenukemxtreme2.png?direct&400 |}}{{:systems:dukenukemxtreme3.png?direct&400|}} |
-<file - Duke Xtreme.eduke32>
-FILE  = /duke/DUKE3D.grp
-</file>
-Files from game folder Duke Nukem 3D/ and /Duke Xtreme CD/XTRM
-<code>
-/userdata/roms/eduke32/duke/
-               |       ├── DUKE3D.GRP
-               |       └── DKXTRM/
-               |           ├── DMMAPS (25 files)
-               |           |   └── *.MAP
-               |           ├── PACK13
-               |           |   ├── TILES0*.ART (7 files)
-               |           |   ├── *.CON (3 files)
-               |           |   |       ├── DKEXDEFS.CON
-               |           |   |       ├── DKEXUSER.CON
-               |           |   |       └── DKEXGAME.CON
-               |           |   └── *.VOC (22 files)
-               |           ├── PACK14
-               |           |   ├── TILES0*.ART (7 files)
-               |           |   ├── *.CON (3 files)
-               |           |   |       ├── DN3DDEFS.CON (Renamed from DKEXDEFS.CON)
-               |           |   |       ├── DN3DUSER.CON (Renamed from DKEXUSER.CON)
-               |           |   |       └── GAME.CON (Renamed from DKEXGAME.CON)
-               |           |   └── *.VOC (22 files)
-               |           └── SPMAPS
-               |               └── *.MAP (25 files)
-               └── Duke - Xtreme.eduke32
-</code>
-=== NAM ===
-<file - Nam.eduke32>
-FILE = /nam/NAM.GRP
-CON  = /nam/NAM.CON
-<\file>
-Files from game folder /NAM
-<code>
-/userdata/roms/eduke32/nam/
-               |       ├── NAM.CON (Renamed from GAME.CON)
-               |       ├── NAM.GRP
-               |       └── NAM.RTS
-               └── Nam.eduke32
-</code>
-=== NAMPAL [Walmart version of NAM with different .GPR files] ===
-<file - Napalm.eduke32>
-FILE = /nampal/NAPALM.GRP
-CON  = NAMPAL.CON
-<\file>
-Files from game folder /NAMPALM
-<code>
-/userdata/roms/eduke32/nampal/
-               |       ├── NAPALM.CON (Renamed from GAME.CON)
-               |       ├── NAPALM.GRP
-               |       └── NAPALM.RTS
-               └── Nampal.eduke32
-</code>
-=== World War II GI ===
-<file - World War II GI.eduke32>
-FILE = /ww2gi/WW2GI.GRP
-</file>
-Files from game folder /WWII GI
-<code>
-/userdata/roms/eduke32/ww2gi/
-               |       ├── WW2GI.GRP
-               |       └── WW2GI.CON
-               └── World War II GI.eduke32
-</code>
-=== World War II GI: Platoon Leader (expansion) ===
-<file - World War II GI - Platoon Leader .eduke32>
-FILE  = /ww2gi/WW2GI.GRP
-FILE+ = /ww2gi/PLATOONL.DAT
-CON   = /ww2gi/PLATOONL.DEF
-</file>
-Files from game folder /WWII GI and /platoonleader
-<code>
-/userdata/roms/eduke32/ww2gi/
-               |       ├── WW2GI.GRP
-               |       ├── PLATOONL.DAT
-               |       └── PLATOONL.DEF
-               └── Platoon Leader.eduke32
-</code>
-How to find out which files are needed to build the .eduke32 file? The Eduke32 for PC has some .CFG files, that contains what is se add-on file used.
-Eduke32 compatible games: https://wiki.eduke32.com/wiki/Installation_Guide_for_Official_Add-ons
-Duke Nukem High Definition Pack and Music Packs: https://hrp.duke4.net/download.php
-Mods: https://www.moddb.com/engines/eduke32
+==== Custom games ====
-==== Features ====
+FIXME [Under Construction]
-Eduke32 includes the following features:
+GZDoom compatible games: https://zdoom.org/wiki/IWAD
-  *     EDuke32 runs natively without relying on emulation of any kind
+WADs created for GZDoom (Mods): https://zdoom.org/wiki/Category:WADs_created_for_ZDoom
-  *     EDuke32 runs at crazy resolutions like 3072x2304.
-  *     EDuke32 allows you to choose between two different hardware accelerated OpenGL renderers, or the classic, warped software mode you grew up with
-  *     EDuke32 fixes an insane amount of programming errors which were harmless in the days of DOS but are fatal with modern protected memory models; translation: EDuke32 crashes less
-  *     EDuke32 has been the only actively developed and maintained Duke3D port for years
-  *     EDuke32 features Plagman's incredible "Polymer" renderer as a replacement for Ken Silverman's "Polymost" renderer
-  *     EDuke32 has a huge number of new extensions to the game's scripting system, allowing gameplay mods that rival even modern games.
-  *     EDuke32 runs the HRP with support for all features, most of which require EDuke32; no other port can run the HRP with all features enabled
-  *     EDuke32 adds a full-featured console, including Quake-style key bindings, command aliases, advanced tab completion, comprehensive command history, colored text and more
-  *     EDuke32 has hundreds of code rewrites, optimizations and fixes for rare or annoying bugs in the original code
-  *     EDuke32 adds tons of optional new features that make the player's life easier including modern status display/HUD, support for loading mods from the startup window, and modern, WSAD-based controls with thoroughly reworked mouse aiming
-  *     EDuke32 supports Ogg Vorbis sound and music
-  *     EDuke32 is developed by people who have been in the Duke3D scene since the beginning
-  *     EDuke32 lets you play that game called 'NAM' you saw at the dollar store 10 years ago
-  *     EDuke32 makes sandwiches!
 ===== Saves =====
-Save location ''saves/eduke32/<game>.<save game extension>''
+Save location ''saves/gzdoom/<game>.<save game extension>''
 ===== Emulators =====
-==== Eduke32 ====
+==== GZDoom ====
 FIXME [Needs review]
-Standardized features available to all cores of this emulator: ''eduke32.videomode'', ''eduke32.padtokeyboard'', ''eduke32.videomode'', ''eduke32.bezel'', ''eduke32.bezel_stretch'', ''eduke32.hud'', ''eduke32.hud_corner'', ''eduke32.bezel.tattoo'', ''eduke32.bezel.tattoo_corner'', ''eduke32.bezel.tattoo_file'', ''eduke32.bezel.resize_tattoo''
+Standardized features available to all cores of this emulator: ''gzdoom.videomode'', ''gzdoom.padtokeyboard'', ''gzdoom.videomode'', ''gzdoom.bezel'', ''gzdoom.bezel_stretch'', ''gzdoom.hud'', ''gzdoom.hud_corner'', ''gzdoom.bezel.tattoo'', ''gzdoom.bezel.tattoo_corner'', ''gzdoom.bezel.tattoo_file'', ''gzdoom.bezel.resize_tattoo''
 ^ ES setting name ''batocera.conf_key'' ^ Description => ES option ''key_value'' ^
 ^ Settings that apply to all cores of this emulator ||
-| **SKIP INTRO VIDEOS ''eduke32.nologo''** | \\ => Skip ''1'', Show (Default) ''0''. |
+| **SKIP INTRO VIDEOS ''gzdoom.nologo''** | \\ => Skip ''1'', Show (Default) ''0''. |
 ===== Controls =====
-Here are the default Eduke32's controls shown on a [[:configure_a_controller|Batocera Retropad]]:
+Here are the default GZDoom's controls shown on a [[:configure_a_controller|Batocera Retropad]]:
 ===== Troubleshooting =====
-==== Game does not launch: ====
+==== Further troubleshooting ====
-  * Check logs files ''es_launch_stderr.log'' and ''eduke32.log'' at ''userdata/system/logs''
+For further troubleshooting, refer to the [[:support|generic support pages]].
-  * Make sure all files are available at roms/eduke32
-  * Make sure the ''.eduke32'' launch file is setup correctly
-    * Check the case sensitive
-    * Check the use of FILE, FILE+ and CON
-       * FILE and FILE+ must use the path ''/roms/eduke32/<gamefolder>/<main file or add-on>''
-       * CON also use the path ''/roms/eduke32/<gamefolder>/<con file>''
-    * ''.eduke32'' files mustn't have empty lines, so delete the empty lines
-  * As a last alternative, reset system files: delete files from ''/userdata/system/configs/eduke32/*'' and ''/userdata/saves/eduke32/*''
-  *