3DGE Wiki - User contributions [en]

IWAD

2020-02-12T17:36:13Z

Corbin: Clean up article, ROTT and added Wolf3D

{{DoomWiki}}An '''IWAD''' - short for ''Internal WAD'' - is the main resource file for a [[Doom]]-engine game, containing all the game's original sounds, levels, and graphics. [[EDGE]] needs an IWAD file in order to play; without one the EDGE engine has no game data to use.

==Supported IWADs==
'''Notes:'''
* Some file names are links to a page on the {{DoomWiki|nolink=|Entryway|Doom Wiki}}
where you will find checksums for known versions of the concerned file.
* Some files have conflicting names; EDGE provides you with possible aliases. Note that an IWAD is actually identified by its content rather than its name. Also, any [[archive format]] supported by EDGE can technically be an IWAD.

===Commercial games===

{| {{prettytable}} style="font-size: 95%;"
!Game!!Name!!File name!!File aliases!!Notes and download links
|-
| rowspan="3" valign="top" |[[File:MiniDoomLogoIcon.png|link=]]
| Doom (Registered) || {{c|{{dwicon|nolink=|DOOM.WAD|doom.wad}}}} || || rowspan="2" | {{goglink|game/the_ultimate_doom|Buy on GOG.com}} — {{steamlink|app/2280/|Buy on Steam}}
|-
| The Ultimate Doom || {{c|{{dwicon|nolink=|DOOM.WAD|doom.wad}}}} || {{c|doomu.wad}}
|-
| Doom "BFG Edition" || {{c|{{dwicon|nolink=|DOOM.WAD|doom.wad}}}} || {{c|bfgdoom.wad}}, {{c|doombfg.wad}} || {{goglink|game/doom_3_bfg_edition|Buy on GOG.com}} — {{steamlink|app/208200/|Buy on Steam}} — Part of {{dw|Doom 3: BFG Edition}}
|-
| rowspan="5" valign="top" |[[File:MiniDoom2LogoIcon.png|link=]]
| [[Doom II]] || {{c|{{dwicon|nolink=|DOOM2.WAD|doom2.wad}}}} || || {{goglink|game/doom_ii_final_doom|Buy on GOG.com}} — {{steamlink|app/2300/|Buy on Steam}}
|-
| Doom II "BFG Edition" || {{c|{{dwicon|nolink=|DOOM2.WAD|doom2.wad}}}} || {{c|bfgdoom2.wad}}, {{c|doom2bfg.wad}} || {{goglink|game/doom_3_bfg_edition|Buy on GOG.com}} — {{steamlink|app/208200/|Buy on Steam}} — Part of {{dw|Doom 3: BFG Edition}}; also loads {{c|{{dwicon|nolink=|NERVE.WAD|nerve.wad}}}}
|-
| [[Final Doom]] — TNT: Evilution || {{c|{{dwicon|nolink=|TNT.WAD|tnt.wad}}}} || || rowspan="2" | {{goglink|game/doom_ii_final_doom|Buy on GOG.com}} — {{steamlink|app/2290/|Buy on Steam}}
|-
| Final Doom — The Plutonia Experiment || {{c|{{dwicon|nolink=|PLUTONIA.WAD|plutonia.wad}}}} ||
|-
| French Doom II || {{c|doom2f.wad}} || || No longer sold; {{idgames|id=16030||a patch is available}} for the original English version.
|-
| [[File:MiniHereticLogoIcon.png|link=]] || Heretic (Registered or Commercial) || {{c|{{dwicon|nolink=|HERETIC.WAD|heretic.wad}}}} || {{c|hereticsr.wad}} || {{steamlink|app/2390/|buy on Steam}}
|-
| [[File:MiniChexLogoIcon.png|link=]] || [[Chex Quest]] || {{c|{{dwicon|nolink=|CHEX.WAD|chex.wad}}}} || || No longer sold, originally distributed in cereal boxes.
|-
| [[File:ROTTLogoIcon.png|link=]] || [[Rise of the Triad]] || {{c|{{dwicon|nolink=|DARKWAR.WAD|darkwar.wad}}}} || || EDGE is the only DOOM engine that can read and support Rise of the Triad: Dark War. {devbuilds}
|-
|
|Wolfenstein 3D
|Registered
|*.WL6
|{WIP}
|}

===Free-to-play games===

{| {{prettytable}} style="font-size: 95%;"
!Game!!Name!!File name!!File aliases!!Notes and download links
|-

| [[File:MiniDoomLogoIcon.png|link=]] || [[Doom]] (Shareware) || {{c|{{dwicon|nolink=|DOOM1.WAD|doom1.wad}}}} || || {{idgames|id=7043|Doom shareware}}
|-
| [[File:MiniHereticLogoIcon.png|link=]] || [[Heretic]] (Shareware) || {{c|{{dwicon|nolink=|HERETIC1.WAD|heretic1.wad}}}} || || {{idgames|id=7044|Heretic shareware}}
|-
| rowspan="3" valign="top" |[[File:MiniFreedoomLogo.png|link=]]
| [[Freedoom]]: Phase 1 || {{c|freedoom1.wad}} || {{c|freedoomu.wad}} || [https://freedoom.github.io/download.html Official site]
|-
| [[Freedoom]]: Phase 2 || {{c|freedoom2.wad}} || {{c|freedoom.wad}} || [https://freedoom.github.io/download.html Official site]
|-
| FreeDM || {{c|freedm.wad}} || || [https://freedoom.github.io/download.html Official site]
|-
| [[File:MiniChex3LogoIcon.png|link=]] || [[Chex Quest 3]] || {{c|{{dwicon|nolink=|CHEX3.WAD|chex3.wad}}}} || || [http://www.chucktropolis.com/gamers.htm Official site]
|-
| rowspan="2" valign="top" | [[File:MiniHacxLogoIcon.png|link=]] || [[Hacx]] v1.2 || {{c|{{dwicon|nolink=|HACX.WAD|hacx.wad}}}} || || [http://drnostromo.com/hacx/page.php?content=download Official site]
|-
|Hacx v2.0 || {{c|hacx.wad}} || {{c|hacx2.wad}} || {{DRDForum|t=5771|WIP download thread}}
|}

In addition to them, some "total conversion"-type mods can be played as their own IWAD; however since they are not detected as such by EDGE, you need to use the -iwad [[command line parameter]].

In order to play a custom level designed for any of the above games you have to have that particular game's full IWAD (loading PWAD with shareware, demo or teaser versions is disabled). If you do not have the necessary IWAD, or if you have an old, [[IWAD Patching|unpatched]] version of the IWAD in question, you might experience undefined behavior. (But often old versions are accepted too.)

The IWAD file(s) should be placed in a directory where EDGE will find them. This includes the same directory as the EDGE executable, as well as those pointed to by the {{c|DOOMWADDIR}} environment variable. On Linux, the directories {{c|$HOME/.EDGE}} and {{c|/usr/local/share}} are checked by default.

==Obtaining IWADs==
As noted above, some IWADs can be downloaded freely; however most "full" games are not and must be bought from one of the following sources:
;[http://www.gog.com/games#/#sort=bestselling&devpub=id_software&page=1 GOG.com]
:This store offers downloadable versions of ''Ultimate Doom'', ''Doom II: Hell on Earth'' (bundled with ''Final Doom'' and the ''Master Levels for Doom II''), and ''Strife''. The Final Doom version offered is the later Anthology version, which fixes many mapping errors (such as the infamous [[doomwiki:MAP31: Pharaoh (TNT: Evilution)#Bugs|missing key in TNT MAP31]]).
;[http://store.steampowered.com/search/?sort_by=Name&sort_order=ASC&publisher=id+Software&category2=2&price=0%2C10&genre=Action Steam]
:This store offers downloadable versions of ''Ultimate Doom'', ''Doom II: Hell on Earth'', ''Final Doom'', ''Heretic: Shadow of the Serpent Riders'', ''Hexen: Beyond Heretic'', ''Hexen: Deathkings of the Dark Citadel'', and ''Strife''; as well as the ''Master Levels for Doom II'' which is a set of PWAD, not an IWAD.
:Warning: following the release of ''{{dw|Doom 3: BFG Edition}}'', the ''Master Levels'' are no longer available to purchase individually but can be bought as part of the Doom Classic Complete Pack.
:'''Note:''' The version of ''Hexen: Death Kings'' available on Steam is not patched. You need to download and apply the [http://www.doomworld.com/idgames/index.php?id=7022 Death Kings 1.1 patch] first. (The "readme.txt" file it tries to patch has been renamed readme-dk.txt by Steam, but is not important.) All other IWADs from Steam are fully patched.
;[http://www.amazon.com/ Amazon.com], [http://www.ebay.com/ eBay.com], etc.
:Second-hand copies of the original games can be found on such sites.
;Flea markets, used-games bins in brick-and-mortar stores, etc.
:It's mostly a matter of luck, but they can still sometimes be found this way.

==Custom IWADs==
EDGE is currently working on the ability to define any WAD/distro/archive as an IWAD or [[EPK]] (through EGM files) - currently this is only available by using the -iwad switch.

==See also==
*[[WAD]]
*[[PWAD]]
[[Category:Glossary]]
[[Category:Supported games|*]]

System Requirements

2020-02-12T17:32:47Z

Corbin: Removal of WindowsXP support.

====== <code>'''Please be aware that, for all Operating Systems, you *must* have a valid [[IWAD]] to run the engine!'''</code> ======
{| class="wikitable" border="0" width="90%" style="background:#f9f9f9; border: 1px solid #aaa;" cellpadding="10"
! width="45%" |[[File:WindowsIcon.png|40px|Windows® Logo 2002]] <b>Microsoft® Windows®</b>
----<i>Windows® Vista or higher (Windows® 10 is highly recommended)</i>
''(note: Windows XP support is currently deprecated in the latest devbuilds!)''
|}
* '''2 GHz Dual-Core CPU''' or faster ('''Quad-Core is strongly recommended for modern EDGE mods''').
** '''Your CPU must be SSE2 capable''' to run 3DGE 2.0 or higher! See [[wikipedia:SSE2#CPU_support|Supported CPUS]] on Wikipedia.
*** '''If you use Windows 8 and above''', your CPU is automatically SSE2 compatible.

* '''2GB RAM''' (''1GB minimum.'' '''For ''Windows Vista'' and up,''' '''8GB or more is ''strongly recommended''''').
* '''Hardware accelerated 3D card''' with [[wikipedia:OpenGL|OpenGL]] drivers:
* ''At least'' a Radeon HD or Geforce '''NV40 6 series''' class with '''1GB of RAM''' or higher is recommended.
* For OpenGL3 mode, you need a card that supports '''Shader Model 3.0''' (recommended).
* '''''Windows Vista and higher (Windows 7/8/10 verified)''', 32-bit or 64-bit, '''is required.'''''
** '''Windows XP SP3''' is the lowest Windows version to be supported (in versions prior to 2.1.0). '''Please be aware:''' <code>'''3DGE 2.1.0 and above no longer works with Windows 2000 and below'''</code>. You can, however, build a version that supports those older operating systems yourself by compiling using the Windows Makefile with GCC, called makefile.xming. <code>Windows binaries of 3DGE are normally compiled with Visual Studio 2019.</code>
* ''[https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads Visual Studio 2015/2017/2019 C++ Runtimes]'' are '''required to be installed''' - x86 or x64, depending on your CPU type.
** '''Windows XP SP3 users: compatibility will be dropped in 2.1.0-Final'''. We will no longer offer support.

* For Linux:
SDL (Simple DirectMedia Layer) version 2.0.10.
glibc 2.

* For MacOSX:
TO-DO (WIP)
* For Dreamcast:
* Console manufactured before the year 2000 to play burned media.
* Alternatively, an [[emulator]].
* [[VMU]] with (X) Free Blocks to save game data.

3DGE

2020-02-12T16:59:54Z

Corbin: clean out previous '3DGE' article and link directly to 'EDGE'

#REDIRECT [[EDGE]]

DOSDoom

2020-02-12T16:58:37Z

Corbin: 3DGE -> EDGE

{{InfoboxSourcePort
|title = DOSDoom
|developer = [[Chi Hoang]], [[DOSDoom Team]]
|baseparent = [[Linux Doom]] 1.10
|logo = [[File:DOSDoomlogo.png]]
|programming language = [[Wikipedia:C (Programming Language)|C]]
|status = Discontinued
|platform = DOS
|license = [[Doom Source License]], [[GPL]]
}}'''DOSDoom''' is the first [[source port]] of Doom, as well as the first [[Wikipedia:MS-DOS|DOS]] port of Doom after the release of the [[Doom source code]]. The initial versions were developed by [[Chi Hoang]] and the later ones by the [[DOSDoom Team]]. The port became the basis for a number of other source ports, including [[Boom]], [[Doom Legacy]] and directly continued as [[EDGE]]. It pioneered many features that other source ports would come to adopt; due to this, EDGE is considered the [[purest descendant]] of the port. Because of this, its history, development, and team members are heavily documented here.

* Contrary to popular belief, DOSDoom was the first port to feature [[3D Floors]], a staple that many other ports [http://home.comcast.net/~mrrocket/doomlegacy/w3c_test3/concept.htm would soon follow].

* Chi Hoang released the initial version of DOSDoom on December 23, 1997, soon after the Doom source code came out. According to Hoang, "it took me 4-5 hours to port". Hoang left the port with 0.63.

* The final version of DOSDoom, 0.653, was released on April 10, 1999.

Later DOSDoom versions added various [[:Category:New features|new features]] including [[free look]], [[translucency]], [[jump]]ing and [[Doom Definition File|DDF scripting]].

=Features=

* Hi-Colour Mode
* Higher Resolutions (up to 1280x1024, compared to 320x200 in the original)
* 3 Levels of Translucency
* Jumping
* 180-degree turn
* user-definable gravity
* Controls Configurable in the Game
* 8-Player Support
* New gameplay options
* Mouse-look
* Radius Scripting for existing and new levels
* Music support for MP3, MOD and loads more
* CD Audio
* Overlap Map Function
* Rotate Map Function

==Notes==
The term "source port" originates from the DOSDoom release 0.2.

There is a campaign at [http://www.doomworld.com/vb/source-ports/70442-salvaging-historic-dosdoom-versions/ Doomworld] to retrieve the "lost" versions of DOSDoom, as only 3 versions (with 2 having their source released) exist.

== External links ==
* {{AtomicGamer|id=1935|title=DOSDoom 0.653}}
* {{AtomicGamer|id=1850|title=DOSDoom 0.653 source code}}
* {{AtomicGamer|id=1844|title=DOSDoom 0.61 DOS version}}
* {{AtomicGamer|id=1843|title=DOSDoom 0.61 Linux version}}
* {{AtomicGamer|id=1845|title=DOSDoom 0.61 source code}}
* {{AtomicGamer|id=15072|title=DOSDoom 0.47 DOS version}}
* {{idgames|id=8801|title=DOSDoom 0.1}}

[[Category:Source ports]]

Using ZIPs as WAD replacement

2019-11-26T06:05:36Z

Corbin: Cleaned up slightly.

{{DoomWiki|PK3}}[[3DGE|EDGE]] allows using several compressed [[archive format]]s instead of the traditional [[WAD]]s. Most notably:
;[[EPK]]
:EDGE uses a modified ZIP container named '''EPK''' ('''E'''dge '''P'''aC'''K'''), which is the recommended extension for EDGE-specific mods. The main data-file for EDGE now uses this container format ('''edge.epk'''). It is a basically a ZIP/PK3 container renamed so other ports do not accidentally load EPK files. Though this is preferred, any archive format EDGE loads will still assume that data is stored in the proper namespaces.

;{{wp|ZIP_(file_format)|ZIP}}
:A .zip file used as the container for a source port mods are usually given the '''.pk3 extension''', instead of .zip. While there is no technical differences, this helps avoid potential confusion from users thinking the mod should be extracted from it, and also prevents Windows from presenting it as a directory. EDGE supports several ZIP archiving methods: stored (no compression), shrunk, imploded, {{wp|DEFLATE|deflated}} (the most commonly used), {{wp|bzip2}} and {{wp|LZMA}} algorithms. Note that many ZIP utility only partially implement the ZIP standard and as a result their support is limited to stored and deflated files. This partial implementation also affects some [[editing tools]] which normally support the PK3 format, such as [[3DGE Builder|EDGE Builder]], Doom Builder 2, and [[Slumped]]. EDGE employs PhysicsFS for archive handling.
;{{wp|7z}}
:A .7z file used as the container for a EDGE mod is usually given the .pk7 extension, for similar reasons. This format offers much better compression ratio, however its reduced support, especially by modding utilities, make it less interesting overall. It also increases the memory footprint on the engine, so caution must be taken when choosing between a 7z and a PK3 format. A possibility would be to develop a mod as a PK3, then convert it to a PK7 once finished, to decrease the size of the archive to be distributed. However, keep in mind that decompression is quite slower than for zips, so loading times are increased.
;[http://quakewiki.org/wiki/.pak PAK]
: A .PAK file is used as an alternative container for EDGE mods; it follows Quake's PAK convention strictly. This also works for Quake II PAKs, as well as .SIN packfiles. It is nearly functionally identical to the WAD container format. EDGE mods wishing to use a custom IWAD replacement as a container over .WADs should prefer .PAK files.
:
Compressed archives have many advantages over PWADs and PAKs, even for storing content for Doom:
* Smaller file size due to compression
* Greatly reduced memory usage during play
* Proper use of directories instead of WAD namespaces (directories also shares the distinction of being referred to as namespaces)
* You no longer need dedicated WAD management tools like XWE for manipulating your data.
* More flexibility due to the use of full path names. Currently there is only limited support but it is planned to change everything that references lump names to support full paths.

== How to ==
You can embed WADs inside the top level root of an archive. Any WAD file found in the root directory will be added to the lump directory as well. This allows loading many of the ZIPs distributed through /idgames without the need to extract them. If several wads are included in an archive, they will be loaded in alphabetical order. If maps wish to stay in the WAD format, they need to be given the explicit lump name (MAPxx, ExMx, or whatever custom format you define in Levels.ddf). They can also be extracted verbatim as uncompressed data (as in, the /maps directory would contain all map data and node information like a top level PWAD would).

::'''WARNING:''' Loading WAD files inside of a ZIP or a PK3 can potentially cause memory issues to arise. EDGE will unpack each WAD file and use more memory to access the contents. This effect quickly adds up, especially in larger mods (with the exception of map wads in the maps/ folder, provided they follow the format explicitly -- see below). The bigger the mod is, the more likely it may run out of memory during play and crashing EDGE, or for '''memory corruption''' to occur. Thus, it is '''highly''' recommended to completely unpack the entire contents of any WADs inside, or part of the mod, into the sorted directories.
::'''Furthermore''', EDGE supports and promotes subdirectories under the main ones for sorting purposes (i.e. Sprites/Weapons/Cannon, Sprites/Monsters/Technodemon, etc). No extra effort is needed to indicate the sprites are present, as EDGE automatically scans all subdirectories as long as they reside in their proper namespaces. If Images are contained this way, some users wouldn’t even need to define the name entry in Images.DDF.

Unlike WADs which do not have a true directory structure, the placement of data within ZIPs is much more strictly enforced in order to allow the engine to recognize it as a default lump. Any special data must be placed in the respective directory inside the ZIP or it will not be found. For the [[lump]] name, the first 8 characters of the file name are used, the extension is stripped. So for example, to place a [[COAL Manual|COALHUD]] into a ZIP file, you have to name your file '''coalhud1.TXT''', '''COALHUD1.LMP''' (or whatever extension you like) and place it in '''"./scripts"'''. The following sub directories are used to assign data to the existing WAD [[namespace]]s in EDGE:

{| {{prettytable}} style="font-size: 95%;"
|-
| '''Directory''' || '''Description'''
|-
| '''<s>acs/</s>''' || <s>contains [[Libraries|ACS libraries]] normally found between '''A_START''' and '''A_END'''</s> '''''Not yet implemented!'''''
|-
| '''cameras/''' || contains [[CAMDAT]] files for [[CAMERA-MAN_Manual|camera-man]] scripts.
|-
| '''colormaps/''' || contains [[Boom]] and [[3DGE|EDGE]] colormaps normally found between '''C_START''' and '''C_END'''.
|-
| '''doom_ddf/'''
'''her_ddf/''' '''wolf_ddf/'''

'''rott_ddf/'''
|| ''OPTIONAL!'' Can contain all [[DDF]], [[RTS]], and [[COAL]] scripts here. This is not explicitly needed however, since they can be added in the root directory of the ZIP all the same. These folders also exists in the root EDGE directory by default, so this is only needed if you do not want to reference your script files externally. It is recommended to use the '''/scripts''' namespace instead as EDGE will automatically use /scripts instead of the default external DDF directories.
|-
| '''<s>filter/</s>''' || <s>{{new}} contains lumps and directories that will only be loaded with specific games.</s> '''Not yet implemented!'''
|-
| '''flats/''' || contains [[flat]]s normally found between '''FF_START''' and '''FF_END'''
|-
| '''graphics/''' || All special graphics like title pictures or font characters must go here. ''This namespace does not exist in WADs.''
|-
| '''hires/''' || contains high-resolution textures normally found between [[HI_START]] and [[HI_END]]
|-
| '''maps/''' || contains levels in form of WADs. These WADs must only contain the data for one single level (including GL nodes lumps if required). Any other data in such a WAD will be ignored. Note that the file name and not the map label inside the WAD determines how the map is named in the game, unless otherwise specified by [[LEVELS|Levels.DDF]]. EDGE will automatically build the GL nodes via glBSP if a map is found.
|-
| '''models/''' || contains [[MD2]], [[MD3]], or [[MD5]] models. ''This namespace does not exist in WADs''.
|-
| '''music/''' || contains all data that is used as music. ''This namespace does not exist in WADs.''
|-
| '''patches/''' || contains [[patch]]es normally found between '''PP_START''' and '''PP_END'''
|-
| '''scripts/''' || contains [[DDF]]/[[RTS]]/[[COAL]] script files. They can be named by their 8 character name, or their full names as seen in EDGE's root directory, under /doom_ddf.
|-
| '''skins/''' || contains all skins to be loaded for 3D models. ''This namespace does not exist in WADs.''
|-
| '''sounds/''' || contains all sound files that are referenced by [[SOUNDS|DDFSFX]]. ''This namespace does not exist in WADs.''
|-
| '''sprites/''' || contains [[sprite]]s normally found between '''[[S_START]]''' and '''[[S_END]]''' (also known as '''SS_START''', '''SS_END''')
|-
| '''textures/''' || contains [[texture]]s normally found between [[TX_START]] and [[TX_END]]
|-
| '''voices/''' || contains ''[[Strife]]'' dialog sounds normally found between '''V_START''' and '''V_END'''
|-
| '''<s>voxels/</s>''' || <s>contains [[voxel]] objects normally found between '''VX_START''' and '''VX_END'''</s>
|}
<code>(Note: Any lump found in the root directory is added to the global namespace.)</code>

== Tips ==
* [https://github.com/sirjuddington/SLADE SLADE] or similar programs are recommended for creating the actual .zip file, to ensure programs like WinZIP or WinRAR do not create them with unsupported file compression. Otherwise, they may appear to be damaged, which may hinder modifications of the epk with SLADE, Slumped, etc.

* [https://github.com/sirjuddington/SLADE SLADE] is also capable of reading and writing the .epk archive directly, where WinZIP and WinRAR natively cannot; WinRAR/7Z can still open epks though.

* The ZIP file's directory is sorted alphabetically before adding it to the lump directory; any WAD files in the .zip are then loaded afterwards. Keep that in mind when creating data that relies on file name ordering. For most things, there is no need to depend on ordering, with the exception of texture animations of type ''range'' that animate textures from the flats/ or textures/ subdirectories.

* Any file not in one of the reserved directories is not added to the WAD directory and can only be used by code that looks for full path names. Currently that is only the music code but it will be gradually extended so that everything that references a lump name can do it.

* Sprite lumps for the '''\''' frame in a WAD (such as '''VILE\*''' for one of the Arch-Vile's healing frames) can be put in a ZIP file, the backslash character just has to be changed to a caret character ('''^'''). So, '''VILE^1''' to '''VILE^8''' in a ZIP file will be interpreted as the '''VILE\1''' to '''VILE\8''' lumps. This replacement only works for sprites, any other lump name should not contain backslashes anywhere. As it is possible to use multiple sprite names for an actor with [[DDF]], frames beyond '''Z''' need not be used however.

* '''It is ''strongly'' recommended to use the .EPK extension, not .zip or .pk3, when creating a file meant to be loaded directly into EDGE'''. The average user is used to opening a .zip file and extracting a .wad from it, so naming the actual game file a .zip will often cause unwanted confusion.

* '''The contents of the files inside the ZIP must be identical to the lumps in a WAD.''' This is especially important for graphics. Even though that is the most likely format you will encounter, importing them with a WAD manager will convert them to Doom's internal format. [[XWE]] converts graphics encoded in Doom's internal format to .BMP during export. [[SLumpEd]] can export these graphics as raw Doom lumps. In order for EDGE to recognize graphics as such, they have to be either in Doom's internal format or a supported [[DDFIMAGE|image format]] such as [[PNG]].

* '''Beware of hidden files!''' If you add a full directory, or directory tree, to a EPK, it is possible that unwanted system files (such as Windows' <tt>thumbs.db</tt> file that tends to be created in any folder containing pictures) will be included as well. They will needlessly increase the file size and can possibly trigger warning messages when loading EDGE. [[Slumped]] frequently crashes when browsing through an EPK's resources, as it expects thumbs.db to be a graphic and obtain incoherent values.

== Compatibility ==
Currently the only editors which support this format are [[3DGE Builder|EDGE Builder]], [[Doom Builder]] 2, [[SLumpEd]] and [[Slade]] 3, but of course you can also use any Zip tool available if you do not need access to Doom specific features like texture definitions or graphics offsets.

[[ZDoom]], [[Eternity]], [[Vavoom]] and [[Doomsday]] largely use PK3 files for their resources; '''however their subdirectory organization differ'''. Adapting a mod from one of these ports to work in EDGE may therefore require repackaging, in addition to conversion of enhanced features to their EDGE equivalent. The [[Eternity Engine]], '''which uses the PKE format''', adopted a model mostly similar to ZDoom's, but different enough for incompatibility to be possible in both ways. EDGE is also similar to ZDoom's.

== See also ==
* [[Tips for using ZIPs as WAD replacement]]

[[Category: Guides]]
[[Category:Technical aspects]]

ANIMS

2019-11-26T05:52:33Z

Corbin: Minor edits.

__NOTOC__
=Animations=

'''Stored in the anims.ddf file or in the DDFANIM data lump.'''

Anims.ddf allows you to change floor and ceiling animations, wall animation sequences, or even graphic animations. Each entry consists of a unique name, enclosed in square brackets, plus a series of commands that specify the first and last frames of the animation, as well as how frequently it changes.

Names should be descriptive, but are used in the map editor when adding animations to your maps, so should be no longer than 8 characters (without spaces).

<div style="background: #f2e0ce; border: 2px solid #bfb1a3; padding: 0.6em; margin-top: 0.8em;">You can add your own graphics, but they need to be defined in [[IMAGES|DDFIMAGE]] before they can be used properly.</div>

==COMMANDS==

The commands used for animation entries are as follows:

{| border="1" cellspacing="0" cellpadding="2" bgcolor="#C8F4FF"
! <B>COMMAND</B>
! <B>TYPE</B>
! <B>EXPLANATION</B>
|-
| TYPE
| [special]
|
Either 'FLAT' for a floor texture animation, or 'TEXTURE' for a wall texture animation.
|-
| FIRST
| [string]
|
The first texture in the animation -- Refer to name of entry in wadfile.
|-
| LAST
| [string]
|
The last texture in the animation -- Refer to name of entry in wadfile.
|-
| SPEED
| [time]
|
The time to display each frame in tics(T). Where 8T is normal Doom speed and 4T is double normal speed.
|-
| SEQUENCE
| [string]
|
Use it to specify the full animation sequence. Names cannot be used twice. <br>For example: SEQUENCE = TEX1, TEX2, TEX3, TEX5, TEX8;
|}

=NOTES=
The full animation sequence consists of all the flats / textures in the WAD file between the first and last entry.

You should make sure that you don't muddle up your entries in the wad:

'''Correct Order:'''
*MYANIMA
*MYANIMB
*MYANIMC

'''Incorrect Order:'''
*MYANIMB
*MYANIMA
*MYANIMC

If you don't do your flats/ textures properly, EDGE might give you an error message.

You can also use quotes around names with an underscore in it:<BR>

<pre> [MY_ANIM]
TYPE = FLAT;
FIRST = "MY_AN_1";
LAST = "MY_AN_2";
SPEED = 8T;</pre>

If you leave out the quotes, DDF converts an underscore to a space, so the
name MY_AN_1 would be read as "MY AN 1". The other obvious solution is to
never use an underscore in texture names you plan on animating.

=Examples=

{| width="95%" border="1" frame="box" cellpadding="2" bgcolor="#FFE4B5"
| <font size="2"> //Flat Animation Entry <br />[NUKAGE1] <br />TYPE = FLAT; <br />FIRST= "NUKAGE1"; <br />LAST = "NUKAGE3"; <br />SPEED=8t; </font>
|}

{| width="95%" border="1" frame="box" cellpadding="2" bgcolor="#FFE4B5"
| <font size="2"> //Texture Animation Entry <br />[BLODGR1] <br />TYPE = TEXTURE; <br />FIRST= "BLODGR1"; <br />LAST = "BLODGR4"; <br />SPEED=8t; </font>
|}

{{DDF}}

Using ZIPs as WAD replacement

2019-06-14T05:47:43Z

Corbin: Updated article with more verbosity

{{DoomWiki|PK3}}[[3DGE|EDGE]] allows using several compressed [[archive format]]s instead of the traditional [[WAD]]s. Most notably:
;[[EPK]]
:EDGE uses a modified ZIP container named '''EPK''' ('''E'''dge '''P'''a'''K'''), which is the recommended extension for EDGE-specific mods. The main data-file for EDGE now uses this container format ('''edge.epk'''). It is a basically a ZIP/PK3 container renamed so other ports do not accidentally load EPK files.

;{{wp|ZIP_(file_format)|ZIP}}
:A .zip file used as the container for an EDGE mod is usually given the '''.pk3 extension''', instead of .zip. While there is no technical differences, this helps avoid potential confusion from users thinking the mod should be extracted from it, and also prevents Windows from presenting it as a directory. EDGE supports several ZIP archiving methods: stored (no compression), shrunk, imploded, {{wp|DEFLATE|deflated}} (the most commonly used), {{wp|bzip2}} and {{wp|LZMA}} algorithms. Note that many ZIP utility only partially implement the ZIP standard and as a result their support is limited to stored and deflated files. This partial implementation also affects some [[editing tools]] which normally support the PK3 format, such as [[3DGE Builder|EDGE Builder]], Doom Builder 2, and [[Slumped]].
;{{wp|7z}}
:A .7z file used as the container for a EDGE mod is usually given the .pk7 extension, for similar reasons. This format offers much better compression ratio, however its reduced support, especially by modding utilities, make it less interesting overall. It also increases the memory footprint on the engine, so caution must be taken when choosing between a 7z and a PK3 format. A possibility would be to develop a mod as a PK3, then convert it to a PK7 once finished, to decrease the size of the archive to be distributed. However, keep in mind that decompression is quite slower than for zips, so loading times are increased.
;[http://quakewiki.org/wiki/.pak PAK]
: A .PAK file is used as an alternative container for EDGE mods; it follows Quake's PAK convention strictly. This also works for Quake II PAKs, as well as .SIN packfiles. It is nearly functionally identical to the WAD container format.
:
Compressed archives have many advantages over PWADs and PAKs, even for storing content for Doom:
* Smaller file size due to compression
* Greatly reduced memory usage during play
* Proper use of directories instead of WAD namespaces
* You no longer need dedicated WAD management tools like XWE for manipulating your data.
* More flexibility due to the use of full path names. Currently there is only limited support but it is planned to change everything that references lump names to support full paths.

== How to ==
You can embed WADs inside ZIPs. Any WAD file found in the root directory will be added to the lump directory as well. This allows loading many of the ZIPs distributed through /idgames without the need to extract them. If several wads are included in an archive, they will be loaded in alphabetical order.

::'''WARNING:''' Loading WAD files inside of a ZIP or a PK3 will cause memory issues to arise. EDGE will unpack each WAD file and use more memory to access the contents. This effect quickly adds up, especially in larger mods (with the exception of map wads in the maps/ folder, provided they follow the format explicitly -- see below). The bigger the mod is, the more likely it may run out of memory during play and crashing EDGE, or for '''memory corruption''' to occur. Thus, it is '''highly''' recommended to completely unpack the entire contents of any WADs inside, or part of the mod, into the sorted directories.
::'''Furthermore''', EDGE supports and promotes subdirectories under the main ones for sorting purposes (i.e. Sprites/Weapons/Cannon, Sprites/Monsters/Technodemon, etc). No extra effort is needed to indicate the sprites are present, as EDGE automatically scans all subdirectories (though PNG and JPG images will still need to be defined in [[IMAGES|IMAGES.DDF]].

Unlike WADs which do not have a true directory structure, the placement of data within ZIPs is much more strictly enforced in order to allow the engine to recognize it as a default lump. Any special data must be placed in the respective directory inside the ZIP or it will not be found. For the [[lump]] name, the first 8 characters of the file name are used, the extension is stripped. So for example, to place a [[COAL Manual|COALHUD]] into a ZIP file, you have to name your file '''coalhud1.TXT''', '''COALHUD1.LMP''' (or whatever extension you like) and place it in '''"./scripts"'''. The following sub directories are used to assign data to the existing WAD [[namespace]]s in EDGE:

{| {{prettytable}} style="font-size: 95%;"
|-
| '''Directory''' || '''Description'''
|-
| '''<s>acs/</s>''' || <s>contains [[Libraries|ACS libraries]] normally found between '''A_START''' and '''A_END'''</s> '''''Not yet implemented!'''''
|-
| '''cameras/''' || contains [[CAMDAT]] files for [[CAMERA-MAN_Manual|camera-man]] scripts.
|-
| '''colormaps/''' || contains [[Boom]] and [[3DGE|EDGE]] colormaps normally found between '''C_START''' and '''C_END'''.
|-
| '''doom_ddf/'''
'''her_ddf/''' '''wolf_ddf/'''

'''rott_ddf/'''
|| ''OPTIONAL!'' Can contain all [[DDF]], [[RTS]], and [[COAL]] scripts here. This is not explicitly needed however, since they can be added in the root directory of the ZIP all the same. These folders also exists in the root EDGE directory by default, so this is only needed if you do not want to reference your script files externally. It is recommended to use the '''/scripts''' namespace instead as EDGE will automatically use /scripts instead of the default external DDF directories.
|-
| '''<s>filter/</s>''' || <s>{{new}} contains lumps and directories that will only be loaded with specific games.</s> '''Not yet implemented!'''
|-
| '''flats/''' || contains [[flat]]s normally found between '''FF_START''' and '''FF_END'''
|-
| '''graphics/''' || All special graphics like title pictures or font characters must go here. ''This namespace does not exist in WADs.''
|-
| '''hires/''' || contains high-resolution textures normally found between [[HI_START]] and [[HI_END]]
|-
| '''maps/''' || contains levels in form of WADs. These WADs must only contain the data for one single level (including GL nodes lumps if required). Any other data in such a WAD will be ignored. Note that the file name and not the map label inside the WAD determines how the map is named in the game, unless otherwise specified by [[LEVELS|Levels.DDF]]. EDGE will automatically build the GL nodes via glBSP if a map is found.
|-
| '''models/''' || contains [[MD2]], [[MD3]], or [[MD5]] models. ''This namespace does not exist in WADs''.
|-
| '''music/''' || contains all data that is used as music. ''This namespace does not exist in WADs.''
|-
| '''patches/''' || contains [[patch]]es normally found between '''PP_START''' and '''PP_END'''
|-
| '''scripts/''' || contains [[DDF]]/[[RTS]]/[[COAL]] script files. They can be named by their 8 character name, or their full names as seen in EDGE's root directory, under /doom_ddf.
|-
| '''skins/''' || contains all skins to be loaded for 3D models. ''This namespace does not exist in WADs.''
|-
| '''sounds/''' || contains all sound files that are referenced by [[SOUNDS|DDFSFX]]. ''This namespace does not exist in WADs.''
|-
| '''sprites/''' || contains [[sprite]]s normally found between '''[[S_START]]''' and '''[[S_END]]''' (also known as '''SS_START''', '''SS_END''')
|-
| '''textures/''' || contains [[texture]]s normally found between [[TX_START]] and [[TX_END]]
|-
| '''voices/''' || contains ''[[Strife]]'' dialog sounds normally found between '''V_START''' and '''V_END'''
|-
| '''<s>voxels/</s>''' || <s>contains [[voxel]] objects normally found between '''VX_START''' and '''VX_END'''</s>
|}
<code>(Note: Any lump found in the root directory is added to the global namespace.)</code>

== Tips ==
* [https://github.com/sirjuddington/SLADE SLADE] or similar programs are recommended for creating the actual .zip file, to ensure programs like WinZIP or WinRAR do not create them with unsupported file compression. Otherwise, they may appear to be damaged, which may hinder modifications of the epk with SLADE, Slumped, etc.

* [https://github.com/sirjuddington/SLADE SLADE] is also capable of creating the .epk file directly, where WinZIP and WinRAR cannot; WinRAR/7Z can still open epks though.

* The ZIP file's directory is sorted alphabetically before adding it to the lump directory; any WAD files in the .zip are then loaded afterwards. Keep that in mind when creating data that relies on file name ordering. For most things, there is no need to depend on ordering, with the exception of texture animations of type ''range'' that animate textures from the flats/ or textures/ subdirectories.

* Any file not in one of the reserved directories is not added to the WAD directory and can only be used by code that looks for full path names. Currently that is only the music code but it will be gradually extended so that everything that references a lump name can do it.

* Sprite lumps for the '''\''' frame in a WAD (such as '''VILE\*''' for one of the Arch-Vile's healing frames) can be put in a ZIP file, the backslash character just has to be changed to a caret character ('''^'''). So, '''VILE^1''' to '''VILE^8''' in a ZIP file will be interpreted as the '''VILE\1''' to '''VILE\8''' lumps. This replacement only works for sprites, any other lump name should not contain backslashes anywhere. As it is possible to use multiple sprite names for an actor with [[DDF]], frames beyond '''Z''' need not be used however.

* '''It is ''strongly'' recommended to use the .EPK extension, not .zip, when creating a file meant to be loaded directly into EDGE'''. The average user is used to opening a .zip file and extracting a .wad from it, so naming the actual game file a .zip will often cause unwanted confusion.

* '''The contents of the files inside the ZIP must be identical to the lumps in a WAD.''' This is especially important for graphics. '''EDGE does not read .BMP files!''' Even though that is the most likely format you will encounter, importing them with a WAD manager will convert them to Doom's internal format. [[XWE]] converts graphics encoded in Doom's internal format to .BMP during export. [[SLumpEd]] can export these graphics as raw Doom lumps. In order for EDGE to recognize graphics as such, they have to be either in Doom's internal format or a supported [[image format]] such as [[PNG]].

* '''Beware of hidden files!''' If you add a full directory, or directory tree, to a EPK, it is possible that unwanted system files (such as Windows' <tt>thumbs.db</tt> file that tends to be created in any folder containing pictures) will be included as well. They will needlessly increase the file size and can possibly trigger warning messages when loading EDGE. [[Slumped]] frequently crashes when browsing through an EPK's resources, as it expects thumbs.db to be a graphic and obtain incoherent values.

== Compatibility ==
Currently the only editors which support this format are [[3DGE Builder|EDGE Builder]], [[Doom Builder]] 2, [[SLumpEd]] and [[Slade]] 3, but of course you can also use any Zip tool available if you do not need access to Doom specific features like texture definitions or graphics offsets.

[[ZDoom]], [[Eternity]], [[Vavoom]] and [[Doomsday]] largely use PK3 files for their resources; '''however their subdirectory organization differ'''. Adapting a mod from one of these ports to work in EDGE may therefore require repackaging, in addition to conversion of enhanced features to their EDGE equivalent. The [[Eternity Engine]], '''which uses the PKE format''', adopted a model mostly similar to ZDoom's, but different enough for incompatibility to be possible in both ways. EDGE is also similar to ZDoom's.

== See also ==
* [[Tips for using ZIPs as WAD replacement]]

[[Category: Guides]]
[[Category:Technical aspects]]

Improving Performance

2018-12-10T05:03:27Z

Corbin: Small stub for AMD Radeon users

If you have installed '''EDGE''' and are still getting performance penalties, this is the page for you. Below are some tips for managing and, in most ways, increasing performance of the engine on your computer.

== Low Framerate? ==
If you are suffering from a low framerate and are on a desktop with a video card (i.e. not integrated graphics), here are some things to try.

=== AMD Radeon Users: ===
* Update your drivers - '''this is critical'''.
* If you've already updated, check your configuration in EDGE. In particular, play with the vsync and shader settings (viewable by typing in 'showvars' in the console). If those are correct and you have a fairly decent video card, this is almost certainly a driver issue.

Open your Radeon Settings from the taskbar, and add 'EDGE' to your Gaming tab (found on the bottom). Once you have the ''''EDGE.exe'''<nowiki/>' loaded, you will see a screen similar to below:
[[File:AMD Settings.png|center|thumb|<code>Match your settings to ours found above</code>
''(using a 4GB Radeon RX580)''
]]
'''Make sure the following settings match those above'''. The entries highlighted in '''BOLD''' are the ones you need to make sure are checked/enabled, '''especially ''OpenGL Triple Buffering'''''<nowiki/>'':''
* '''Anti-aliasing mode''': Enhance application settings
* '''Anti-aliasing method''': Adaptive multisampling
* Morphological Filtering: Off
* '''Anisotropic Filtering Mode''': Override application settings
* '''Anisotropic Filtering Level''': 4x
* '''Texture Filtering Quality''': Performance
* '''Surface Format Optimization''': On
* Wait for Vertical Refresh: Always off
* '''OpenGL Triple Buffering''': On
* Shader Cache: AMD optimized
* Tessellation Mode: AMD optimized
* AMD FreeSync: AMD optimized
* Frame Rate Target Control: Disabled

Once those are saved, you can close/minimize the application, and re-launch EDGE. If everything went according to plan, your frame-rate (viewable by typing in '''idinfo''<nowiki/>' in-game) should jump from 40~50 to 178 or higher! The game engine will run much smoother and vsync will work as intended, even with shaders enabled.

Check back here for more tips on improving performance!

File:AMD Settings.png

2018-12-10T04:29:04Z

Corbin:

Settings snapshot for EDGE

Improving Performance

2018-12-10T04:25:07Z

Corbin: Created page with "If you have installed EDGE and are still getting performance penalties, this is the page for you. Below are some tips for managing and in most ways, increasing performance of..."

If you have installed EDGE and are still getting performance penalties, this is the page for you. Below are some tips for managing and in most ways, increasing performance of the engine on your computer.

Installation and execution of 3DGE

2018-11-12T23:35:25Z

Corbin:

== How to install EDGE under Windows ==
<code>This is a short guide on how to install EDGE under Windows.</code>

<u>For users running Windows XP, '''you will only be able to run the x86 builds of EDGE!'''</u>
# Download and Install the newest version of EDGE ('''stable''': {{latestS}}, '''devbuilds''': {{latestT}}).
# Extract all files from 7Z/RAR to a new directory.
# Use a [[compatible IWAD]]. If two DOOM IWADS are found, EDGE will load them in order and only one at a time, starting with DOOM II. However, you can also load DOOM and DOOM II together and play them in one contained session. 

== How to start EDGE ==

*'''Depending on what version of EDGE you have, the executable name might be different. Starting with 1.36F, the name will always be "EDGE".exe'''.

To play an unmodified game, simply double-click EDGE.exe, or a shortcut to it, or call it from a command line.

For playing mods, you need to tell EDGE to load the relevant mod files. Since EDGE does not integrate a front end for choosing mods, the following are just a series of standard methods to open an executable with one or several files as parameters.
===Using a front-end===

This might be the best method. Select a [[frontend]] and install it. Instead of starting EDGE directly, start the frontend. This will let you select which mod to load and set additional [[command line parameters]] as well. Said front-end should come with documentation.

=== Drag-and-drop ===

The simplest method. Select the mod files to load, and then drag and drop them over EDGE's executable. If the mod files are not in the same directory as EDGE, you will need to open a file manager window in each directory. You can also drag the mod file over a shortcut to the EDGE executable.

=== Send to ===

Add a shortcut to EDGE in your SendTo folder. Depending on the version of Windows you use, the path to the <code>SendTo</code> folder may differ. In XP, it is in ''C:\Documents and Settings\<userid>\SendTo''. In Vista or 7, it is in ''%APPDATA%\Microsoft\Windows\SendTo''.

Simply add a shortcut to EDGE in that folder, and now you can right-click->send to->EDGE any file you want. You can edit the shortcut to add command line parameters to it as well.

Note that you may need to set Windows Explorer to show hidden and system files for it to accept to show you the SendTo folder.

=== Open with ===

In Windows Explorer, select Tools -> Folder Options, then under "File Types" associate the file types wad with EDGE.exe. (If .wad is not listed in the "Extension" column, click on "New" to create it.) Once this is done, you can double-click on a wad file and it'll launch EDGE with that file automatically. If the file type is associated with several programs (for example, EDGE and other source ports), then use right-click -> Open With to select EDGE.

=== Shell extension ===

You can create shell extensions in Windows Explorer to make new context menu entries. As for the "Open With" method, select Tools -> Folder Options, then under 'File Types', select the wad extension (if it is not already present, create it), then click on "Advanced" near it. Click "New..." to create a new action. In the "Action" field, describe what you want the shell extension to display, for example, "Play with EDGE". In the "Application used to perform action" field, place an instruction for the shell extension to activate, with the full path to EDGE.exe (between quotes if there are spaces in a directory name), followed by -file "%1".

Right clicking on WAD files should now list whatever you marked earlier in the Action field, and should perform the action listed in the second field. Again, you will have to do this for each file type.

=== With the command line ===

A simple command line window can be shown with Start->Run (or the Windows key + R keyboard shortcut). Click on "Browse" to find EDGE.exe, and then you can add command line parameters as needed; for example to load "foobar.wad" from the same directory, simply add "foobar.wad" after EDGE.exe on that command line.

Another possibility is to open a command line window. With Vista or 7, hold shift while right-clicking in an empty area of the EDGE folder, or on the EDGE folder itself. The "Open command window here" option will appear. You can now type your command line with the appropriate parameters, as explained above.

=== With batch files ===

You can create batch files for combinations of mods and other command line parameters that you use often. Just type the command line in a text file, rename it with a .bat extension, and then you can double-click on the batch file.
=== DOOMWADPATH, DOOMWADDIR ===
EDGE supports those naming conventions so you don't need the IWAD in the directory to play the game.

=== Logfile ===

When EDGE begins to load it sets up the required environment and checks for possible errors. You can see remnants of this in the [[console]] when the '''''TITLEPIC''''' is displayed.

To access this log,
* Open up [[EDGE2.LOG]] for general information.
* For advanced users, [[DEBUG.txt]] is also generated.

== DDF Folder Setup ==

When EDGE is extracted, you will notice that there are a few folders, suffixed with '''_ddf'''. These folders tell EDGE how to load all of the [[Doom Definition File]], [[Radius Trigger Script]], and [[COAL Manual|COAL]] gamecode.

Some mods have their Data embedded in the WADfile or Archive, or in another folder not named "''doom_ddf''". The mods that ''do not'' do this will need their doom_ddf folders renamed. Alternatively, you can set the path of your (original or modified) DDF files with the [[-DDF]] parameter.

Regardless, EDGE will need access to the original ddf folders at all times, unless the mod is a [[Total Conversion]] or a separate game, which incorporates what EDGE needs at run-time. Alternatively, you can self-contain the script [[LUMPS]].

Installation and execution of 3DGE

2018-11-12T23:33:24Z

Corbin:

== How to install EDGE under Windows ==
<code>This is a short guide on how to install EDGE under Windows.</code>

<u>For users running Windows XP, '''you will only be able to run the x86 builds of EDGE!'''</u>
# Download and Install the newest version of EDGE ('''stable''': {{latestS}}, '''devbuilds''': {{latestT}}).
# Extract all files from 7Z/RAR to a new directory.
# Use a [[compatible IWAD]]. If two DOOM IWADS are found, EDGE will load them in order and only one at a time, starting with DOOM II. However, you can also load DOOM and DOOM II together and play them in one contained session. 

== How to start EDGE ==

*'''Depending on what version of EDGE you have, the executable name might be different. Starting with 1.36F, the name will always be "EDGE".exe'''.

To play an unmodified game, simply double-click EDGE.exe, or a shortcut to it, or call it from a command line.

For playing mods, you need to tell EDGE to load the relevant mod files. Since EDGE does not integrate a front end for choosing mods, the following are just a series of standard methods to open an executable with one or several files as parameters. 

===Using a front-end===

This might be the best method. Select a [[frontend]] and install it. Instead of starting EDGE directly, start the frontend. This will let you select which mod to load and set additional [[command line parameters]] as well. Said front-end should come with documentation.

=== Drag-and-drop ===

The simplest method. Select the mod files to load, and then drag and drop them over EDGE's executable. If the mod files are not in the same directory as EDGE, you will need to open a file manager window in each directory. You can also drag the mod file over a shortcut to the EDGE executable.

=== Send to ===

Add a shortcut to EDGE in your SendTo folder. Depending on the version of Windows you use, the path to the <code>SendTo</code> folder may differ. In XP, it is in ''C:\Documents and Settings\<userid>\SendTo''. In Vista or 7, it is in ''%APPDATA%\Microsoft\Windows\SendTo''.

Simply add a shortcut to EDGE in that folder, and now you can right-click->send to->EDGE any file you want. You can edit the shortcut to add command line parameters to it as well.

Note that you may need to set Windows Explorer to show hidden and system files for it to accept to show you the SendTo folder.

=== Open with ===

In Windows Explorer, select Tools -> Folder Options, then under "File Types" associate the file types wad with EDGE.exe. (If .wad is not listed in the "Extension" column, click on "New" to create it.) Once this is done, you can double-click on a wad file and it'll launch EDGE with that file automatically. If the file type is associated with several programs (for example, EDGE and other source ports), then use right-click -> Open With to select EDGE.

=== Shell extension ===

You can create shell extensions in Windows Explorer to make new context menu entries. As for the "Open With" method, select Tools -> Folder Options, then under 'File Types', select the wad extension (if it is not already present, create it), then click on "Advanced" near it. Click "New..." to create a new action. In the "Action" field, describe what you want the shell extension to display, for example, "Play with EDGE". In the "Application used to perform action" field, place an instruction for the shell extension to activate, with the full path to EDGE.exe (between quotes if there are spaces in a directory name), followed by -file "%1".

Right clicking on WAD files should now list whatever you marked earlier in the Action field, and should perform the action listed in the second field. Again, you will have to do this for each file type.

=== With the command line ===

A simple command line window can be shown with Start->Run (or the Windows key + R keyboard shortcut). Click on "Browse" to find EDGE.exe, and then you can add command line parameters as needed; for example to load "foobar.wad" from the same directory, simply add "foobar.wad" after EDGE.exe on that command line.

Another possibility is to open a command line window. With Vista or 7, hold shift while right-clicking in an empty area of the EDGE folder, or on the EDGE folder itself. The "Open command window here" option will appear. You can now type your command line with the appropriate parameters, as explained above.

=== With batch files ===

You can create batch files for combinations of mods and other command line parameters that you use often. Just type the command line in a text file, rename it with a .bat extension, and then you can double-click on the batch file. 

=== DOOMWADPATH, DOOMWADDIR ===
EDGE supports those naming conventions so you don't need the IWAD in the directory to play the game.

=== Logfile ===

When EDGE begins to load it sets up the required environment and checks for possible errors. You can see remnants of this in the [[console]] when the '''''TITLEPIC''''' is displayed.

To access this log,
* Open up [[EDGE2.LOG]] for general information.
* For advanced users, [[DEBUG.txt]] is also generated.

== DDF Folder Setup ==

When EDGE is extracted, you will notice that there are a few folders, suffixed with '''_ddf'''. These folders tell EDGE how to load all of the [[Doom Definition File]], [[Radius Trigger Script]], and [[COAL Manual|COAL]] gamecode.

Some mods have their Data embedded in the WADfile or Archive, or in another folder not named "''doom_ddf''". The mods that ''do not'' do this will need their doom_ddf folders renamed. Alternatively, you can set the path of your (original or modified) DDF files with the [[-DDF]] parameter.

Regardless, EDGE will need access to the original ddf folders at all times, unless the mod is a [[Total Conversion]] or a separate game, which incorporates what EDGE needs at run-time. Alternatively, you can self-contain the script [[LUMPS]].

Andy Baker (darkknight)

2018-11-12T23:31:51Z

Corbin: Created page with "'''Andrew Baker''' (also known as '''darkknight''' or '''AndrewB''') is a developer who worked on DOSDoom and EDGE. He is notable for working with Chi Hoang in the..."

'''Andrew Baker''' (also known as '''darkknight''' or '''AndrewB''') is a developer who worked on [[DOSDoom]] and [[EDGE]]. He is notable for working with [[Chi Hoang]] in the development of the DOSDoom source port, and later, spearheading EDGE alongside [[Andrew Apted]]. He officially retired from the EDGE project in 2010.

== External links ==
* [http://edge.sourceforge.net/ EDGE Home]
* [https://www.doomworld.com/profile/5-andrewb/ Doomworld Profile]
* [https://github.com/3dfxdev/hyper3DGE/blob/master/log/andy.log/ EDGE Development Log]

{{DEFAULTSORT:Baker, Andrew}}
[[Category:Programmers]]

Installation and execution of 3DGE

2018-11-12T23:30:46Z

Corbin: Several changes

== How to install EDGE under Windows ==
<code>This is a short guide on how to install EDGE under Windows.</code>

<u>For users running Windows XP, '''you will only be able to run the x86 builds of EDGE!'''</u>
# Download and Install the newest version of EDGE ('''stable''': {{latestS}}, '''devbuilds''': {{latestT}}).
# Extract all files from 7Z/RAR to a new directory.
# Use a [[compatible IWAD]]. If two DOOM IWADS are found, EDGE will load them in order and only one at a time, starting with DOOM II. However, you can also load DOOM and DOOM II together and play them in one contained session. 

== How to start EDGE ==

*'''Depending on what version of EDGE you have, the executable name might be different. Starting with 1.36F, the name will always be "EDGE".exe'''.

To play an unmodified game, simply double-click EDGE.exe, or a shortcut to it, or call it from a command line.

For playing mods, you need to tell EDGE to load the relevant mod files. Since EDGE does not integrate a front end for choosing mods, the following are just a series of standard methods to open an executable with one or several files as parameters. 

===Using a front-end===

This might be the best method. Select a [[frontend]] and install it. Instead of starting EDGE directly, start the frontend. This will let you select which mod to load and set additional [[command line parameters]] as well. Said front-end should come with documentation.

=== Drag-and-drop ===

The simplest method. Select the mod files to load, and then drag and drop them over EDGE's executable. If the mod files are not in the same directory as EDGE, you will need to open a file manager window in each directory. You can also drag the mod file over a shortcut to the EDGE executable.

=== Send to ===

Add a shortcut to EDGE in your SendTo folder. Depending on the version of Windows you use, the path to the <code>SendTo</code> folder may differ. In XP, it is in ''C:\Documents and Settings\<userid>\SendTo''. In Vista or 7, it is in ''%APPDATA%\Microsoft\Windows\SendTo''.

Simply add a shortcut to EDGE in that folder, and now you can right-click->send to->EDGE any file you want. You can edit the shortcut to add command line parameters to it as well.

Note that you may need to set Windows Explorer to show hidden and system files for it to accept to show you the SendTo folder.

=== Open with ===

In Windows Explorer, select Tools -> Folder Options, then under "File Types" associate the file types wad with EDGE.exe. (If .wad is not listed in the "Extension" column, click on "New" to create it.) Once this is done, you can double-click on a wad file and it'll launch EDGE with that file automatically. If the file type is associated with several programs (for example, EDGE and other source ports), then use right-click -> Open With to select EDGE.

=== Shell extension ===

You can create shell extensions in Windows Explorer to make new context menu entries. As for the "Open With" method, select Tools -> Folder Options, then under 'File Types', select the wad extension (if it is not already present, create it), then click on "Advanced" near it. Click "New..." to create a new action. In the "Action" field, describe what you want the shell extension to display, for example, "Play with EDGE". In the "Application used to perform action" field, place an instruction for the shell extension to activate, with the full path to EDGE.exe (between quotes if there are spaces in a directory name), followed by -file "%1".

Right clicking on WAD files should now list whatever you marked earlier in the Action field, and should perform the action listed in the second field. Again, you will have to do this for each file type.

=== With the command line ===

A simple command line window can be shown with Start->Run (or the Windows key + R keyboard shortcut). Click on "Browse" to find EDGE.exe, and then you can add command line parameters as needed; for example to load "foobar.wad" from the same directory, simply add "foobar.wad" after EDGE.exe on that command line.

Another possibility is to open a command line window. With Vista or 7, hold shift while right-clicking in an empty area of the EDGE folder, or on the EDGE folder itself. The "Open command window here" option will appear. You can now type your command line with the appropriate parameters, as explained above.

=== With batch files ===

You can create batch files for combinations of mods and other command line parameters that you use often. Just type the command line in a text file, rename it with a .bat extension, and then you can double-click on the batch file. 

=== DOOMWADPATH, DOOMWADDIR ===
EDGE supports those naming conventions so you don't need the IWAD in the directory to play the game.

=== Logfile ===

When EDGE begins to load it sets up the required environment and checks for possible errors. You can see remnants of this in the [[console]] when the '''''TITLEPIC''''' is displayed.

To access this log,
* Open up [[EDGE2.LOG]] for general information.
* For advanced users, [[DEBUG.txt]] is also generated.

== DDF Folder Setup  ==

When EDGE is extracted, you will notice that there are a few folders, suffixed with '''_ddf'''. These folders tell EDGE how to load all of the [[Doom Definition File]], [[Radius Trigger Script]], and [[COAL Manual|COAL]] gamecode.

Some mods have their Data embedded in the WADfile or Archive, or in another folder not named "''doom_ddf''". The mods that ''do not'' do this will need their doom_ddf folders renamed. Alternatively, you can set the path of your (original or modified) DDF files with the [[-DDF]] parameter.

Regardless, EDGE will need access to the original ddf folders at all times, unless the mod is a [[Total Conversion]] or a separate game, which incorporates what EDGE needs at run-time. Alternatively, you can self-contain the script [[LUMPS]].

Main Page

2018-11-12T23:22:02Z

Corbin:

__NOTITLE__



<div id="mf-home"><div id="frontpage-columns" style="overflow: hidden; clear: both;">
<div id="frontpage-column-left">
{{HeadingA|The EDGEwiki}}
[[File:3DGElogo.gif||right|link=http://edge2.sf.net]]
The '''EDGE Wiki''' is an extensive effort to document everything related to the [[EDGE]] source port, while providing as much information about its predecessor [[DOSDoom]]. We have created '''{{NUMBEROFARTICLES}}''' articles to date.

This site is a [[wiki]], so everyone is encouraged to create and edit articles. We need all the help we can get indexing these three source ports! For community discussion and support, visit [http://tdgmods.net/smf the EDGE forum board].

{{HeadingA|Article Index}}
{{col-begin|id=frontpage-atlas-table}}
{{col-2}}
<div id="Using 3DGE" class="dw-fp-div" data-expandtext="+" data-collapsetext="-">
; Using EDGE
<div class="mw-collapsible-content">
* [[Installation|Installation and execution of EDGE]]
* [[System Requirements]]
* [[IWAD|List of supported games]]
* [[Compliance (BOOM, etc)|Compliance]]
* [[Console|The console]] and [[menus]]
* [[Command line parameters]]
* [[Frontend|Frontends and launchers]]
* [[How to autoload files]]
* [[Use Custom Timidity Patches]]
* [[Multiplayer]] and [[demo]]s
</div></div>

<div id="frontpage-community" class="dw-fp-div" data-expandtext="+" data-collapsetext="-">
; Community
<div class="mw-collapsible-content">
* [[Helping the wiki]]
* [[Downloading the 3DGE Wiki|Downloading / Viewing the wiki off-line]]
* [[Frequently Asked Questions]]
* [[DOSDoom]] History
* [[Source port|Source Ports]]
* [[Recommended software]]
* [[EDGE For Dummies]]
* [[EDGE documentation project]]
</div></div>

{{col-2}}
<div id="frontpage-3DGE Modding Guide" class="dw-fp-div" data-expandtext="+" data-collapsetext="-">
; EDGE Modding Guide
<div class="mw-collapsible-content">
* [[Doom Definition File]]
* [[Radius Trigger Script]]
* [[COAL|COAL Scripting Language]]
* [[3DGE_Builder|EDGE Builder, a 3D level editor]]
* [[Line Types]]
* [[Sector Types]]
* [[Thing Types]]
* [[Tutorials]]
* [[Supported data formats]]
* [[Specifications]]
</div></div>

<div id="frontpage-3DGE Mods" class="dw-fp-div" data-expandtext="+" data-collapsetext="-">
; EDGE Mods
<div class="mw-collapsible-content">
* [[:Category:WADs created for 3DGE|WADs created for EDGE 2.x]]
* [[:Category:WADs created for EDGE|WADs created for EDGE 1.x]]
* [[:Category:WADs In Progress|EDGE WADs In Progress]]
* [[:Category:Screenshots|Screenshots]]
</div></div>

{{col-end}}

</div>

<div id="frontpage-column-right">
{{HeadingB|Download Engine}}
[[File:enginegraphic.png|right|50px]]
'''Stable version: {{latestS}}'''<br>
'''Unstable version: {{latestT}}<br>'''
'''GitHub [https://github.com/3dfxdev/hyper3DGE Source]<br>'''
'''EDGE [[version history]]<br>'''
'''Engine [[Next_version|Roadmap]]'''
{{HeadingB|Common Questions and Guides}}
Find out how to get into the world of EDGE quickly with these step-by-step guides:
* [http://www.tdgmods.net/smf/viewforum.php?f=26 Active Mods/Project Listings]
* [[Compatible IWAD|What games does this engine support?]]
* [[LegacyHelp|Is EDGE 1.x or DOSDoom still supported?]]
* [[Tutorials|I need help with the editing features!]]

{{HeadingB|Trivia}}

{{Did you know}}

</div>
</div>
</div>

<br style="clear:both;" />
[[Category:Community]]
__NOTOC__
__NOEDITSECTION__

EDGE

2018-11-12T23:17:32Z

Corbin: /* External links */

{{InfoboxSourcePort
|title = EDGE, 3DGE, Hyper3DGE, Dream3DGE
|developer = [[Coraline_(Chu)|Cora Annis]], [[Joseph Fenton]], [[Rachael Alexanderson (Eruanna)]], [[Brendan Doe]], [[Damir Srpčič]], [[Maciej Kadlubowski]], [[Andrew Apted]], [[Andy Baker (darkknight)]], [[Darren Salt]], [[Erik Sandberg]], [[David Leatherdale]]
|nondeveloper = [[Chris Mullen (CeeJay)]], [[UsernameAK]], [[gameblabla]], [[Josh Pearson]], [[Benjamin Moir]], [[Luke Brennan (Lobo)]], [[Marc A. Pullen (Fanatic)]]
|baseparent = [[DOSDoom]]
|logo = [[File:EDGE LogoNew.jpg]]
|programming language = [[Wikipedia:C++|C++]], [[Wikipedia:QuakeC|QuakeC (modified)]]
|status = Active
|initialdate = 2000-06-20
|initialversion = 1.22
|platform = Cross-Platform
|license = {{GPL||2+}}
|website = [http://edge2.sourceforge.net/ SourceForge]
|repourl = [https://github.com/3dfxdev/hyper3DGE GitHub]
}}
'''EDGE''' (Enhanced Doom Gaming Engine) is a collaborative Open Source project based upon the [[Doom source code]]. EDGE is derived from an earlier project called [[DOSDoom]], and started development in 1999 immediately after DOSDoom 0.65 was released. '''EDGE''' is sometimes referred to as '''3DGE''', or '''hyper3DGE''' due to the long-standing development of the '''3DGE''' fork, which was initially released on April 11, 2011; it was originally created to power the ''Hypertension'' TC, and absorbed back into EDGE seven years later. The first official EDGE version was released on June 20, 2000. The latest stable version is 2.0.4, released on December 13, 2016. The team releases *[https://devbuilds.drdteam.org/3dge/ DRDT] semi-regular development builds via [[DRD Team]].

EDGE includes ports to many popular operating systems, including x86/x64 Windows, Linux, BeOS, Raspberry PI, Sega Dreamcast, and Mac OSX. The project is hardware-accelerated only, and also implements support for PowerVR2 CLX2 (through KallistiOS) for the Dreamcast platform. Previous versions of EDGE incorporated both software-rendered and hardware-accelerated versions, though the former was dropped with the release of version 1.29.

The most attractive feature of EDGE is its [[DDF]] system, which originated from DOSDoom. DDF describes all game behavior inside text files external to the executable file. As a result, it is popular among modders who use the extensibility to add many new weapons and features with many fewer of the limits present in other source ports. With DDF, for example, it is possible to create monsters which can possess multiple missile and melee attacks, or create custom pain and death states for monsters when hit by specific weapons or projectiles. Combined together with [[RTS]] and the more modular, modern language [[COAL]], EDGE can rival what other popular ports are capable of through their respective scripting language implementations.

'''Dream3DGE''' was a [[Sega]] Dreamcast-only port of EDGE 1.29, and has high compatibility with pre-1.31 mods, as it cannot currently run anything created with EDGE 1.31 or above. It must be built with KallistOS. It contains most, if not all, functionality from the parent port. This branch (and EDGE 1.29, on which it was based) was abandoned officially and rewritten and integrated back into 3DGE with version 2.0. The Dreamcast code utilizes KallistiGL instead of OpenGL for important rendering functions concerning the SH-4 CPU.

== Early History ==

DOSDoom began development in 1997, initially by [[Chi Hoang]] and coined the term source-port. [[Andy Baker (darkknight)]] was a frequent collaborator, and soon amassed a team of developers known as the [[DOSDoom Team]]. The entirety of the DOSDoom team began developing pioneering systems that other ports did not have at the time, including [[DDF]] and [[RTS]] scripting languages - the first such human-readable systems for DOOM. It is worth noting that the scripting systems were wholly different from [[DeHacked]] at the time because they did not need to modify the executable directly, and were split into several different files that could control much more at a granular level than DeHacked ever could. The [[DOSDoom Team]] consisted of Hoang, Baker, [[Erik Sandberg]], [[Kester Maddock]], [[Martin Howe]], [[John Cole]] and [[David Leatherdale]].

Into 1998, the community was ripe with the emergence of other source-ports, including [[ZDoom]], [[Doom Legacy]], [[Boom]], as well as the first [[Wikipedia:OpenGL|OpenGL]] accelerated engine, [[glDoom]]. glDoom especially made an impact on the team into 1999 as OpenGL was seen as a major advancement at the time - this would be highly influential later in development. DOSDoom continued to be a major powerhouse for modders well into development of EDGE.

In mid 1998, [[TeamTNT]] discussed with the [[DOSDoom Team]] about merging their project, [[OGRE]], directly into [[DOSDoom]]. The collaboration was announced in late 1998 and generated much interest as TeamTNT previously developed another ground-breaking port named [[BOOM]]; discussions were even joined by the inclusion of [[John Carmack]]. However, difficulties ensued for all parties and the project was abandoned. OGRE was quite possibly the progenitor of [[EDGE]] as several of the ideas both teams wanted to do was further realized with the development of EDGE. The failed merger didn't affect DOSDoom's ultimate standing and the port continued to be popular; though, possibly as a result of the planned/failed merger of DOSDoom and OGRE, Hoang left the DOSDoom Team and the DOOM community after v0.63 was released, followed by other DOSDoom members.

== History ==

In early 1999, several more source-ports were released, all offering their own features. [[3D floor]]s were pioneered with DOSDoom which generated much interest, but the DOSDoom Team began rifting as some members left the community altogether, or joined different projects. Andrew Baker and his team devised that a re-haul of DOSDoom was inevitable; the primary motivation being that the port was no longer limited to the DOS operating system.

It was also around this time that [[Andrew Apted]] had joined the team; it was decided that the DOSDoom name would change to better reflect its status as the most advanced 3D source-port of its time. [[TADE]] was seen as a possible name before the team ultimately settled on EDGE; the port was in development before DOSDoom saw its final public release.

DOSDoom v0.653 was released in April 10, 1999, which would be its final version. The surviving members of the DOSDoom Team [Baker, Erik Sandberg, and David Leatherdale], with Andrew Apted, immediately formed the EDGE team from the existing code-base.

EDGE was officially released on June 20, 2000 after more than a year and a half being in secret development; it was seen as a milestone as the DDF and RTS systems were more fully realized, as well as becoming an early adopter of [[Wikipedia:OpenGL|OpenGL]] rendering. At the time, EDGE was the most advanced port as several other emergent technologies were realized in tandem, including [[glBSP]], the first true 3D node-builder for DOOM.

The development of Marc A. Pullen's [[QDoom]] was seen as a major motivating factor for the EDGE team in its early years; its release was very popular and helped elevate EDGE's status as a true modder-centric engine. [[Cory Whittle]] was also a frequent developer of EDGE modifications that also kept the port healthy.

EDGE development continued into the next decade; while the early years were notable for EDGE being the supreme choice for modders and OpenGL enthusiasts, the team began to experience strain in the mid 2000's. As most members of the DOSDoom team had left by 2004, development was primarily being shouldered by Andrew Baker and Andrew Apted. Later, with the major rewrites of the engine between 1.27 and 1.29, development was shifted primarily between the last two active developers; because of the burden of a largely two-man team, the engine was perceived as being somewhat unstable. With the release of 1.31, EDGE's standing improved and modders began returning to the engine, though [[ZDoom]] was tearing much of the share away. Since the engine had once again experienced large rendering and game-play rewrites between 1.29 and 1.31, the remainder of development was primarily headed by Andrew Apted.

Sometime in 2010, Andrew Baker had fully retired from the team, and Andrew Apted was growing more interested in other projects. He was beginning to make plans to fix up any outstanding issues with EDGE and make the final release. Perhaps as a result of ZDoom's popularity, Andrew Apted could not keep up with all of the feature requests, as he had invested much work and time into the 1.3x branch of EDGE. He began hinting at his desire to shift to other projects, notably [[Eureka]] and [[OBLIGE]], which were later released to much acclaim.

Into 2011, the community was well aware of his plans to retire from development with the release of 1.35. At the time, a major TC named [[Hypertension]] was perhaps the biggest project to be developed on the engine recently. The team of that TC [Isotope SoftWorks] foresaw the closing, and development of a fork named '''3DGE''' began to continue development as the modding team still required features that were only possible if they did it themselves.

The EDGE 1.x team consisted of [[Andrew Apted]] and [[Andy Baker (darkknight)]] as the primary developers, and [[Marc A. Pullen (Fanatic)]] and [[Luke Brennan (Lobo)]] as distributors/promoters. [[Darren Salt]] was also a frequent developer and contributed a lot of code and bugfixes.

== Later History and Current Status ==

On April 9, 2011, Andrew Apted announced his retirement from EDGE development, leaving EDGE without a maintainer for over seven years. The last version of EDGE 1.x (1.35), was released on the same day. Two days later, the first version of '''3DGE''' was released as a hot-fix to 1.35, having merged from an abandoned earlier rewrite of EDGE itself.

EDGE development (under the name ''3DGE'') therefore continued from 2011 well into 2018, introducing major long-requested features which were seen as somewhat standard for other modder-centric ports, including [[UDMF]], archive support, [[GLSL]] shaders, and much improved and expanded features for the [[DDF]], [[RTS]], and [[COAL]] systems; lots of hard work was put into the port since the last version was released in 2016.

EDGE's persistent popularity and perseverance earned the respect and occasional development contributions from several other major developers in the community, including GZDoom programmers [[dpJudas]], [[Rachael Alexanderson (Eruanna)]] and [[Graf Zahl]]. Andrew Apted would occasionally assist the team by providing assistance as needed.

On September 18th, 2018, [[Coraline_(Chu)|Cora Annis]] made an announcement of the next major version of EDGE, which would have been the first full version released by the new team since 2016. With Andrew Apted's support and blessing, the separated 3DGE fork (which was long thought as confusing due to naming and version issues) was officially absorbed back into EDGE. The impending release of 2.1.0 (stable) will mark the first version of EDGE officially released since 2011. EDGE is therefore split into two categories as far as releases are concerned - the 1.x branches, and the 2.x branches.

== Features ==
* [[Wikipedia:OpenGL|OpenGL]] 1.1/3.1 Renderer Paths, with Mipmapping, Smoothing, Dynamic Lighting, mirrors, portals, and [[Wikipedia:GLSL|GLSL]] shader support; Bump-Mapping/GLSL is only supported in the 3.1 rendering path.
* 64-bit support
* SDL2 integration
* [[UDMF]] support
* PAK/[[PK3]]/PK7/[[EPK]] [[Using_ZIPs_as_WAD_replacement|archive support]]
* Rendering interpolation and Vsync support
* JPEG, PNG, TGA, BMP, PSD, GIF, HDR, PIC, PNM high-res textures; including support for [[TX_START]]/TX_END and [[HI_START]]/HI_END texture namespaces, and grAb offset support for [[PNG]] images.
* [[OPL]] synth playback (using nukeyT's OPLlib)
* Basic shadows restored from EDGE 1.27
* Integration of [[ZDBSP]] and improvements to [[glBSP]], including building nodes from archives; overall better 3D rendering of both existing Doom levels and newer levels.
* Several major and minor bugs squashed from the [[EDGE]] 1.x releases
* [[Heretic]]/[[Chex Quest]] IWAD support
* [[MD3]] and [[MD5]] model support
* Two-player [[splitscreen]] [[co-op]] or [[deathmatch]] (local only)
* [[multimedia:RoQ|RoQ]] video support for cinematics
* Runs on the [[Wikipedia:Dreamcast|Sega Dreamcast]] console.
* Normal, specular and bright-map support on models
* [[DDF]]/[[RTS]]/[[COAL]] enhancements and bug-fixes
* [[Polyobject]]s (more types will be supported in the future)
* [[CAMERA-MAN|Camera-Man scripts]]: New scripting language which utilizes cameras for complete camera control.
* Support for up to 64 defined [[weapon]]s at once through DDF
* 16 Ammo types: BULLETS, SHELLS, ROCKETS, CELLS, and AMMO5 to AMMO16. (EDGE 1.29 only. AMMO1 to AMMO4 can be used as aliases for the 4 main ammo types.)
* [[3D floor|Extrafloors]] feature allows modders to create submersible liquids, [[room-over-room]], or catwalks, as well as vertically moving platforms not embedded into the floor.
* Four [[armor]] types: GREEN (33% reduction), BLUE (50% reduction), YELLOW (75% reduction) and RED (90% reduction).
* [[Automap]] can be made to be stationary instead of rotating with the player's facing angle, through [[COAL]]. Automap can also be applied as a secondary layer over the normal viewing screen opposed to replacing it, allowing the player to fight enemies and keep track of their position at one time.
* Weapons can have secondary attacks. Weapons can also be made to be manually reloaded, or have idle stats as well. Integration through COAL and RTS means Weapons and animations can be granularity customized.
* Support for [[MUS]], MIDI, IT/MOD, and Ogg Vorbis music formats.
* [[DDF]] files allow the editing of many features (such monsters, attacks, and levels).
* [[Sprite]]s can be viewed from 16 angles.
* [[RTS]] scripting format includes an option known as "Start_Map ALL" that allows global scripts to be created that affect all maps in the game without copying the script under each individual map.
* [[COAL]] virtual machine scripting language allow a more powerful alternative to functions normally found in DDF/RTS, as well as controlling the entirety of the HUD module.
* [[Door#Sliding doors|Sliding doors]], which are done separately without using PolyObjects.

== In-Progress ==
* [[Wikipedia:OpenAL|OpenAL]] for audio subsystem (being restored from EDGE 1.28, replacing SDL2), which will allow for various 3D environmental effects
* RoQ Render-to-Texture (for models, world textures, and menus/backgrounds)
* New [[DDF]] types: Terrains.ddf, Sprites.ddf, Inventory.ddf and Shaders.ddf
* Cross-platform IWAD selector
* Dynamic GLSL shader compilation
* Normal, specular, and brightmap support on world textures
* True [[inventory]] support
* Dynamic planar shadow system for [[dynamic light]]s
* [[Wikipedia:Open_Asset_Import_Library|AssImp]] 3D model back-end support for more model formats
* ''Quake 3: Arena''-style shader-based sky system
* Better [[Boom]] compatibility
* [[Decal]]s on all surfaces (using planned Decals.ddf)
* ''[[Wolfenstein_3D]]'' support (WLF_*)
* ''[[Rise of the Triad]]'' support (ROTT_*)
* ''Blake Stone'' support (BLK_*)
* ''[[Strife]]'' support

Heretic support is being finalized, and is in beta as of version 2.1.0 test 3, using a similarly named definition file called HDF (Heretic Definition File). The HDF definitions were written initially by CeeJay, before the 3DGE Team took over to write proper IWAD support.

== Popular add-ons ==
EDGE also brings its own unique set of popular add-ons to the Doom community. Although some dislike EDGE for its perceived instability, the following mods have in one way or another made their mark on the community.

A few notable mods in active development are Duke it Out in DOOM and Doom Forever, both by Chris Mullen (CeeJay), and a sequel to the [[Marc A. Pullen (Fanatic)]] mod QDOOM. ''SLaVE'' and ''Hypertension: Harmony of Darkness'' are two commercial products using this engine, both being developed by Isotope Softworks and published by Goat Store Publishing.

''Note that, as with any port enjoying such a long lifespan, backward compatibility for older mods can be hit and miss. Certain mods might run only with the application version they were designed for; the move to EDGE 2.x in particular is known to have broken support for a number of mods. Keep this in mind, and report any problems encountered if any of the below legacy mods are not running correctly.''

* [[Don's Challenge]] — Created by [[Cory Whittle]], Don's Challenge is a 3-episode modification based around the supernatural adventures of Don P. Tello, a veteran cop who is summoned into Hell by Mortis, the incarnation of Death, to challenge thousands of hellspawned creatures that his soul might be deemed worthy by her as a vessel. At the end of Episode 1, Don transforms Mortis into a cat. However, her brother Fate summons Mortis to Hell and takes Don with her. In the third episode, Don and Mortis return to Earth, only to find it overrun by Demons and Don's own family dead; Don and Mortis attempt to take vengeance for the deaths. This mod became popular due to the use of new monsters, weapons, and levels. One weapon (cigarettes) could even be used to heal the player. Another weapon (Booze) could be used to increase armor value, but took away a small portion of health as well. As of now, only one episode is fully released, but Episode 2 is reportedly on the way.
* [[Immoral Conduct]] - Created by [[Cory Whittle]], Immoral Conduct is a weapons modification for both EDGE and ZDoom (although the ZDoom version does not have as many features as its EDGE counterpart). The EDGE version contains the following: Knife, .45 Pistols, Stock 12g Pump Shotgun, Customized Pump Shotgun (fires 'slasher rounds'), 12g Hand Cannon, 9mm Uzi SMG, Fragment Hand Grenades, 40mm Grenade/Tear Gas Gun, Assault Rifle with M203, Infantry Rifle with Bayonet, Minigun, 12g Sawed-off Shotgun, Beretta 9mm Pistol, Chrome Magnum Revolver, Sentry Turret Kit (summons helper turrets to attack enemies), Gas-Powered Chainsaw, Remote/Proximity Satchel Charges, and Marking/Visibility Flares. New items included a 50% medikit and Nightvision Goggles. New helper monsters included the Marine Corporal and Marine Private. Monsters have also been modified (for example, the baron of Hell's blood is green), and shells are ejected from weapons. It is a [[partial conversion]], sometimes mistaken for a [[total conversion]], and in Whittle's words, "With my stuff, you have all the millions of user-made Doom and Doom II levels at your disposal to be enhanced with new weapons and items."

* [[Covert Ops]] — an EDGE version of [[Twilight Warrior]]. It has many features, such as new weapons and interesting scripts.

* [[QDoom]] (Quake Doom) — Created by [[Marc "Fanatic" Pullen]], QDoom is a total conversion of Quake to Doom.

* [[EarthBound Doom|EBDoom]] (Earthbound Doom) - Created by [[Baron of Sigma]], this modification has generated mixed opinions. It is not a complete game, and many consider it more of a "monster modification" since roughly 100+ different species of monsters exist, most of them imported and emulated from [[Heretic]], [[Hexen]], Duke Nukem 3D, Shadow Warrior, and Blood, and 'evolved' versions of existing game monsters, such as Chainsaw Zombies, Gold Liches, and Elder Mancubi. The game also appears to use a near-perfect emulation of the [[Sigil]] from Strife as an Easter egg weapon. In addition, the player has hit points instead of a health percentage, and can take much more damage than the common version of [[Doomguy]]. There are also several 'helper' characters based on the heroes of many of the Doom-engine games, including [[Doomguy]], [[Corvus]], and the player classes in Hexen. Certain bosses are also among the few in many modifications to have over 50,000 HP, with at least one boss having over 6,000,000 HP. The weapons are more 'mystical' and energy-based, with few traditional Doom-style weapons. Another unique feature in EBDoom is that all melee attacks used either by the player or other monsters/allies can inflict "critical hits" up to 4x damage at times, as in an RPG. Despite the community's mixed opinions of the mod, it is often used as a resource wad by other modders who want to quickly import foreign monsters into their own mods (as the author appears not to mind this). It is also one of the three mods in the Doom community to use [[Hissy]] as a central plot player, and makes many references to another EDGE mod known as [[Cacodemon Squad]]. This modification was last updated at 6.56 on January 12, 2006.

* [[GoldenEye Doom2]] - A fairly large in-progress TC. Featuring a load of weapons in both single and multiplayer maps. Multiple versions are available: A single player DEH version compatible with Doom Legacy and Zdoom 1.22. Multiplayer levels for standard Doom2. An enhanced single player EDGE 1.27+ version. The Edge version contains the following weapons: punch/kick, Knives, Watch lazer, _Soviet_Tank_, Silencedable PP7, Dostovie, Cougar Magnum, Automatic Shotgun, pathetic Klobb, Duestch, Zmg, KF7, Sniper Rifle, Ak47, Moon Raker Laser, RCP-90, Golden Gun, Golden PP7, Rocket Launcher, and Grenades. Most of the weapons have alternate firing modes and some weapons can be dual-wielded.

* [[Cold Hard Cash]] - An unique weapons mod offering a larger variety of weapons. Cold Hard Cash's spin on the weapons mod is that instead of just finding weapons laying around or dropped from enemies, the player must mug monsters for money to use at special weapons dispensers, which replace the original weapons, and sometimes artifacts and appear in their place. An example is that the Chainsaw is now a dispenser that allows the player to buy a Knife, a Crowbar, and other melee-type items. Most dispensers have a special offer on it, usually an upgrade to an existing weapon, which requires the said weapon in question to be held by the player before they can use it. It is also the first EDGE mod to use the "Start_Map ALL" RTS function, introduced in the 3rd release candidate of EDGE 1.29, which allows the same scripts to be usable on all maps instead of having to add the same ones to each map individually.

== Sources ==
*{{dwforums|id=102456|title=EDGE 2.1.0 Impending Release}}
*{{zdforums|p=1073199|3DGE 2.1.0 Test3 Released}}
*[[Next_version|Development Roadmap]]
*[https://www.youtube.com/watch?v=PpzvWcz7uDY Heretic support demonstration]

== External links ==
*[http://edge2.sourceforge.net Official EDGE site]
*[https://sourceforge.net/projects/edge2/files/3DGE%20binaries/ EDGE release packages], hosted by {{wp|SourceForge}}
*[https://sourceforge.net/projects/edge/files/EDGE%20Binaries/ Legacy EDGE binary releases], hosted by {{wp|SourceForge}}
*[https://github.com/3dfxdev/hyper3DGE 3DGE git repository], hosted by {{wp|github}}
*[https://devbuilds.drdteam.org/3dge/ Compiled SVN builds] for Windows, Linux, Mac, and Dreamcast at [[DRD Team]]
*[[Main Page|Documentation]]
*Dream3DGE:
:* [https://sourceforge.net/projects/edge2/files/3DGE%20SOURCE/DreamEDGE/ Source code repository], hosted by {{wp|SourceForge}}
:* [http://gamedev.allusion.net/softprj/kos/ KallistOS]
:* [http://www.segatech.com/technical/cpu/ SH-4 CPU]
*Mapsets and add-ons:
:* [http://www.tdgmods.net/smf/viewforum.php?f=26/ All known projects including WIPs]
:* [http://www.moddb.com/mods/duke-it-out-in-doom/ Duke it Out in DOOM]
:* {{Dwforums|id=66125|title=Doom Forever}}
:* {{Dwforums|id=64491|title=QDOOM sequel}}
:* [http://facebook.com/slavefps/ SLaVE]
:* [https://www.facebook.com/pages/Isotope-TDGMods/232903863419077/ Hypertension: Harmony of Darkness]
:* [https://www.facebook.com/Isotope-TDGMods-232903863419077/ Isotope Softworks]
:* [http://www.goatstorepublishing.com/ Goat Store Publishing]

{{s-start}}
{{s-port}}
{{s-cond}}
{{s-bef-cond|rows=2|before=[[DOSDoom]]}}
{{s-ttl|rows=2|title=EDGE 1.x}}
{{s-aft-cond|after=3DGE}}
{{s-aft-cond|after=Dream3DGE}}
{{s-bef-cond|before=EDGE 1.x}}
{{s-ttl|title=3DGE}}
{{s-aft-cond|after=EDGE 2.x}}
{{s-bef-cond|before=EDGE 1.x}}
{{s-ttl|title=Dream3DGE}}
{{s-aft-cond|after=None}}
{{s-end}}

[[Category:Source ports]]
[[Category:Boom compatible]]
[[Category:Doom ports]]
[[Category:Limit removing source ports]]
[[Category:OpenGL ports]]

Template:Ig

2018-11-12T23:16:31Z

Corbin: Created page with "<span class="plainlinks">[https://www.doomworld.com/idgames/?{{#if:{{{file|}}}|file={{{file}}}|{{#if:{{{id|}}}|id={{{id}}}|}}}} {{{1|{{{title|Doomworld/idgames}}}}}}]</span><n..."

<span class="plainlinks">[https://www.doomworld.com/idgames/?{{#if:{{{file|}}}|file={{{file}}}|{{#if:{{{id|}}}|id={{{id}}}|}}}} {{{1|{{{title|Doomworld/idgames}}}}}}]</span><noinclude>[[Category:External link templates]]</noinclude>

Template:Maplinkgen

2018-11-12T23:15:26Z

Corbin: Created page with "}}<noinclude> ==Usage== Fully generic map article generation template that hand..."

[[{{{1}}}:_{{{2}}}{{#if:{{{3|}}}|_({{{3}}})|}}|{{{1}}}: {{{2}}}{{#if:{{{4|}}}| ({{{3}}})|}}]]<noinclude>
==Usage==
Fully generic map article generation template that handles 99% of map article linking needs. Arguments:
* {{c|1}}: The [[WAD]] file "slot" that this map occupies. For E1M1 of the original [[Doom]], this is {{c|E1M1}}.
* {{c|2}}: Undecorated name of the map. For E1M1 again, this is {{c|Hangar}}.
* {{c|3}}: [[Commercial games|Game]] or [[PWAD]], if specified (optional). For E1M1, this is {{c|Doom}}.
* {{c|4}}: If specified with any value, the game name will appear in the visible link text. Default is to not show it.

==Examples==
* <nowiki>{{maplinkgen|E1M1|Hangar|Doom}}</nowiki>: [[E1M1: Hangar (Doom)|E1M1: Hangar]]
* <nowiki>{{maplinkgen|Hub 1|Brackenwood}}</nowiki>: [[Hub 1: Brackenwood]]
* <nowiki>{{maplinkgen|MAP01|Entryway|Doom II|true}}</nowiki>: [[MAP01: Entryway (Doom II)]]

[[Category:Internal link templates]]
</noinclude>

Andrew Apted

2018-11-12T23:15:01Z

Corbin:

'''Andrew J. Apted''' ('''ajapted''' or '''andrewj''') is a developer who worked on [[EDGE]] and created the random level generator [[OBLIGE]]. He also contributed to a number of community projects.

== Body of work ==

===2000===
* [[EDGE]]
* [[glBSP]]

===2005===
* [[2 Sectors]] ({{ig|id=13939}})
** [[MAP03 (2 Sectors)|MAP03]]

===2007===
* [[OBLIGE]]
* [[32in24-5]] ({{ig|id=16807}})
** {{maplinkgen|MAP02|Court of the Crimson Schwing|32in24-5}} ''(with [[Shaikoten]] and [[Sarah Mancuso (esselfortium)]])''
** {{maplinkgen|MAP06|Compound of Dripping Filth|32in24-5}} ''(with [[Matt Cibulas (RottKing)]])''
** {{maplinkgen|MAP15|Frozen Maiden|32in24-5}} ''(with Sarah Mancuso (esselfortium))''
* [[Diet 32in24]] ({{ig|id=15456}})
** {{maplinkgen|MAP10|Satanic Base|Diet 32in24}} ''(with [[Chris Harriman (Impboy)]])''

===2011===
* [[Eureka]]

===2016===
* [[32in24-16: DOOT CTF]] ({{ig|id=18910}})
** {{maplinkgen|MAP27|Castles of the Cyber-Creeps|32in24-16}}

== External links ==
* [http://edge.sourceforge.net/ EDGE Home]
* [http://glbsp.sourceforge.net/ glBSP Home]
* [http://oblige.sourceforge.net/ OBLIGE Home]

{{DEFAULTSORT:Apted, Andrew}}
[[Category:Mappers]]
[[Category:Programmers]]

EDGE

2018-11-12T23:14:00Z

Corbin:

{{InfoboxSourcePort
|title = EDGE, 3DGE, Hyper3DGE, Dream3DGE
|developer = [[Coraline_(Chu)|Cora Annis]], [[Joseph Fenton]], [[Rachael Alexanderson (Eruanna)]], [[Brendan Doe]], [[Damir Srpčič]], [[Maciej Kadlubowski]], [[Andrew Apted]], [[Andy Baker (darkknight)]], [[Darren Salt]], [[Erik Sandberg]], [[David Leatherdale]]
|nondeveloper = [[Chris Mullen (CeeJay)]], [[UsernameAK]], [[gameblabla]], [[Josh Pearson]], [[Benjamin Moir]], [[Luke Brennan (Lobo)]], [[Marc A. Pullen (Fanatic)]]
|baseparent = [[DOSDoom]]
|logo = [[File:EDGE LogoNew.jpg]]
|programming language = [[Wikipedia:C++|C++]], [[Wikipedia:QuakeC|QuakeC (modified)]]
|status = Active
|initialdate = 2000-06-20
|initialversion = 1.22
|platform = Cross-Platform
|license = {{GPL||2+}}
|website = [http://edge2.sourceforge.net/ SourceForge]
|repourl = [https://github.com/3dfxdev/hyper3DGE GitHub]
}}
'''EDGE''' (Enhanced Doom Gaming Engine) is a collaborative Open Source project based upon the [[Doom source code]]. EDGE is derived from an earlier project called [[DOSDoom]], and started development in 1999 immediately after DOSDoom 0.65 was released. '''EDGE''' is sometimes referred to as '''3DGE''', or '''hyper3DGE''' due to the long-standing development of the '''3DGE''' fork, which was initially released on April 11, 2011; it was originally created to power the ''Hypertension'' TC, and absorbed back into EDGE seven years later. The first official EDGE version was released on June 20, 2000. The latest stable version is 2.0.4, released on December 13, 2016. The team releases *[https://devbuilds.drdteam.org/3dge/ DRDT] semi-regular development builds via [[DRD Team]].

EDGE includes ports to many popular operating systems, including x86/x64 Windows, Linux, BeOS, Raspberry PI, Sega Dreamcast, and Mac OSX. The project is hardware-accelerated only, and also implements support for PowerVR2 CLX2 (through KallistiOS) for the Dreamcast platform. Previous versions of EDGE incorporated both software-rendered and hardware-accelerated versions, though the former was dropped with the release of version 1.29.

The most attractive feature of EDGE is its [[DDF]] system, which originated from DOSDoom. DDF describes all game behavior inside text files external to the executable file. As a result, it is popular among modders who use the extensibility to add many new weapons and features with many fewer of the limits present in other source ports. With DDF, for example, it is possible to create monsters which can possess multiple missile and melee attacks, or create custom pain and death states for monsters when hit by specific weapons or projectiles. Combined together with [[RTS]] and the more modular, modern language [[COAL]], EDGE can rival what other popular ports are capable of through their respective scripting language implementations.

'''Dream3DGE''' was a [[Sega]] Dreamcast-only port of EDGE 1.29, and has high compatibility with pre-1.31 mods, as it cannot currently run anything created with EDGE 1.31 or above. It must be built with KallistOS. It contains most, if not all, functionality from the parent port. This branch (and EDGE 1.29, on which it was based) was abandoned officially and rewritten and integrated back into 3DGE with version 2.0. The Dreamcast code utilizes KallistiGL instead of OpenGL for important rendering functions concerning the SH-4 CPU.

== Early History ==

DOSDoom began development in 1997, initially by [[Chi Hoang]] and coined the term source-port. [[Andy Baker (darkknight)]] was a frequent collaborator, and soon amassed a team of developers known as the [[DOSDoom Team]]. The entirety of the DOSDoom team began developing pioneering systems that other ports did not have at the time, including [[DDF]] and [[RTS]] scripting languages - the first such human-readable systems for DOOM. It is worth noting that the scripting systems were wholly different from [[DeHacked]] at the time because they did not need to modify the executable directly, and were split into several different files that could control much more at a granular level than DeHacked ever could. The [[DOSDoom Team]] consisted of Hoang, Baker, [[Erik Sandberg]], [[Kester Maddock]], [[Martin Howe]], [[John Cole]] and [[David Leatherdale]].

Into 1998, the community was ripe with the emergence of other source-ports, including [[ZDoom]], [[Doom Legacy]], [[Boom]], as well as the first [[Wikipedia:OpenGL|OpenGL]] accelerated engine, [[glDoom]]. glDoom especially made an impact on the team into 1999 as OpenGL was seen as a major advancement at the time - this would be highly influential later in development. DOSDoom continued to be a major powerhouse for modders well into development of EDGE.

In mid 1998, [[TeamTNT]] discussed with the [[DOSDoom Team]] about merging their project, [[OGRE]], directly into [[DOSDoom]]. The collaboration was announced in late 1998 and generated much interest as TeamTNT previously developed another ground-breaking port named [[BOOM]]; discussions were even joined by the inclusion of [[John Carmack]]. However, difficulties ensued for all parties and the project was abandoned. OGRE was quite possibly the progenitor of [[EDGE]] as several of the ideas both teams wanted to do was further realized with the development of EDGE. The failed merger didn't affect DOSDoom's ultimate standing and the port continued to be popular; though, possibly as a result of the planned/failed merger of DOSDoom and OGRE, Hoang left the DOSDoom Team and the DOOM community after v0.63 was released, followed by other DOSDoom members.

== History ==

In early 1999, several more source-ports were released, all offering their own features. [[3D floor]]s were pioneered with DOSDoom which generated much interest, but the DOSDoom Team began rifting as some members left the community altogether, or joined different projects. Andrew Baker and his team devised that a re-haul of DOSDoom was inevitable; the primary motivation being that the port was no longer limited to the DOS operating system.

It was also around this time that [[Andrew Apted]] had joined the team; it was decided that the DOSDoom name would change to better reflect its status as the most advanced 3D source-port of its time. [[TADE]] was seen as a possible name before the team ultimately settled on EDGE; the port was in development before DOSDoom saw its final public release.

DOSDoom v0.653 was released in April 10, 1999, which would be its final version. The surviving members of the DOSDoom Team [Baker, Erik Sandberg, and David Leatherdale], with Andrew Apted, immediately formed the EDGE team from the existing code-base.

EDGE was officially released on June 20, 2000 after more than a year and a half being in secret development; it was seen as a milestone as the DDF and RTS systems were more fully realized, as well as becoming an early adopter of [[Wikipedia:OpenGL|OpenGL]] rendering. At the time, EDGE was the most advanced port as several other emergent technologies were realized in tandem, including [[glBSP]], the first true 3D node-builder for DOOM.

The development of Marc A. Pullen's [[QDoom]] was seen as a major motivating factor for the EDGE team in its early years; its release was very popular and helped elevate EDGE's status as a true modder-centric engine. [[Cory Whittle]] was also a frequent developer of EDGE modifications that also kept the port healthy.

EDGE development continued into the next decade; while the early years were notable for EDGE being the supreme choice for modders and OpenGL enthusiasts, the team began to experience strain in the mid 2000's. As most members of the DOSDoom team had left by 2004, development was primarily being shouldered by Andrew Baker and Andrew Apted. Later, with the major rewrites of the engine between 1.27 and 1.29, development was shifted primarily between the last two active developers; because of the burden of a largely two-man team, the engine was perceived as being somewhat unstable. With the release of 1.31, EDGE's standing improved and modders began returning to the engine, though [[ZDoom]] was tearing much of the share away. Since the engine had once again experienced large rendering and game-play rewrites between 1.29 and 1.31, the remainder of development was primarily headed by Andrew Apted.

Sometime in 2010, Andrew Baker had fully retired from the team, and Andrew Apted was growing more interested in other projects. He was beginning to make plans to fix up any outstanding issues with EDGE and make the final release. Perhaps as a result of ZDoom's popularity, Andrew Apted could not keep up with all of the feature requests, as he had invested much work and time into the 1.3x branch of EDGE. He began hinting at his desire to shift to other projects, notably [[Eureka]] and [[OBLIGE]], which were later released to much acclaim.

Into 2011, the community was well aware of his plans to retire from development with the release of 1.35. At the time, a major TC named [[Hypertension]] was perhaps the biggest project to be developed on the engine recently. The team of that TC [Isotope SoftWorks] foresaw the closing, and development of a fork named '''3DGE''' began to continue development as the modding team still required features that were only possible if they did it themselves.

The EDGE 1.x team consisted of [[Andrew Apted]] and [[Andy Baker (darkknight)]] as the primary developers, and [[Marc A. Pullen (Fanatic)]] and [[Luke Brennan (Lobo)]] as distributors/promoters. [[Darren Salt]] was also a frequent developer and contributed a lot of code and bugfixes.

== Later History and Current Status ==

On April 9, 2011, Andrew Apted announced his retirement from EDGE development, leaving EDGE without a maintainer for over seven years. The last version of EDGE 1.x (1.35), was released on the same day. Two days later, the first version of '''3DGE''' was released as a hot-fix to 1.35, having merged from an abandoned earlier rewrite of EDGE itself.

EDGE development (under the name ''3DGE'') therefore continued from 2011 well into 2018, introducing major long-requested features which were seen as somewhat standard for other modder-centric ports, including [[UDMF]], archive support, [[GLSL]] shaders, and much improved and expanded features for the [[DDF]], [[RTS]], and [[COAL]] systems; lots of hard work was put into the port since the last version was released in 2016.

EDGE's persistent popularity and perseverance earned the respect and occasional development contributions from several other major developers in the community, including GZDoom programmers [[dpJudas]], [[Rachael Alexanderson (Eruanna)]] and [[Graf Zahl]]. Andrew Apted would occasionally assist the team by providing assistance as needed.

On September 18th, 2018, [[Coraline_(Chu)|Cora Annis]] made an announcement of the next major version of EDGE, which would have been the first full version released by the new team since 2016. With Andrew Apted's support and blessing, the separated 3DGE fork (which was long thought as confusing due to naming and version issues) was officially absorbed back into EDGE. The impending release of 2.1.0 (stable) will mark the first version of EDGE officially released since 2011. EDGE is therefore split into two categories as far as releases are concerned - the 1.x branches, and the 2.x branches.

== Features ==
* [[Wikipedia:OpenGL|OpenGL]] 1.1/3.1 Renderer Paths, with Mipmapping, Smoothing, Dynamic Lighting, mirrors, portals, and [[Wikipedia:GLSL|GLSL]] shader support; Bump-Mapping/GLSL is only supported in the 3.1 rendering path.
* 64-bit support
* SDL2 integration
* [[UDMF]] support
* PAK/[[PK3]]/PK7/[[EPK]] [[Using_ZIPs_as_WAD_replacement|archive support]]
* Rendering interpolation and Vsync support
* JPEG, PNG, TGA, BMP, PSD, GIF, HDR, PIC, PNM high-res textures; including support for [[TX_START]]/TX_END and [[HI_START]]/HI_END texture namespaces, and grAb offset support for [[PNG]] images.
* [[OPL]] synth playback (using nukeyT's OPLlib)
* Basic shadows restored from EDGE 1.27
* Integration of [[ZDBSP]] and improvements to [[glBSP]], including building nodes from archives; overall better 3D rendering of both existing Doom levels and newer levels.
* Several major and minor bugs squashed from the [[EDGE]] 1.x releases
* [[Heretic]]/[[Chex Quest]] IWAD support
* [[MD3]] and [[MD5]] model support
* Two-player [[splitscreen]] [[co-op]] or [[deathmatch]] (local only)
* [[multimedia:RoQ|RoQ]] video support for cinematics
* Runs on the [[Wikipedia:Dreamcast|Sega Dreamcast]] console.
* Normal, specular and bright-map support on models
* [[DDF]]/[[RTS]]/[[COAL]] enhancements and bug-fixes
* [[Polyobject]]s (more types will be supported in the future)
* [[CAMERA-MAN|Camera-Man scripts]]: New scripting language which utilizes cameras for complete camera control.
* Support for up to 64 defined [[weapon]]s at once through DDF
* 16 Ammo types: BULLETS, SHELLS, ROCKETS, CELLS, and AMMO5 to AMMO16. (EDGE 1.29 only. AMMO1 to AMMO4 can be used as aliases for the 4 main ammo types.)
* [[3D floor|Extrafloors]] feature allows modders to create submersible liquids, [[room-over-room]], or catwalks, as well as vertically moving platforms not embedded into the floor.
* Four [[armor]] types: GREEN (33% reduction), BLUE (50% reduction), YELLOW (75% reduction) and RED (90% reduction).
* [[Automap]] can be made to be stationary instead of rotating with the player's facing angle, through [[COAL]]. Automap can also be applied as a secondary layer over the normal viewing screen opposed to replacing it, allowing the player to fight enemies and keep track of their position at one time.
* Weapons can have secondary attacks. Weapons can also be made to be manually reloaded, or have idle stats as well. Integration through COAL and RTS means Weapons and animations can be granularity customized.
* Support for [[MUS]], MIDI, IT/MOD, and Ogg Vorbis music formats.
* [[DDF]] files allow the editing of many features (such monsters, attacks, and levels).
* [[Sprite]]s can be viewed from 16 angles.
* [[RTS]] scripting format includes an option known as "Start_Map ALL" that allows global scripts to be created that affect all maps in the game without copying the script under each individual map.
* [[COAL]] virtual machine scripting language allow a more powerful alternative to functions normally found in DDF/RTS, as well as controlling the entirety of the HUD module.
* [[Door#Sliding doors|Sliding doors]], which are done separately without using PolyObjects.

== In-Progress ==
* [[Wikipedia:OpenAL|OpenAL]] for audio subsystem (being restored from EDGE 1.28, replacing SDL2), which will allow for various 3D environmental effects
* RoQ Render-to-Texture (for models, world textures, and menus/backgrounds)
* New [[DDF]] types: Terrains.ddf, Sprites.ddf, Inventory.ddf and Shaders.ddf
* Cross-platform IWAD selector
* Dynamic GLSL shader compilation
* Normal, specular, and brightmap support on world textures
* True [[inventory]] support
* Dynamic planar shadow system for [[dynamic light]]s
* [[Wikipedia:Open_Asset_Import_Library|AssImp]] 3D model back-end support for more model formats
* ''Quake 3: Arena''-style shader-based sky system
* Better [[Boom]] compatibility
* [[Decal]]s on all surfaces (using planned Decals.ddf)
* ''[[Wolfenstein_3D]]'' support (WLF_*)
* ''[[Rise of the Triad]]'' support (ROTT_*)
* ''Blake Stone'' support (BLK_*)
* ''[[Strife]]'' support

Heretic support is being finalized, and is in beta as of version 2.1.0 test 3, using a similarly named definition file called HDF (Heretic Definition File). The HDF definitions were written initially by CeeJay, before the 3DGE Team took over to write proper IWAD support.

== Popular add-ons ==
EDGE also brings its own unique set of popular add-ons to the Doom community. Although some dislike EDGE for its perceived instability, the following mods have in one way or another made their mark on the community.

A few notable mods in active development are Duke it Out in DOOM and Doom Forever, both by Chris Mullen (CeeJay), and a sequel to the [[Marc A. Pullen (Fanatic)]] mod QDOOM. ''SLaVE'' and ''Hypertension: Harmony of Darkness'' are two commercial products using this engine, both being developed by Isotope Softworks and published by Goat Store Publishing.

''Note that, as with any port enjoying such a long lifespan, backward compatibility for older mods can be hit and miss. Certain mods might run only with the application version they were designed for; the move to EDGE 2.x in particular is known to have broken support for a number of mods. Keep this in mind, and report any problems encountered if any of the below legacy mods are not running correctly.''

* [[Don's Challenge]] — Created by [[Cory Whittle]], Don's Challenge is a 3-episode modification based around the supernatural adventures of Don P. Tello, a veteran cop who is summoned into Hell by Mortis, the incarnation of Death, to challenge thousands of hellspawned creatures that his soul might be deemed worthy by her as a vessel. At the end of Episode 1, Don transforms Mortis into a cat. However, her brother Fate summons Mortis to Hell and takes Don with her. In the third episode, Don and Mortis return to Earth, only to find it overrun by Demons and Don's own family dead; Don and Mortis attempt to take vengeance for the deaths. This mod became popular due to the use of new monsters, weapons, and levels. One weapon (cigarettes) could even be used to heal the player. Another weapon (Booze) could be used to increase armor value, but took away a small portion of health as well. As of now, only one episode is fully released, but Episode 2 is reportedly on the way.
* [[Immoral Conduct]] - Created by [[Cory Whittle]], Immoral Conduct is a weapons modification for both EDGE and ZDoom (although the ZDoom version does not have as many features as its EDGE counterpart). The EDGE version contains the following: Knife, .45 Pistols, Stock 12g Pump Shotgun, Customized Pump Shotgun (fires 'slasher rounds'), 12g Hand Cannon, 9mm Uzi SMG, Fragment Hand Grenades, 40mm Grenade/Tear Gas Gun, Assault Rifle with M203, Infantry Rifle with Bayonet, Minigun, 12g Sawed-off Shotgun, Beretta 9mm Pistol, Chrome Magnum Revolver, Sentry Turret Kit (summons helper turrets to attack enemies), Gas-Powered Chainsaw, Remote/Proximity Satchel Charges, and Marking/Visibility Flares. New items included a 50% medikit and Nightvision Goggles. New helper monsters included the Marine Corporal and Marine Private. Monsters have also been modified (for example, the baron of Hell's blood is green), and shells are ejected from weapons. It is a [[partial conversion]], sometimes mistaken for a [[total conversion]], and in Whittle's words, "With my stuff, you have all the millions of user-made Doom and Doom II levels at your disposal to be enhanced with new weapons and items."

* [[Covert Ops]] — an EDGE version of [[Twilight Warrior]]. It has many features, such as new weapons and interesting scripts.

* [[QDoom]] (Quake Doom) — Created by [[Marc "Fanatic" Pullen]], QDoom is a total conversion of Quake to Doom.

* [[EarthBound Doom|EBDoom]] (Earthbound Doom) - Created by [[Baron of Sigma]], this modification has generated mixed opinions. It is not a complete game, and many consider it more of a "monster modification" since roughly 100+ different species of monsters exist, most of them imported and emulated from [[Heretic]], [[Hexen]], Duke Nukem 3D, Shadow Warrior, and Blood, and 'evolved' versions of existing game monsters, such as Chainsaw Zombies, Gold Liches, and Elder Mancubi. The game also appears to use a near-perfect emulation of the [[Sigil]] from Strife as an Easter egg weapon. In addition, the player has hit points instead of a health percentage, and can take much more damage than the common version of [[Doomguy]]. There are also several 'helper' characters based on the heroes of many of the Doom-engine games, including [[Doomguy]], [[Corvus]], and the player classes in Hexen. Certain bosses are also among the few in many modifications to have over 50,000 HP, with at least one boss having over 6,000,000 HP. The weapons are more 'mystical' and energy-based, with few traditional Doom-style weapons. Another unique feature in EBDoom is that all melee attacks used either by the player or other monsters/allies can inflict "critical hits" up to 4x damage at times, as in an RPG. Despite the community's mixed opinions of the mod, it is often used as a resource wad by other modders who want to quickly import foreign monsters into their own mods (as the author appears not to mind this). It is also one of the three mods in the Doom community to use [[Hissy]] as a central plot player, and makes many references to another EDGE mod known as [[Cacodemon Squad]]. This modification was last updated at 6.56 on January 12, 2006.

* [[GoldenEye Doom2]] - A fairly large in-progress TC. Featuring a load of weapons in both single and multiplayer maps. Multiple versions are available: A single player DEH version compatible with Doom Legacy and Zdoom 1.22. Multiplayer levels for standard Doom2. An enhanced single player EDGE 1.27+ version. The Edge version contains the following weapons: punch/kick, Knives, Watch lazer, _Soviet_Tank_, Silencedable PP7, Dostovie, Cougar Magnum, Automatic Shotgun, pathetic Klobb, Duestch, Zmg, KF7, Sniper Rifle, Ak47, Moon Raker Laser, RCP-90, Golden Gun, Golden PP7, Rocket Launcher, and Grenades. Most of the weapons have alternate firing modes and some weapons can be dual-wielded.

* [[Cold Hard Cash]] - An unique weapons mod offering a larger variety of weapons. Cold Hard Cash's spin on the weapons mod is that instead of just finding weapons laying around or dropped from enemies, the player must mug monsters for money to use at special weapons dispensers, which replace the original weapons, and sometimes artifacts and appear in their place. An example is that the Chainsaw is now a dispenser that allows the player to buy a Knife, a Crowbar, and other melee-type items. Most dispensers have a special offer on it, usually an upgrade to an existing weapon, which requires the said weapon in question to be held by the player before they can use it. It is also the first EDGE mod to use the "Start_Map ALL" RTS function, introduced in the 3rd release candidate of EDGE 1.29, which allows the same scripts to be usable on all maps instead of having to add the same ones to each map individually.

== Sources ==
*{{dwforums|id=102456|title=EDGE 2.1.0 Impending Release}}
*{{zdforums|p=1073199|3DGE 2.1.0 Test3 Released}}
*[[Next_version|Development Roadmap]]
*[https://www.youtube.com/watch?v=PpzvWcz7uDY Heretic support demonstration]

== External links ==
*[http://edge2.sourceforge.net Official EDGE site]
*[https://sourceforge.net/projects/edge2/files/3DGE%20binaries/ EDGE release packages], hosted by {{wp|SourceForge}}
*[https://sourceforge.net/projects/edge/files/EDGE%20Binaries/ Legacy EDGE binary releases], hosted by {{wp|SourceForge}}
*[https://github.com/3dfxdev/hyper3DGE 3DGE git repository], hosted by {{wp|github}}
*[https://devbuilds.drdteam.org/3dge/ Compiled SVN builds] for Windows, Linux, Mac, and Dreamcast at [[DRD Team]]
*{{edgewiki|Main Page|Documentation}}
*Dream3DGE:
:* [https://sourceforge.net/projects/edge2/files/3DGE%20SOURCE/DreamEDGE/ Source code repository], hosted by {{wp|SourceForge}}
:* [http://gamedev.allusion.net/softprj/kos/ KallistOS]
:* [http://www.segatech.com/technical/cpu/ SH-4 CPU]
*Mapsets and add-ons:
:* [http://www.tdgmods.net/smf/viewforum.php?f=26/ All known projects including WIPs]
:* [http://www.moddb.com/mods/duke-it-out-in-doom/ Duke it Out in DOOM]
:* {{Dwforums|id=66125|title=Doom Forever}}
:* {{Dwforums|id=64491|title=QDOOM sequel}}
:* [http://facebook.com/slavefps/ SLaVE]
:* [https://www.facebook.com/pages/Isotope-TDGMods/232903863419077/ Hypertension: Harmony of Darkness]
:* [https://www.facebook.com/Isotope-TDGMods-232903863419077/ Isotope Softworks]
:* [http://www.goatstorepublishing.com/ Goat Store Publishing]

{{s-start}}
{{s-port}}
{{s-cond}}
{{s-bef-cond|rows=2|before=[[DOSDoom]]}}
{{s-ttl|rows=2|title=EDGE 1.x}}
{{s-aft-cond|after=3DGE}}
{{s-aft-cond|after=Dream3DGE}}
{{s-bef-cond|before=EDGE 1.x}}
{{s-ttl|title=3DGE}}
{{s-aft-cond|after=EDGE 2.x}}
{{s-bef-cond|before=EDGE 1.x}}
{{s-ttl|title=Dream3DGE}}
{{s-aft-cond|after=None}}
{{s-end}}

[[Category:Source ports]]
[[Category:Boom compatible]]
[[Category:Doom ports]]
[[Category:Limit removing source ports]]
[[Category:OpenGL ports]]

EDGE

2018-11-12T23:11:04Z

Corbin: /* Sources */

{{InfoboxSourcePort
|title = EDGE, 3DGE, Hyper3DGE, Dream3DGE
|developer = [[Coraline_(Chu)|Cora Annis]], [[Joseph Fenton]], [[Rachael Alexanderson (Eruanna)]], [[Brendan Doe]], [[Damir Srpčič]], [[Maciej Kadlubowski]], [[Andrew Apted]], [[Andy Baker (darkknight)]], [[Darren Salt]], [[Erik Sandberg]], [[David Leatherdale]]
|nondeveloper = [[Chris Mullen (CeeJay)]], [[UsernameAK]], [[gameblabla]], [[Josh Pearson]], [[Benjamin Moir]], [[Luke Brennan (Lobo)]], [[Marc A. Pullen (Fanatic)]]
|baseparent = [[DOSDoom]]
|logo = [[File:EDGE LogoNew.jpg]]
|programming language = [[Wikipedia:C++|C++]], [[Wikipedia:QuakeC|QuakeC (modified)]]
|status = Active
|initialdate = 2000-06-20
|initialversion = 1.22
|platform = Cross-Platform
|license = {{GPL||2+}}
|website = [http://edge2.sourceforge.net/ SourceForge]
|repourl = [https://github.com/3dfxdev/hyper3DGE GitHub]
}}
'''EDGE''' (Enhanced Doom Gaming Engine) is a collaborative Open Source project based upon the [[Doom source code]]. EDGE is derived from an earlier project called [[DOSDoom]], and started development in 1999 immediately after DOSDoom 0.65 was released. '''EDGE''' is sometimes referred to as '''3DGE''', or '''hyper3DGE''' due to the long-standing development of the '''3DGE''' fork, which was initially released on April 11, 2011; it was originally created to power the ''Hypertension'' TC, and absorbed back into EDGE seven years later. The first official EDGE version was released on June 20, 2000. The latest stable version is 2.0.4, released on December 13, 2016. The team releases *[https://devbuilds.drdteam.org/3dge/ DRDT] semi-regular development builds via [[DRD Team]].

EDGE includes ports to many popular operating systems, including x86/x64 Windows, Linux, BeOS, Raspberry PI, Sega Dreamcast, and Mac OSX. The project is hardware-accelerated only, and also implements support for PowerVR2 CLX2 (through KallistiOS) for the Dreamcast platform. Previous versions of EDGE incorporated both software-rendered and hardware-accelerated versions, though the former was dropped with the release of version 1.29.

The most attractive feature of EDGE is its [[DDF]] system, which originated from DOSDoom. DDF describes all game behavior inside text files external to the executable file. As a result, it is popular among modders who use the extensibility to add many new weapons and features with many fewer of the limits present in other source ports. With DDF, for example, it is possible to create monsters which can possess multiple missile and melee attacks, or create custom pain and death states for monsters when hit by specific weapons or projectiles. Combined together with [[RTS]] and the more modular, modern language [[COAL]], EDGE can rival what other popular ports are capable of through their respective scripting language implementations.

'''Dream3DGE''' was a [[Sega]] Dreamcast-only port of EDGE 1.29, and has high compatibility with pre-1.31 mods, as it cannot currently run anything created with EDGE 1.31 or above. It must be built with KallistOS. It contains most, if not all, functionality from the parent port. This branch (and EDGE 1.29, on which it was based) was abandoned officially and rewritten and integrated back into 3DGE with version 2.0. The Dreamcast code utilizes KallistiGL instead of OpenGL for important rendering functions concerning the SH-4 CPU.

== Early History ==

DOSDoom began development in 1997, initially by [[Chi Hoang]] and coined the term source-port. [[Andy Baker (darkknight)]] was a frequent collaborator, and soon amassed a team of developers known as the {{3dgewiki|DOSDoom_Team|DOSDoom Team|linkonly=1}}. The entirety of the DOSDoom team began developing pioneering systems that other ports did not have at the time, including [[DDF]] and [[RTS]] scripting languages - the first such human-readable systems for DOOM. It is worth noting that the scripting systems were wholly different from [[DeHacked]] at the time because they did not need to modify the executable directly, and were split into several different files that could control much more at a granular level than DeHacked ever could. The {{3dgewiki|DOSDoom_Team|DOSDoom Team|linkonly=1}} consisted of Hoang, Baker, [[Erik Sandberg]], [[Kester Maddock]], [[Martin Howe]], [[John Cole]] and [[David Leatherdale]].

Into 1998, the community was ripe with the emergence of other source-ports, including [[ZDoom]], [[Doom Legacy]], [[Boom]], as well as the first [[Wikipedia:OpenGL|OpenGL]] accelerated engine, [[glDoom]]. glDoom especially made an impact on the team into 1999 as OpenGL was seen as a major advancement at the time - this would be highly influential later in development. DOSDoom continued to be a major powerhouse for modders well into development of EDGE.

In mid 1998, [[TeamTNT]] discussed with the {{3dgewiki|DOSDoom_Team|DOSDoom Team|linkonly=1}} about merging their project, [[OGRE]], directly into [[DOSDoom]]. The collaboration was announced in late 1998 and generated much interest as TeamTNT previously developed another ground-breaking port named [[BOOM]]; discussions were even joined by the inclusion of [[John Carmack]]. However, difficulties ensued for all parties and the project was abandoned. OGRE was quite possibly the progenitor of [[EDGE]] as several of the ideas both teams wanted to do was further realized with the development of EDGE. The failed merger didn't affect DOSDoom's ultimate standing and the port continued to be popular; though, possibly as a result of the planned/failed merger of DOSDoom and OGRE, Hoang left the DOSDoom Team and the DOOM community after v0.63 was released, followed by other DOSDoom members.

== History ==

In early 1999, several more source-ports were released, all offering their own features. [[3D floor]]s were pioneered with DOSDoom which generated much interest, but the DOSDoom Team began rifting as some members left the community altogether, or joined different projects. Andrew Baker and his team devised that a re-haul of DOSDoom was inevitable; the primary motivation being that the port was no longer limited to the DOS operating system.

It was also around this time that [[Andrew Apted]] had joined the team; it was decided that the DOSDoom name would change to better reflect its status as the most advanced 3D source-port of its time. *{{3dgewiki|TADE|TADE|linkonly=1}} was seen as a possible name before the team ultimately settled on EDGE; the port was in development before DOSDoom saw its final public release.

DOSDoom v0.653 was released in April 10, 1999, which would be its final version. The surviving members of the DOSDoom Team [Baker, Erik Sandberg, and David Leatherdale], with Andrew Apted, immediately formed the EDGE team from the existing code-base.

EDGE was officially released on June 20, 2000 after more than a year and a half being in secret development; it was seen as a milestone as the DDF and RTS systems were more fully realized, as well as becoming an early adopter of [[Wikipedia:OpenGL|OpenGL]] rendering. At the time, EDGE was the most advanced port as several other emergent technologies were realized in tandem, including [[glBSP]], the first true 3D node-builder for DOOM.

The development of Marc A. Pullen's [[QDoom]] was seen as a major motivating factor for the EDGE team in its early years; its release was very popular and helped elevate EDGE's status as a true modder-centric engine. [[Cory Whittle]] was also a frequent developer of EDGE modifications that also kept the port healthy.

EDGE development continued into the next decade; while the early years were notable for EDGE being the supreme choice for modders and OpenGL enthusiasts, the team began to experience strain in the mid 2000's. As most members of the DOSDoom team had left by 2004, development was primarily being shouldered by Andrew Baker and Andrew Apted. Later, with the major rewrites of the engine between 1.27 and 1.29, development was shifted primarily between the last two active developers; because of the burden of a largely two-man team, the engine was perceived as being somewhat unstable. With the release of 1.31, EDGE's standing improved and modders began returning to the engine, though [[ZDoom]] was tearing much of the share away. Since the engine had once again experienced large rendering and game-play rewrites between 1.29 and 1.31, the remainder of development was primarily headed by Andrew Apted.

Sometime in 2010, Andrew Baker had fully retired from the team, and Andrew Apted was growing more interested in other projects. He was beginning to make plans to fix up any outstanding issues with EDGE and make the final release. Perhaps as a result of ZDoom's popularity, Andrew Apted could not keep up with all of the feature requests, as he had invested much work and time into the 1.3x branch of EDGE. He began hinting at his desire to shift to other projects, notably [[Eureka]] and [[OBLIGE]], which were later released to much acclaim.

Into 2011, the community was well aware of his plans to retire from development with the release of 1.35. At the time, a major TC named [[Hypertension]] was perhaps the biggest project to be developed on the engine recently. The team of that TC [Isotope SoftWorks] foresaw the closing, and development of a fork named '''3DGE''' began to continue development as the modding team still required features that were only possible if they did it themselves.

The EDGE 1.x team consisted of [[Andrew Apted]] and [[Andy Baker (darkknight)]] as the primary developers, and [[Marc A. Pullen (Fanatic)]] and [[Luke Brennan (Lobo)]] as distributors/promoters. [[Darren Salt]] was also a frequent developer and contributed a lot of code and bugfixes.

== Later History and Current Status ==

On April 9, 2011, Andrew Apted announced his retirement from EDGE development, leaving EDGE without a maintainer for over seven years. The last version of EDGE 1.x (1.35), was released on the same day. Two days later, the first version of '''3DGE''' was released as a hot-fix to 1.35, having merged from an abandoned earlier rewrite of EDGE itself.

EDGE development (under the name ''3DGE'') therefore continued from 2011 well into 2018, introducing major long-requested features which were seen as somewhat standard for other modder-centric ports, including [[UDMF]], archive support, [[GLSL]] shaders, and much improved and expanded features for the [[DDF]], [[RTS]], and [[COAL]] systems; lots of hard work was put into the port since the last version was released in 2016.

EDGE's persistent popularity and perseverance earned the respect and occasional development contributions from several other major developers in the community, including GZDoom programmers [[dpJudas]], [[Rachael Alexanderson (Eruanna)]] and [[Graf Zahl]]. Andrew Apted would occasionally assist the team by providing assistance as needed.

On September 18th, 2018, [[Coraline_(Chu)|Cora Annis]] made an announcement of the next major version of EDGE, which would have been the first full version released by the new team since 2016. With Andrew Apted's support and blessing, the separated 3DGE fork (which was long thought as confusing due to naming and version issues) was officially absorbed back into EDGE. The impending release of 2.1.0 (stable) will mark the first version of EDGE officially released since 2011. EDGE is therefore split into two categories as far as releases are concerned - the 1.x branches, and the 2.x branches.

== Features ==
* [[Wikipedia:OpenGL|OpenGL]] 1.1/3.1 Renderer Paths, with Mipmapping, Smoothing, Dynamic Lighting, mirrors, portals, and [[Wikipedia:GLSL|GLSL]] shader support; Bump-Mapping/GLSL is only supported in the 3.1 rendering path.
* 64-bit support
* SDL2 integration
* [[UDMF]] support
* PAK/[[PK3]]/PK7/{{3dgewiki|EPK|EPK|linkonly=1}} {{3dgewiki|Using_ZIPs_as_WAD_replacement|archive support|linkonly=1}}
* Rendering interpolation and Vsync support
* JPEG, PNG, TGA, BMP, PSD, GIF, HDR, PIC, PNM high-res textures; including support for [[TX_START]]/TX_END and [[HI_START]]/HI_END texture namespaces, and grAb offset support for [[PNG]] images.
* [[OPL]] synth playback (using nukeyT's OPLlib)
* Basic shadows restored from EDGE 1.27
* Integration of [[ZDBSP]] and improvements to [[glBSP]], including building nodes from archives; overall better 3D rendering of both existing Doom levels and newer levels.
* Several major and minor bugs squashed from the [[EDGE]] 1.x releases
* [[Heretic]]/[[Chex Quest]] IWAD support
* {{3dgewiki|MD3|MD3|linkonly=1}} and {{3dgewiki|MD5|MD5|linkonly=1}} model support
* Two-player [[splitscreen]] [[co-op]] or [[deathmatch]] (local only)
* [[multimedia:RoQ|RoQ]] video support for cinematics
* Runs on the [[Wikipedia:Dreamcast|Sega Dreamcast]] console.
* Normal, specular and bright-map support on models
* [[DDF]]/[[RTS]]/[[COAL]] enhancements and bug-fixes
* [[Polyobject]]s (more types will be supported in the future)
* {{3dgewiki|CAMERA-MAN|Camera-Man scripts|linkonly=1}}: New scripting language which utilizes cameras for complete camera control.
* Support for up to 64 defined [[weapon]]s at once through DDF
* 16 Ammo types: BULLETS, SHELLS, ROCKETS, CELLS, and AMMO5 to AMMO16. (EDGE 1.29 only. AMMO1 to AMMO4 can be used as aliases for the 4 main ammo types.)
* [[3D floor|Extrafloors]] feature allows modders to create submersible liquids, [[room-over-room]], or catwalks, as well as vertically moving platforms not embedded into the floor.
* Four [[armor]] types: GREEN (33% reduction), BLUE (50% reduction), YELLOW (75% reduction) and RED (90% reduction).
* [[Automap]] can be made to be stationary instead of rotating with the player's facing angle, through [[COAL]]. Automap can also be applied as a secondary layer over the normal viewing screen opposed to replacing it, allowing the player to fight enemies and keep track of their position at one time.
* Weapons can have secondary attacks. Weapons can also be made to be manually reloaded, or have idle stats as well. Integration through COAL and RTS means Weapons and animations can be granularity customized.
* Support for [[MUS]], MIDI, IT/MOD, and Ogg Vorbis music formats.
* [[DDF]] files allow the editing of many features (such monsters, attacks, and levels).
* [[Sprite]]s can be viewed from 16 angles.
* [[RTS]] scripting format includes an option known as "Start_Map ALL" that allows global scripts to be created that affect all maps in the game without copying the script under each individual map.
* [[COAL]] virtual machine scripting language allow a more powerful alternative to functions normally found in DDF/RTS, as well as controlling the entirety of the HUD module.
* [[Door#Sliding doors|Sliding doors]], which are done separately without using PolyObjects.

== In-Progress ==
* [[Wikipedia:OpenAL|OpenAL]] for audio subsystem (being restored from EDGE 1.28, replacing SDL2), which will allow for various 3D environmental effects
* RoQ Render-to-Texture (for models, world textures, and menus/backgrounds)
* New [[DDF]] types: Terrains.ddf, Sprites.ddf, Inventory.ddf and Shaders.ddf
* Cross-platform IWAD selector
* Dynamic GLSL shader compilation
* Normal, specular, and brightmap support on world textures
* True [[inventory]] support
* Dynamic planar shadow system for [[dynamic light]]s
* [[Wikipedia:Open_Asset_Import_Library|AssImp]] 3D model back-end support for more model formats
* ''Quake 3: Arena''-style shader-based sky system
* Better [[Boom]] compatibility
* [[Decal]]s on all surfaces (using planned Decals.ddf)
* ''[[Wolfenstein_3D]]'' support (WLF_*)
* ''[[Rise of the Triad]]'' support (ROTT_*)
* ''Blake Stone'' support (BLK_*)
* ''[[Strife]]'' support

Heretic support is being finalized, and is in beta as of version 2.1.0 test 3, using a similarly named definition file called HDF (Heretic Definition File). The HDF definitions were written initially by CeeJay, before the 3DGE Team took over to write proper IWAD support.

== Popular add-ons ==
EDGE also brings its own unique set of popular add-ons to the Doom community. Although some dislike EDGE for its perceived instability, the following mods have in one way or another made their mark on the community.

A few notable mods in active development are Duke it Out in DOOM and Doom Forever, both by Chris Mullen (CeeJay), and a sequel to the [[Marc A. Pullen (Fanatic)]] mod QDOOM. ''SLaVE'' and ''Hypertension: Harmony of Darkness'' are two commercial products using this engine, both being developed by Isotope Softworks and published by Goat Store Publishing.

''Note that, as with any port enjoying such a long lifespan, backward compatibility for older mods can be hit and miss. Certain mods might run only with the application version they were designed for; the move to EDGE 2.x in particular is known to have broken support for a number of mods. Keep this in mind, and report any problems encountered if any of the below legacy mods are not running correctly.''

* [[Don's Challenge]] — Created by [[Cory Whittle]], Don's Challenge is a 3-episode modification based around the supernatural adventures of Don P. Tello, a veteran cop who is summoned into Hell by Mortis, the incarnation of Death, to challenge thousands of hellspawned creatures that his soul might be deemed worthy by her as a vessel. At the end of Episode 1, Don transforms Mortis into a cat. However, her brother Fate summons Mortis to Hell and takes Don with her. In the third episode, Don and Mortis return to Earth, only to find it overrun by Demons and Don's own family dead; Don and Mortis attempt to take vengeance for the deaths. This mod became popular due to the use of new monsters, weapons, and levels. One weapon (cigarettes) could even be used to heal the player. Another weapon (Booze) could be used to increase armor value, but took away a small portion of health as well. As of now, only one episode is fully released, but Episode 2 is reportedly on the way.
* [[Immoral Conduct]] - Created by [[Cory Whittle]], Immoral Conduct is a weapons modification for both EDGE and ZDoom (although the ZDoom version does not have as many features as its EDGE counterpart). The EDGE version contains the following: Knife, .45 Pistols, Stock 12g Pump Shotgun, Customized Pump Shotgun (fires 'slasher rounds'), 12g Hand Cannon, 9mm Uzi SMG, Fragment Hand Grenades, 40mm Grenade/Tear Gas Gun, Assault Rifle with M203, Infantry Rifle with Bayonet, Minigun, 12g Sawed-off Shotgun, Beretta 9mm Pistol, Chrome Magnum Revolver, Sentry Turret Kit (summons helper turrets to attack enemies), Gas-Powered Chainsaw, Remote/Proximity Satchel Charges, and Marking/Visibility Flares. New items included a 50% medikit and Nightvision Goggles. New helper monsters included the Marine Corporal and Marine Private. Monsters have also been modified (for example, the baron of Hell's blood is green), and shells are ejected from weapons. It is a [[partial conversion]], sometimes mistaken for a [[total conversion]], and in Whittle's words, "With my stuff, you have all the millions of user-made Doom and Doom II levels at your disposal to be enhanced with new weapons and items."

* [[Covert Ops]] — an EDGE version of [[Twilight Warrior]]. It has many features, such as new weapons and interesting scripts.

* [[QDoom]] (Quake Doom) — Created by [[Marc "Fanatic" Pullen]], QDoom is a total conversion of Quake to Doom.

* [[EarthBound Doom|EBDoom]] (Earthbound Doom) - Created by [[Baron of Sigma]], this modification has generated mixed opinions. It is not a complete game, and many consider it more of a "monster modification" since roughly 100+ different species of monsters exist, most of them imported and emulated from [[Heretic]], [[Hexen]], Duke Nukem 3D, Shadow Warrior, and Blood, and 'evolved' versions of existing game monsters, such as Chainsaw Zombies, Gold Liches, and Elder Mancubi. The game also appears to use a near-perfect emulation of the [[Sigil]] from Strife as an Easter egg weapon. In addition, the player has hit points instead of a health percentage, and can take much more damage than the common version of [[Doomguy]]. There are also several 'helper' characters based on the heroes of many of the Doom-engine games, including [[Doomguy]], [[Corvus]], and the player classes in Hexen. Certain bosses are also among the few in many modifications to have over 50,000 HP, with at least one boss having over 6,000,000 HP. The weapons are more 'mystical' and energy-based, with few traditional Doom-style weapons. Another unique feature in EBDoom is that all melee attacks used either by the player or other monsters/allies can inflict "critical hits" up to 4x damage at times, as in an RPG. Despite the community's mixed opinions of the mod, it is often used as a resource wad by other modders who want to quickly import foreign monsters into their own mods (as the author appears not to mind this). It is also one of the three mods in the Doom community to use [[Hissy]] as a central plot player, and makes many references to another EDGE mod known as [[Cacodemon Squad]]. This modification was last updated at 6.56 on January 12, 2006.

* [[GoldenEye Doom2]] - A fairly large in-progress TC. Featuring a load of weapons in both single and multiplayer maps. Multiple versions are available: A single player DEH version compatible with Doom Legacy and Zdoom 1.22. Multiplayer levels for standard Doom2. An enhanced single player EDGE 1.27+ version. The Edge version contains the following weapons: punch/kick, Knives, Watch lazer, _Soviet_Tank_, Silencedable PP7, Dostovie, Cougar Magnum, Automatic Shotgun, pathetic Klobb, Duestch, Zmg, KF7, Sniper Rifle, Ak47, Moon Raker Laser, RCP-90, Golden Gun, Golden PP7, Rocket Launcher, and Grenades. Most of the weapons have alternate firing modes and some weapons can be dual-wielded.

* [[Cold Hard Cash]] - An unique weapons mod offering a larger variety of weapons. Cold Hard Cash's spin on the weapons mod is that instead of just finding weapons laying around or dropped from enemies, the player must mug monsters for money to use at special weapons dispensers, which replace the original weapons, and sometimes artifacts and appear in their place. An example is that the Chainsaw is now a dispenser that allows the player to buy a Knife, a Crowbar, and other melee-type items. Most dispensers have a special offer on it, usually an upgrade to an existing weapon, which requires the said weapon in question to be held by the player before they can use it. It is also the first EDGE mod to use the "Start_Map ALL" RTS function, introduced in the 3rd release candidate of EDGE 1.29, which allows the same scripts to be usable on all maps instead of having to add the same ones to each map individually.

== Sources ==
*{{dwforums|id=102456|title=EDGE 2.1.0 Impending Release}}
*{{zdforums|p=1073199|3DGE 2.1.0 Test3 Released}}
*[[Next_version|Development Roadmap]]
*[https://www.youtube.com/watch?v=PpzvWcz7uDY Heretic support demonstration]

== External links ==
*[http://edge2.sourceforge.net Official EDGE site]
*[https://sourceforge.net/projects/edge2/files/3DGE%20binaries/ EDGE release packages], hosted by {{wp|SourceForge}}
*[https://sourceforge.net/projects/edge/files/EDGE%20Binaries/ Legacy EDGE binary releases], hosted by {{wp|SourceForge}}
*[https://github.com/3dfxdev/hyper3DGE 3DGE git repository], hosted by {{wp|github}}
*[https://devbuilds.drdteam.org/3dge/ Compiled SVN builds] for Windows, Linux, Mac, and Dreamcast at [[DRD Team]]
*{{edgewiki|Main Page|Documentation}}
*Dream3DGE:
:* [https://sourceforge.net/projects/edge2/files/3DGE%20SOURCE/DreamEDGE/ Source code repository], hosted by {{wp|SourceForge}}
:* [http://gamedev.allusion.net/softprj/kos/ KallistOS]
:* [http://www.segatech.com/technical/cpu/ SH-4 CPU]
*Mapsets and add-ons:
:* [http://www.tdgmods.net/smf/viewforum.php?f=26/ All known projects including WIPs]
:* [http://www.moddb.com/mods/duke-it-out-in-doom/ Duke it Out in DOOM]
:* {{Dwforums|id=66125|title=Doom Forever}}
:* {{Dwforums|id=64491|title=QDOOM sequel}}
:* [http://facebook.com/slavefps/ SLaVE]
:* [https://www.facebook.com/pages/Isotope-TDGMods/232903863419077/ Hypertension: Harmony of Darkness]
:* [https://www.facebook.com/Isotope-TDGMods-232903863419077/ Isotope Softworks]
:* [http://www.goatstorepublishing.com/ Goat Store Publishing]

{{s-start}}
{{s-port}}
{{s-cond}}
{{s-bef-cond|rows=2|before=[[DOSDoom]]}}
{{s-ttl|rows=2|title=EDGE 1.x}}
{{s-aft-cond|after=3DGE}}
{{s-aft-cond|after=Dream3DGE}}
{{s-bef-cond|before=EDGE 1.x}}
{{s-ttl|title=3DGE}}
{{s-aft-cond|after=EDGE 2.x}}
{{s-bef-cond|before=EDGE 1.x}}
{{s-ttl|title=Dream3DGE}}
{{s-aft-cond|after=None}}
{{s-end}}

[[Category:Source ports]]
[[Category:Boom compatible]]
[[Category:Doom ports]]
[[Category:Limit removing source ports]]
[[Category:OpenGL ports]]

EDGE

2018-11-12T23:09:37Z

Corbin: /* Sources */

{{InfoboxSourcePort
|title = EDGE, 3DGE, Hyper3DGE, Dream3DGE
|developer = [[Coraline_(Chu)|Cora Annis]], [[Joseph Fenton]], [[Rachael Alexanderson (Eruanna)]], [[Brendan Doe]], [[Damir Srpčič]], [[Maciej Kadlubowski]], [[Andrew Apted]], [[Andy Baker (darkknight)]], [[Darren Salt]], [[Erik Sandberg]], [[David Leatherdale]]
|nondeveloper = [[Chris Mullen (CeeJay)]], [[UsernameAK]], [[gameblabla]], [[Josh Pearson]], [[Benjamin Moir]], [[Luke Brennan (Lobo)]], [[Marc A. Pullen (Fanatic)]]
|baseparent = [[DOSDoom]]
|logo = [[File:EDGE LogoNew.jpg]]
|programming language = [[Wikipedia:C++|C++]], [[Wikipedia:QuakeC|QuakeC (modified)]]
|status = Active
|initialdate = 2000-06-20
|initialversion = 1.22
|platform = Cross-Platform
|license = {{GPL||2+}}
|website = [http://edge2.sourceforge.net/ SourceForge]
|repourl = [https://github.com/3dfxdev/hyper3DGE GitHub]
}}
'''EDGE''' (Enhanced Doom Gaming Engine) is a collaborative Open Source project based upon the [[Doom source code]]. EDGE is derived from an earlier project called [[DOSDoom]], and started development in 1999 immediately after DOSDoom 0.65 was released. '''EDGE''' is sometimes referred to as '''3DGE''', or '''hyper3DGE''' due to the long-standing development of the '''3DGE''' fork, which was initially released on April 11, 2011; it was originally created to power the ''Hypertension'' TC, and absorbed back into EDGE seven years later. The first official EDGE version was released on June 20, 2000. The latest stable version is 2.0.4, released on December 13, 2016. The team releases *[https://devbuilds.drdteam.org/3dge/ DRDT] semi-regular development builds via [[DRD Team]].

EDGE includes ports to many popular operating systems, including x86/x64 Windows, Linux, BeOS, Raspberry PI, Sega Dreamcast, and Mac OSX. The project is hardware-accelerated only, and also implements support for PowerVR2 CLX2 (through KallistiOS) for the Dreamcast platform. Previous versions of EDGE incorporated both software-rendered and hardware-accelerated versions, though the former was dropped with the release of version 1.29.

The most attractive feature of EDGE is its [[DDF]] system, which originated from DOSDoom. DDF describes all game behavior inside text files external to the executable file. As a result, it is popular among modders who use the extensibility to add many new weapons and features with many fewer of the limits present in other source ports. With DDF, for example, it is possible to create monsters which can possess multiple missile and melee attacks, or create custom pain and death states for monsters when hit by specific weapons or projectiles. Combined together with [[RTS]] and the more modular, modern language [[COAL]], EDGE can rival what other popular ports are capable of through their respective scripting language implementations.

'''Dream3DGE''' was a [[Sega]] Dreamcast-only port of EDGE 1.29, and has high compatibility with pre-1.31 mods, as it cannot currently run anything created with EDGE 1.31 or above. It must be built with KallistOS. It contains most, if not all, functionality from the parent port. This branch (and EDGE 1.29, on which it was based) was abandoned officially and rewritten and integrated back into 3DGE with version 2.0. The Dreamcast code utilizes KallistiGL instead of OpenGL for important rendering functions concerning the SH-4 CPU.

== Early History ==

DOSDoom began development in 1997, initially by [[Chi Hoang]] and coined the term source-port. [[Andy Baker (darkknight)]] was a frequent collaborator, and soon amassed a team of developers known as the {{3dgewiki|DOSDoom_Team|DOSDoom Team|linkonly=1}}. The entirety of the DOSDoom team began developing pioneering systems that other ports did not have at the time, including [[DDF]] and [[RTS]] scripting languages - the first such human-readable systems for DOOM. It is worth noting that the scripting systems were wholly different from [[DeHacked]] at the time because they did not need to modify the executable directly, and were split into several different files that could control much more at a granular level than DeHacked ever could. The {{3dgewiki|DOSDoom_Team|DOSDoom Team|linkonly=1}} consisted of Hoang, Baker, [[Erik Sandberg]], [[Kester Maddock]], [[Martin Howe]], [[John Cole]] and [[David Leatherdale]].

Into 1998, the community was ripe with the emergence of other source-ports, including [[ZDoom]], [[Doom Legacy]], [[Boom]], as well as the first [[Wikipedia:OpenGL|OpenGL]] accelerated engine, [[glDoom]]. glDoom especially made an impact on the team into 1999 as OpenGL was seen as a major advancement at the time - this would be highly influential later in development. DOSDoom continued to be a major powerhouse for modders well into development of EDGE.

In mid 1998, [[TeamTNT]] discussed with the {{3dgewiki|DOSDoom_Team|DOSDoom Team|linkonly=1}} about merging their project, [[OGRE]], directly into [[DOSDoom]]. The collaboration was announced in late 1998 and generated much interest as TeamTNT previously developed another ground-breaking port named [[BOOM]]; discussions were even joined by the inclusion of [[John Carmack]]. However, difficulties ensued for all parties and the project was abandoned. OGRE was quite possibly the progenitor of [[EDGE]] as several of the ideas both teams wanted to do was further realized with the development of EDGE. The failed merger didn't affect DOSDoom's ultimate standing and the port continued to be popular; though, possibly as a result of the planned/failed merger of DOSDoom and OGRE, Hoang left the DOSDoom Team and the DOOM community after v0.63 was released, followed by other DOSDoom members.

== History ==

In early 1999, several more source-ports were released, all offering their own features. [[3D floor]]s were pioneered with DOSDoom which generated much interest, but the DOSDoom Team began rifting as some members left the community altogether, or joined different projects. Andrew Baker and his team devised that a re-haul of DOSDoom was inevitable; the primary motivation being that the port was no longer limited to the DOS operating system.

It was also around this time that [[Andrew Apted]] had joined the team; it was decided that the DOSDoom name would change to better reflect its status as the most advanced 3D source-port of its time. *{{3dgewiki|TADE|TADE|linkonly=1}} was seen as a possible name before the team ultimately settled on EDGE; the port was in development before DOSDoom saw its final public release.

DOSDoom v0.653 was released in April 10, 1999, which would be its final version. The surviving members of the DOSDoom Team [Baker, Erik Sandberg, and David Leatherdale], with Andrew Apted, immediately formed the EDGE team from the existing code-base.

EDGE was officially released on June 20, 2000 after more than a year and a half being in secret development; it was seen as a milestone as the DDF and RTS systems were more fully realized, as well as becoming an early adopter of [[Wikipedia:OpenGL|OpenGL]] rendering. At the time, EDGE was the most advanced port as several other emergent technologies were realized in tandem, including [[glBSP]], the first true 3D node-builder for DOOM.

The development of Marc A. Pullen's [[QDoom]] was seen as a major motivating factor for the EDGE team in its early years; its release was very popular and helped elevate EDGE's status as a true modder-centric engine. [[Cory Whittle]] was also a frequent developer of EDGE modifications that also kept the port healthy.

EDGE development continued into the next decade; while the early years were notable for EDGE being the supreme choice for modders and OpenGL enthusiasts, the team began to experience strain in the mid 2000's. As most members of the DOSDoom team had left by 2004, development was primarily being shouldered by Andrew Baker and Andrew Apted. Later, with the major rewrites of the engine between 1.27 and 1.29, development was shifted primarily between the last two active developers; because of the burden of a largely two-man team, the engine was perceived as being somewhat unstable. With the release of 1.31, EDGE's standing improved and modders began returning to the engine, though [[ZDoom]] was tearing much of the share away. Since the engine had once again experienced large rendering and game-play rewrites between 1.29 and 1.31, the remainder of development was primarily headed by Andrew Apted.

Sometime in 2010, Andrew Baker had fully retired from the team, and Andrew Apted was growing more interested in other projects. He was beginning to make plans to fix up any outstanding issues with EDGE and make the final release. Perhaps as a result of ZDoom's popularity, Andrew Apted could not keep up with all of the feature requests, as he had invested much work and time into the 1.3x branch of EDGE. He began hinting at his desire to shift to other projects, notably [[Eureka]] and [[OBLIGE]], which were later released to much acclaim.

Into 2011, the community was well aware of his plans to retire from development with the release of 1.35. At the time, a major TC named [[Hypertension]] was perhaps the biggest project to be developed on the engine recently. The team of that TC [Isotope SoftWorks] foresaw the closing, and development of a fork named '''3DGE''' began to continue development as the modding team still required features that were only possible if they did it themselves.

The EDGE 1.x team consisted of [[Andrew Apted]] and [[Andy Baker (darkknight)]] as the primary developers, and [[Marc A. Pullen (Fanatic)]] and [[Luke Brennan (Lobo)]] as distributors/promoters. [[Darren Salt]] was also a frequent developer and contributed a lot of code and bugfixes.

== Later History and Current Status ==

On April 9, 2011, Andrew Apted announced his retirement from EDGE development, leaving EDGE without a maintainer for over seven years. The last version of EDGE 1.x (1.35), was released on the same day. Two days later, the first version of '''3DGE''' was released as a hot-fix to 1.35, having merged from an abandoned earlier rewrite of EDGE itself.

EDGE development (under the name ''3DGE'') therefore continued from 2011 well into 2018, introducing major long-requested features which were seen as somewhat standard for other modder-centric ports, including [[UDMF]], archive support, [[GLSL]] shaders, and much improved and expanded features for the [[DDF]], [[RTS]], and [[COAL]] systems; lots of hard work was put into the port since the last version was released in 2016.

EDGE's persistent popularity and perseverance earned the respect and occasional development contributions from several other major developers in the community, including GZDoom programmers [[dpJudas]], [[Rachael Alexanderson (Eruanna)]] and [[Graf Zahl]]. Andrew Apted would occasionally assist the team by providing assistance as needed.

On September 18th, 2018, [[Coraline_(Chu)|Cora Annis]] made an announcement of the next major version of EDGE, which would have been the first full version released by the new team since 2016. With Andrew Apted's support and blessing, the separated 3DGE fork (which was long thought as confusing due to naming and version issues) was officially absorbed back into EDGE. The impending release of 2.1.0 (stable) will mark the first version of EDGE officially released since 2011. EDGE is therefore split into two categories as far as releases are concerned - the 1.x branches, and the 2.x branches.

== Features ==
* [[Wikipedia:OpenGL|OpenGL]] 1.1/3.1 Renderer Paths, with Mipmapping, Smoothing, Dynamic Lighting, mirrors, portals, and [[Wikipedia:GLSL|GLSL]] shader support; Bump-Mapping/GLSL is only supported in the 3.1 rendering path.
* 64-bit support
* SDL2 integration
* [[UDMF]] support
* PAK/[[PK3]]/PK7/{{3dgewiki|EPK|EPK|linkonly=1}} {{3dgewiki|Using_ZIPs_as_WAD_replacement|archive support|linkonly=1}}
* Rendering interpolation and Vsync support
* JPEG, PNG, TGA, BMP, PSD, GIF, HDR, PIC, PNM high-res textures; including support for [[TX_START]]/TX_END and [[HI_START]]/HI_END texture namespaces, and grAb offset support for [[PNG]] images.
* [[OPL]] synth playback (using nukeyT's OPLlib)
* Basic shadows restored from EDGE 1.27
* Integration of [[ZDBSP]] and improvements to [[glBSP]], including building nodes from archives; overall better 3D rendering of both existing Doom levels and newer levels.
* Several major and minor bugs squashed from the [[EDGE]] 1.x releases
* [[Heretic]]/[[Chex Quest]] IWAD support
* {{3dgewiki|MD3|MD3|linkonly=1}} and {{3dgewiki|MD5|MD5|linkonly=1}} model support
* Two-player [[splitscreen]] [[co-op]] or [[deathmatch]] (local only)
* [[multimedia:RoQ|RoQ]] video support for cinematics
* Runs on the [[Wikipedia:Dreamcast|Sega Dreamcast]] console.
* Normal, specular and bright-map support on models
* [[DDF]]/[[RTS]]/[[COAL]] enhancements and bug-fixes
* [[Polyobject]]s (more types will be supported in the future)
* {{3dgewiki|CAMERA-MAN|Camera-Man scripts|linkonly=1}}: New scripting language which utilizes cameras for complete camera control.
* Support for up to 64 defined [[weapon]]s at once through DDF
* 16 Ammo types: BULLETS, SHELLS, ROCKETS, CELLS, and AMMO5 to AMMO16. (EDGE 1.29 only. AMMO1 to AMMO4 can be used as aliases for the 4 main ammo types.)
* [[3D floor|Extrafloors]] feature allows modders to create submersible liquids, [[room-over-room]], or catwalks, as well as vertically moving platforms not embedded into the floor.
* Four [[armor]] types: GREEN (33% reduction), BLUE (50% reduction), YELLOW (75% reduction) and RED (90% reduction).
* [[Automap]] can be made to be stationary instead of rotating with the player's facing angle, through [[COAL]]. Automap can also be applied as a secondary layer over the normal viewing screen opposed to replacing it, allowing the player to fight enemies and keep track of their position at one time.
* Weapons can have secondary attacks. Weapons can also be made to be manually reloaded, or have idle stats as well. Integration through COAL and RTS means Weapons and animations can be granularity customized.
* Support for [[MUS]], MIDI, IT/MOD, and Ogg Vorbis music formats.
* [[DDF]] files allow the editing of many features (such monsters, attacks, and levels).
* [[Sprite]]s can be viewed from 16 angles.
* [[RTS]] scripting format includes an option known as "Start_Map ALL" that allows global scripts to be created that affect all maps in the game without copying the script under each individual map.
* [[COAL]] virtual machine scripting language allow a more powerful alternative to functions normally found in DDF/RTS, as well as controlling the entirety of the HUD module.
* [[Door#Sliding doors|Sliding doors]], which are done separately without using PolyObjects.

== In-Progress ==
* [[Wikipedia:OpenAL|OpenAL]] for audio subsystem (being restored from EDGE 1.28, replacing SDL2), which will allow for various 3D environmental effects
* RoQ Render-to-Texture (for models, world textures, and menus/backgrounds)
* New [[DDF]] types: Terrains.ddf, Sprites.ddf, Inventory.ddf and Shaders.ddf
* Cross-platform IWAD selector
* Dynamic GLSL shader compilation
* Normal, specular, and brightmap support on world textures
* True [[inventory]] support
* Dynamic planar shadow system for [[dynamic light]]s
* [[Wikipedia:Open_Asset_Import_Library|AssImp]] 3D model back-end support for more model formats
* ''Quake 3: Arena''-style shader-based sky system
* Better [[Boom]] compatibility
* [[Decal]]s on all surfaces (using planned Decals.ddf)
* ''[[Wolfenstein_3D]]'' support (WLF_*)
* ''[[Rise of the Triad]]'' support (ROTT_*)
* ''Blake Stone'' support (BLK_*)
* ''[[Strife]]'' support

Heretic support is being finalized, and is in beta as of version 2.1.0 test 3, using a similarly named definition file called HDF (Heretic Definition File). The HDF definitions were written initially by CeeJay, before the 3DGE Team took over to write proper IWAD support.

== Popular add-ons ==
EDGE also brings its own unique set of popular add-ons to the Doom community. Although some dislike EDGE for its perceived instability, the following mods have in one way or another made their mark on the community.

A few notable mods in active development are Duke it Out in DOOM and Doom Forever, both by Chris Mullen (CeeJay), and a sequel to the [[Marc A. Pullen (Fanatic)]] mod QDOOM. ''SLaVE'' and ''Hypertension: Harmony of Darkness'' are two commercial products using this engine, both being developed by Isotope Softworks and published by Goat Store Publishing.

''Note that, as with any port enjoying such a long lifespan, backward compatibility for older mods can be hit and miss. Certain mods might run only with the application version they were designed for; the move to EDGE 2.x in particular is known to have broken support for a number of mods. Keep this in mind, and report any problems encountered if any of the below legacy mods are not running correctly.''

* [[Don's Challenge]] — Created by [[Cory Whittle]], Don's Challenge is a 3-episode modification based around the supernatural adventures of Don P. Tello, a veteran cop who is summoned into Hell by Mortis, the incarnation of Death, to challenge thousands of hellspawned creatures that his soul might be deemed worthy by her as a vessel. At the end of Episode 1, Don transforms Mortis into a cat. However, her brother Fate summons Mortis to Hell and takes Don with her. In the third episode, Don and Mortis return to Earth, only to find it overrun by Demons and Don's own family dead; Don and Mortis attempt to take vengeance for the deaths. This mod became popular due to the use of new monsters, weapons, and levels. One weapon (cigarettes) could even be used to heal the player. Another weapon (Booze) could be used to increase armor value, but took away a small portion of health as well. As of now, only one episode is fully released, but Episode 2 is reportedly on the way.
* [[Immoral Conduct]] - Created by [[Cory Whittle]], Immoral Conduct is a weapons modification for both EDGE and ZDoom (although the ZDoom version does not have as many features as its EDGE counterpart). The EDGE version contains the following: Knife, .45 Pistols, Stock 12g Pump Shotgun, Customized Pump Shotgun (fires 'slasher rounds'), 12g Hand Cannon, 9mm Uzi SMG, Fragment Hand Grenades, 40mm Grenade/Tear Gas Gun, Assault Rifle with M203, Infantry Rifle with Bayonet, Minigun, 12g Sawed-off Shotgun, Beretta 9mm Pistol, Chrome Magnum Revolver, Sentry Turret Kit (summons helper turrets to attack enemies), Gas-Powered Chainsaw, Remote/Proximity Satchel Charges, and Marking/Visibility Flares. New items included a 50% medikit and Nightvision Goggles. New helper monsters included the Marine Corporal and Marine Private. Monsters have also been modified (for example, the baron of Hell's blood is green), and shells are ejected from weapons. It is a [[partial conversion]], sometimes mistaken for a [[total conversion]], and in Whittle's words, "With my stuff, you have all the millions of user-made Doom and Doom II levels at your disposal to be enhanced with new weapons and items."

* [[Covert Ops]] — an EDGE version of [[Twilight Warrior]]. It has many features, such as new weapons and interesting scripts.

* [[QDoom]] (Quake Doom) — Created by [[Marc "Fanatic" Pullen]], QDoom is a total conversion of Quake to Doom.

* [[EarthBound Doom|EBDoom]] (Earthbound Doom) - Created by [[Baron of Sigma]], this modification has generated mixed opinions. It is not a complete game, and many consider it more of a "monster modification" since roughly 100+ different species of monsters exist, most of them imported and emulated from [[Heretic]], [[Hexen]], Duke Nukem 3D, Shadow Warrior, and Blood, and 'evolved' versions of existing game monsters, such as Chainsaw Zombies, Gold Liches, and Elder Mancubi. The game also appears to use a near-perfect emulation of the [[Sigil]] from Strife as an Easter egg weapon. In addition, the player has hit points instead of a health percentage, and can take much more damage than the common version of [[Doomguy]]. There are also several 'helper' characters based on the heroes of many of the Doom-engine games, including [[Doomguy]], [[Corvus]], and the player classes in Hexen. Certain bosses are also among the few in many modifications to have over 50,000 HP, with at least one boss having over 6,000,000 HP. The weapons are more 'mystical' and energy-based, with few traditional Doom-style weapons. Another unique feature in EBDoom is that all melee attacks used either by the player or other monsters/allies can inflict "critical hits" up to 4x damage at times, as in an RPG. Despite the community's mixed opinions of the mod, it is often used as a resource wad by other modders who want to quickly import foreign monsters into their own mods (as the author appears not to mind this). It is also one of the three mods in the Doom community to use [[Hissy]] as a central plot player, and makes many references to another EDGE mod known as [[Cacodemon Squad]]. This modification was last updated at 6.56 on January 12, 2006.

* [[GoldenEye Doom2]] - A fairly large in-progress TC. Featuring a load of weapons in both single and multiplayer maps. Multiple versions are available: A single player DEH version compatible with Doom Legacy and Zdoom 1.22. Multiplayer levels for standard Doom2. An enhanced single player EDGE 1.27+ version. The Edge version contains the following weapons: punch/kick, Knives, Watch lazer, _Soviet_Tank_, Silencedable PP7, Dostovie, Cougar Magnum, Automatic Shotgun, pathetic Klobb, Duestch, Zmg, KF7, Sniper Rifle, Ak47, Moon Raker Laser, RCP-90, Golden Gun, Golden PP7, Rocket Launcher, and Grenades. Most of the weapons have alternate firing modes and some weapons can be dual-wielded.

* [[Cold Hard Cash]] - An unique weapons mod offering a larger variety of weapons. Cold Hard Cash's spin on the weapons mod is that instead of just finding weapons laying around or dropped from enemies, the player must mug monsters for money to use at special weapons dispensers, which replace the original weapons, and sometimes artifacts and appear in their place. An example is that the Chainsaw is now a dispenser that allows the player to buy a Knife, a Crowbar, and other melee-type items. Most dispensers have a special offer on it, usually an upgrade to an existing weapon, which requires the said weapon in question to be held by the player before they can use it. It is also the first EDGE mod to use the "Start_Map ALL" RTS function, introduced in the 3rd release candidate of EDGE 1.29, which allows the same scripts to be usable on all maps instead of having to add the same ones to each map individually.

== Sources ==
*{{dwforums|id=102456|title=EDGE 2.1.0 Impending Release}}
*{{zdforums|p=1073199|3DGE 2.1.0 Test3 Released}}
*{{Next version|Development roadmap}}
*[https://www.youtube.com/watch?v=PpzvWcz7uDY Heretic support demonstration]

== External links ==
*[http://edge2.sourceforge.net Official EDGE site]
*[https://sourceforge.net/projects/edge2/files/3DGE%20binaries/ EDGE release packages], hosted by {{wp|SourceForge}}
*[https://sourceforge.net/projects/edge/files/EDGE%20Binaries/ Legacy EDGE binary releases], hosted by {{wp|SourceForge}}
*[https://github.com/3dfxdev/hyper3DGE 3DGE git repository], hosted by {{wp|github}}
*[https://devbuilds.drdteam.org/3dge/ Compiled SVN builds] for Windows, Linux, Mac, and Dreamcast at [[DRD Team]]
*{{edgewiki|Main Page|Documentation}}
*Dream3DGE:
:* [https://sourceforge.net/projects/edge2/files/3DGE%20SOURCE/DreamEDGE/ Source code repository], hosted by {{wp|SourceForge}}
:* [http://gamedev.allusion.net/softprj/kos/ KallistOS]
:* [http://www.segatech.com/technical/cpu/ SH-4 CPU]
*Mapsets and add-ons:
:* [http://www.tdgmods.net/smf/viewforum.php?f=26/ All known projects including WIPs]
:* [http://www.moddb.com/mods/duke-it-out-in-doom/ Duke it Out in DOOM]
:* {{Dwforums|id=66125|title=Doom Forever}}
:* {{Dwforums|id=64491|title=QDOOM sequel}}
:* [http://facebook.com/slavefps/ SLaVE]
:* [https://www.facebook.com/pages/Isotope-TDGMods/232903863419077/ Hypertension: Harmony of Darkness]
:* [https://www.facebook.com/Isotope-TDGMods-232903863419077/ Isotope Softworks]
:* [http://www.goatstorepublishing.com/ Goat Store Publishing]

{{s-start}}
{{s-port}}
{{s-cond}}
{{s-bef-cond|rows=2|before=[[DOSDoom]]}}
{{s-ttl|rows=2|title=EDGE 1.x}}
{{s-aft-cond|after=3DGE}}
{{s-aft-cond|after=Dream3DGE}}
{{s-bef-cond|before=EDGE 1.x}}
{{s-ttl|title=3DGE}}
{{s-aft-cond|after=EDGE 2.x}}
{{s-bef-cond|before=EDGE 1.x}}
{{s-ttl|title=Dream3DGE}}
{{s-aft-cond|after=None}}
{{s-end}}

[[Category:Source ports]]
[[Category:Boom compatible]]
[[Category:Doom ports]]
[[Category:Limit removing source ports]]
[[Category:OpenGL ports]]

Template:Zdforums

2018-11-12T23:08:11Z

Corbin: Created page with "<includeonly>[https://forum.zdoom.org/viewtopic.php?{{#if:{{{2|}}}|t={{{1}}} {{{2}}}|{{#if:{{{f|}}}|f={{{f}}}&}}{{#if:{{{t|}}}|t={{{t}}}&}}{{#if:{{{p|}}}|p={{{p}}}#p{{{p}}}}}..."

<includeonly>[https://forum.zdoom.org/viewtopic.php?{{#if:{{{2|}}}|t={{{1}}} {{{2}}}|{{#if:{{{f|}}}|f={{{f}}}&}}{{#if:{{{t|}}}|t={{{t}}}&}}{{#if:{{{p|}}}|p={{{p}}}#p{{{p}}}}} {{{1|ZDoom forum thread}}}}}]</includeonly><noinclude>
Creates a link to a thread over the [[ZDoom]] forums.

<u>Usage</u>
: '''<tt><nowiki>{{zdforums|somethread|somename}}</nowiki></tt>'''
: '''<tt><nowiki>{{zdforums|t=somethread|somename}}</nowiki></tt>'''
: '''<tt><nowiki>{{zdforums|f=someforum|t=somethread|somename}}</nowiki></tt>'''
: '''<tt><nowiki>{{zdforums|p=somepost|somename}}</nowiki></tt>'''

where ''somethread'' is the thread ID and ''somename'' the thread title or the name you want to give to the link. The thread ID is a number unique to each thread. Optionally, ''someforum'' can be specified with the forum ID. For example, in this URL:
: <tt><nowiki>https://forum.zdoom.org/viewtopic.php?f=4&t=20573</nowiki></tt>
the thread ID is 20573 and the forum ID is 4.

Alternatively, ''somepost'' is the post ID, unique to a post in any forum and thread. For example, in this URL:
: <tt><nowiki>https://forum.zdoom.org/viewtopic.php?p=403186#p403186</nowiki></tt>
the post ID is 403186.

*If no title is given, the template uses a generic "ZDoom forums thread" title.
[[Category:External link templates]]</noinclude>

Template:Dwforums

2018-11-12T23:07:41Z

Corbin: Created page with "<onlyinclude><includeonly>{{#if:{{{1|{{{id|}}}}}}|<span class="plainlinks">[https://www.doomworld.com/vb/thread/{{{id|{{{1}}}}}} {{{title|{{{2|Doomworld forums thread}}}}}}]</..."

<onlyinclude><includeonly>{{#if:{{{1|{{{id|}}}}}}|<span class="plainlinks">[https://www.doomworld.com/vb/thread/{{{id|{{{1}}}}}} {{{title|{{{2|Doomworld forums thread}}}}}}]</span>|Error: no id given, see [[Template:Dwforums|the instructions]] to use this template.}}</includeonly></onlyinclude><noinclude>
Creates a link to a thread over the Doomworld forums.

<u>Usage</u>
: '''<tt><nowiki>{{Dwforums|id=somenumber|title=somename}}</nowiki></tt>'''

where ''somenumber'' is the thread ID and ''somename'' the thread title or the name you want to give to the link. The thread ID is a number unique to each thread. For example, in this URL:
: <tt><nowiki>https://www.doomworld.com/vb/doomworld-news/6148-the-newstuff-chronicles-75/</nowiki></tt>
the thread ID is 6148.

''Example:'' <tt><nowiki>{{Dwforums|id=6148|title=Newstuff Chronicles #75}}</nowiki></tt> becomes {{Dwforums|id=6148|title=Newstuff Chronicles #75}}

*The ID can also be the first, unnamed parameter: <tt><nowiki>{{dwforums|6148|title=tNC75}}</nowiki></tt> becomes {{dwforums|6148|title=tNC75}}.
*The title can also be the second unnamed parameter: <tt><nowiki>{{dwforums|6148|tNC75}}</nowiki></tt> becomes {{dwforums|6148|tNC75}}.
*If no title is given, the template uses a generic "Doomworld forums thread" title.
*If no id is given, the template displays an error message: {{dwforums}}

[[Category:External link templates]]</noinclude>

File:EDGE LogoNew.jpg

2018-11-12T23:06:05Z

Corbin:

EDGE

2018-11-12T23:05:40Z

Corbin:

{{InfoboxSourcePort
|title = EDGE, 3DGE, Hyper3DGE, Dream3DGE
|developer = [[Coraline_(Chu)|Cora Annis]], [[Joseph Fenton]], [[Rachael Alexanderson (Eruanna)]], [[Brendan Doe]], [[Damir Srpčič]], [[Maciej Kadlubowski]], [[Andrew Apted]], [[Andy Baker (darkknight)]], [[Darren Salt]], [[Erik Sandberg]], [[David Leatherdale]]
|nondeveloper = [[Chris Mullen (CeeJay)]], [[UsernameAK]], [[gameblabla]], [[Josh Pearson]], [[Benjamin Moir]], [[Luke Brennan (Lobo)]], [[Marc A. Pullen (Fanatic)]]
|baseparent = [[DOSDoom]]
|logo = [[File:EDGE LogoNew.jpg]]
|programming language = [[Wikipedia:C++|C++]], [[Wikipedia:QuakeC|QuakeC (modified)]]
|status = Active
|initialdate = 2000-06-20
|initialversion = 1.22
|platform = Cross-Platform
|license = {{GPL||2+}}
|website = [http://edge2.sourceforge.net/ SourceForge]
|repourl = [https://github.com/3dfxdev/hyper3DGE GitHub]
}}
'''EDGE''' (Enhanced Doom Gaming Engine) is a collaborative Open Source project based upon the [[Doom source code]]. EDGE is derived from an earlier project called [[DOSDoom]], and started development in 1999 immediately after DOSDoom 0.65 was released. '''EDGE''' is sometimes referred to as '''3DGE''', or '''hyper3DGE''' due to the long-standing development of the '''3DGE''' fork, which was initially released on April 11, 2011; it was originally created to power the ''Hypertension'' TC, and absorbed back into EDGE seven years later. The first official EDGE version was released on June 20, 2000. The latest stable version is 2.0.4, released on December 13, 2016. The team releases *[https://devbuilds.drdteam.org/3dge/ DRDT] semi-regular development builds via [[DRD Team]].

EDGE includes ports to many popular operating systems, including x86/x64 Windows, Linux, BeOS, Raspberry PI, Sega Dreamcast, and Mac OSX. The project is hardware-accelerated only, and also implements support for PowerVR2 CLX2 (through KallistiOS) for the Dreamcast platform. Previous versions of EDGE incorporated both software-rendered and hardware-accelerated versions, though the former was dropped with the release of version 1.29.

The most attractive feature of EDGE is its [[DDF]] system, which originated from DOSDoom. DDF describes all game behavior inside text files external to the executable file. As a result, it is popular among modders who use the extensibility to add many new weapons and features with many fewer of the limits present in other source ports. With DDF, for example, it is possible to create monsters which can possess multiple missile and melee attacks, or create custom pain and death states for monsters when hit by specific weapons or projectiles. Combined together with [[RTS]] and the more modular, modern language [[COAL]], EDGE can rival what other popular ports are capable of through their respective scripting language implementations.

'''Dream3DGE''' was a [[Sega]] Dreamcast-only port of EDGE 1.29, and has high compatibility with pre-1.31 mods, as it cannot currently run anything created with EDGE 1.31 or above. It must be built with KallistOS. It contains most, if not all, functionality from the parent port. This branch (and EDGE 1.29, on which it was based) was abandoned officially and rewritten and integrated back into 3DGE with version 2.0. The Dreamcast code utilizes KallistiGL instead of OpenGL for important rendering functions concerning the SH-4 CPU.

== Early History ==

DOSDoom began development in 1997, initially by [[Chi Hoang]] and coined the term source-port. [[Andy Baker (darkknight)]] was a frequent collaborator, and soon amassed a team of developers known as the {{3dgewiki|DOSDoom_Team|DOSDoom Team|linkonly=1}}. The entirety of the DOSDoom team began developing pioneering systems that other ports did not have at the time, including [[DDF]] and [[RTS]] scripting languages - the first such human-readable systems for DOOM. It is worth noting that the scripting systems were wholly different from [[DeHacked]] at the time because they did not need to modify the executable directly, and were split into several different files that could control much more at a granular level than DeHacked ever could. The {{3dgewiki|DOSDoom_Team|DOSDoom Team|linkonly=1}} consisted of Hoang, Baker, [[Erik Sandberg]], [[Kester Maddock]], [[Martin Howe]], [[John Cole]] and [[David Leatherdale]].

Into 1998, the community was ripe with the emergence of other source-ports, including [[ZDoom]], [[Doom Legacy]], [[Boom]], as well as the first [[Wikipedia:OpenGL|OpenGL]] accelerated engine, [[glDoom]]. glDoom especially made an impact on the team into 1999 as OpenGL was seen as a major advancement at the time - this would be highly influential later in development. DOSDoom continued to be a major powerhouse for modders well into development of EDGE.

In mid 1998, [[TeamTNT]] discussed with the {{3dgewiki|DOSDoom_Team|DOSDoom Team|linkonly=1}} about merging their project, [[OGRE]], directly into [[DOSDoom]]. The collaboration was announced in late 1998 and generated much interest as TeamTNT previously developed another ground-breaking port named [[BOOM]]; discussions were even joined by the inclusion of [[John Carmack]]. However, difficulties ensued for all parties and the project was abandoned. OGRE was quite possibly the progenitor of [[EDGE]] as several of the ideas both teams wanted to do was further realized with the development of EDGE. The failed merger didn't affect DOSDoom's ultimate standing and the port continued to be popular; though, possibly as a result of the planned/failed merger of DOSDoom and OGRE, Hoang left the DOSDoom Team and the DOOM community after v0.63 was released, followed by other DOSDoom members.

== History ==

In early 1999, several more source-ports were released, all offering their own features. [[3D floor]]s were pioneered with DOSDoom which generated much interest, but the DOSDoom Team began rifting as some members left the community altogether, or joined different projects. Andrew Baker and his team devised that a re-haul of DOSDoom was inevitable; the primary motivation being that the port was no longer limited to the DOS operating system.

It was also around this time that [[Andrew Apted]] had joined the team; it was decided that the DOSDoom name would change to better reflect its status as the most advanced 3D source-port of its time. *{{3dgewiki|TADE|TADE|linkonly=1}} was seen as a possible name before the team ultimately settled on EDGE; the port was in development before DOSDoom saw its final public release.

DOSDoom v0.653 was released in April 10, 1999, which would be its final version. The surviving members of the DOSDoom Team [Baker, Erik Sandberg, and David Leatherdale], with Andrew Apted, immediately formed the EDGE team from the existing code-base.

EDGE was officially released on June 20, 2000 after more than a year and a half being in secret development; it was seen as a milestone as the DDF and RTS systems were more fully realized, as well as becoming an early adopter of [[Wikipedia:OpenGL|OpenGL]] rendering. At the time, EDGE was the most advanced port as several other emergent technologies were realized in tandem, including [[glBSP]], the first true 3D node-builder for DOOM.

The development of Marc A. Pullen's [[QDoom]] was seen as a major motivating factor for the EDGE team in its early years; its release was very popular and helped elevate EDGE's status as a true modder-centric engine. [[Cory Whittle]] was also a frequent developer of EDGE modifications that also kept the port healthy.

EDGE development continued into the next decade; while the early years were notable for EDGE being the supreme choice for modders and OpenGL enthusiasts, the team began to experience strain in the mid 2000's. As most members of the DOSDoom team had left by 2004, development was primarily being shouldered by Andrew Baker and Andrew Apted. Later, with the major rewrites of the engine between 1.27 and 1.29, development was shifted primarily between the last two active developers; because of the burden of a largely two-man team, the engine was perceived as being somewhat unstable. With the release of 1.31, EDGE's standing improved and modders began returning to the engine, though [[ZDoom]] was tearing much of the share away. Since the engine had once again experienced large rendering and game-play rewrites between 1.29 and 1.31, the remainder of development was primarily headed by Andrew Apted.

Sometime in 2010, Andrew Baker had fully retired from the team, and Andrew Apted was growing more interested in other projects. He was beginning to make plans to fix up any outstanding issues with EDGE and make the final release. Perhaps as a result of ZDoom's popularity, Andrew Apted could not keep up with all of the feature requests, as he had invested much work and time into the 1.3x branch of EDGE. He began hinting at his desire to shift to other projects, notably [[Eureka]] and [[OBLIGE]], which were later released to much acclaim.

Into 2011, the community was well aware of his plans to retire from development with the release of 1.35. At the time, a major TC named [[Hypertension]] was perhaps the biggest project to be developed on the engine recently. The team of that TC [Isotope SoftWorks] foresaw the closing, and development of a fork named '''3DGE''' began to continue development as the modding team still required features that were only possible if they did it themselves.

The EDGE 1.x team consisted of [[Andrew Apted]] and [[Andy Baker (darkknight)]] as the primary developers, and [[Marc A. Pullen (Fanatic)]] and [[Luke Brennan (Lobo)]] as distributors/promoters. [[Darren Salt]] was also a frequent developer and contributed a lot of code and bugfixes.

== Later History and Current Status ==

On April 9, 2011, Andrew Apted announced his retirement from EDGE development, leaving EDGE without a maintainer for over seven years. The last version of EDGE 1.x (1.35), was released on the same day. Two days later, the first version of '''3DGE''' was released as a hot-fix to 1.35, having merged from an abandoned earlier rewrite of EDGE itself.

EDGE development (under the name ''3DGE'') therefore continued from 2011 well into 2018, introducing major long-requested features which were seen as somewhat standard for other modder-centric ports, including [[UDMF]], archive support, [[GLSL]] shaders, and much improved and expanded features for the [[DDF]], [[RTS]], and [[COAL]] systems; lots of hard work was put into the port since the last version was released in 2016.

EDGE's persistent popularity and perseverance earned the respect and occasional development contributions from several other major developers in the community, including GZDoom programmers [[dpJudas]], [[Rachael Alexanderson (Eruanna)]] and [[Graf Zahl]]. Andrew Apted would occasionally assist the team by providing assistance as needed.

On September 18th, 2018, [[Coraline_(Chu)|Cora Annis]] made an announcement of the next major version of EDGE, which would have been the first full version released by the new team since 2016. With Andrew Apted's support and blessing, the separated 3DGE fork (which was long thought as confusing due to naming and version issues) was officially absorbed back into EDGE. The impending release of 2.1.0 (stable) will mark the first version of EDGE officially released since 2011. EDGE is therefore split into two categories as far as releases are concerned - the 1.x branches, and the 2.x branches.

== Features ==
* [[Wikipedia:OpenGL|OpenGL]] 1.1/3.1 Renderer Paths, with Mipmapping, Smoothing, Dynamic Lighting, mirrors, portals, and [[Wikipedia:GLSL|GLSL]] shader support; Bump-Mapping/GLSL is only supported in the 3.1 rendering path.
* 64-bit support
* SDL2 integration
* [[UDMF]] support
* PAK/[[PK3]]/PK7/{{3dgewiki|EPK|EPK|linkonly=1}} {{3dgewiki|Using_ZIPs_as_WAD_replacement|archive support|linkonly=1}}
* Rendering interpolation and Vsync support
* JPEG, PNG, TGA, BMP, PSD, GIF, HDR, PIC, PNM high-res textures; including support for [[TX_START]]/TX_END and [[HI_START]]/HI_END texture namespaces, and grAb offset support for [[PNG]] images.
* [[OPL]] synth playback (using nukeyT's OPLlib)
* Basic shadows restored from EDGE 1.27
* Integration of [[ZDBSP]] and improvements to [[glBSP]], including building nodes from archives; overall better 3D rendering of both existing Doom levels and newer levels.
* Several major and minor bugs squashed from the [[EDGE]] 1.x releases
* [[Heretic]]/[[Chex Quest]] IWAD support
* {{3dgewiki|MD3|MD3|linkonly=1}} and {{3dgewiki|MD5|MD5|linkonly=1}} model support
* Two-player [[splitscreen]] [[co-op]] or [[deathmatch]] (local only)
* [[multimedia:RoQ|RoQ]] video support for cinematics
* Runs on the [[Wikipedia:Dreamcast|Sega Dreamcast]] console.
* Normal, specular and bright-map support on models
* [[DDF]]/[[RTS]]/[[COAL]] enhancements and bug-fixes
* [[Polyobject]]s (more types will be supported in the future)
* {{3dgewiki|CAMERA-MAN|Camera-Man scripts|linkonly=1}}: New scripting language which utilizes cameras for complete camera control.
* Support for up to 64 defined [[weapon]]s at once through DDF
* 16 Ammo types: BULLETS, SHELLS, ROCKETS, CELLS, and AMMO5 to AMMO16. (EDGE 1.29 only. AMMO1 to AMMO4 can be used as aliases for the 4 main ammo types.)
* [[3D floor|Extrafloors]] feature allows modders to create submersible liquids, [[room-over-room]], or catwalks, as well as vertically moving platforms not embedded into the floor.
* Four [[armor]] types: GREEN (33% reduction), BLUE (50% reduction), YELLOW (75% reduction) and RED (90% reduction).
* [[Automap]] can be made to be stationary instead of rotating with the player's facing angle, through [[COAL]]. Automap can also be applied as a secondary layer over the normal viewing screen opposed to replacing it, allowing the player to fight enemies and keep track of their position at one time.
* Weapons can have secondary attacks. Weapons can also be made to be manually reloaded, or have idle stats as well. Integration through COAL and RTS means Weapons and animations can be granularity customized.
* Support for [[MUS]], MIDI, IT/MOD, and Ogg Vorbis music formats.
* [[DDF]] files allow the editing of many features (such monsters, attacks, and levels).
* [[Sprite]]s can be viewed from 16 angles.
* [[RTS]] scripting format includes an option known as "Start_Map ALL" that allows global scripts to be created that affect all maps in the game without copying the script under each individual map.
* [[COAL]] virtual machine scripting language allow a more powerful alternative to functions normally found in DDF/RTS, as well as controlling the entirety of the HUD module.
* [[Door#Sliding doors|Sliding doors]], which are done separately without using PolyObjects.

== In-Progress ==
* [[Wikipedia:OpenAL|OpenAL]] for audio subsystem (being restored from EDGE 1.28, replacing SDL2), which will allow for various 3D environmental effects
* RoQ Render-to-Texture (for models, world textures, and menus/backgrounds)
* New [[DDF]] types: Terrains.ddf, Sprites.ddf, Inventory.ddf and Shaders.ddf
* Cross-platform IWAD selector
* Dynamic GLSL shader compilation
* Normal, specular, and brightmap support on world textures
* True [[inventory]] support
* Dynamic planar shadow system for [[dynamic light]]s
* [[Wikipedia:Open_Asset_Import_Library|AssImp]] 3D model back-end support for more model formats
* ''Quake 3: Arena''-style shader-based sky system
* Better [[Boom]] compatibility
* [[Decal]]s on all surfaces (using planned Decals.ddf)
* ''[[Wolfenstein_3D]]'' support (WLF_*)
* ''[[Rise of the Triad]]'' support (ROTT_*)
* ''Blake Stone'' support (BLK_*)
* ''[[Strife]]'' support

Heretic support is being finalized, and is in beta as of version 2.1.0 test 3, using a similarly named definition file called HDF (Heretic Definition File). The HDF definitions were written initially by CeeJay, before the 3DGE Team took over to write proper IWAD support.

== Popular add-ons ==
EDGE also brings its own unique set of popular add-ons to the Doom community. Although some dislike EDGE for its perceived instability, the following mods have in one way or another made their mark on the community.

A few notable mods in active development are Duke it Out in DOOM and Doom Forever, both by Chris Mullen (CeeJay), and a sequel to the [[Marc A. Pullen (Fanatic)]] mod QDOOM. ''SLaVE'' and ''Hypertension: Harmony of Darkness'' are two commercial products using this engine, both being developed by Isotope Softworks and published by Goat Store Publishing.

''Note that, as with any port enjoying such a long lifespan, backward compatibility for older mods can be hit and miss. Certain mods might run only with the application version they were designed for; the move to EDGE 2.x in particular is known to have broken support for a number of mods. Keep this in mind, and report any problems encountered if any of the below legacy mods are not running correctly.''

* [[Don's Challenge]] — Created by [[Cory Whittle]], Don's Challenge is a 3-episode modification based around the supernatural adventures of Don P. Tello, a veteran cop who is summoned into Hell by Mortis, the incarnation of Death, to challenge thousands of hellspawned creatures that his soul might be deemed worthy by her as a vessel. At the end of Episode 1, Don transforms Mortis into a cat. However, her brother Fate summons Mortis to Hell and takes Don with her. In the third episode, Don and Mortis return to Earth, only to find it overrun by Demons and Don's own family dead; Don and Mortis attempt to take vengeance for the deaths. This mod became popular due to the use of new monsters, weapons, and levels. One weapon (cigarettes) could even be used to heal the player. Another weapon (Booze) could be used to increase armor value, but took away a small portion of health as well. As of now, only one episode is fully released, but Episode 2 is reportedly on the way.
* [[Immoral Conduct]] - Created by [[Cory Whittle]], Immoral Conduct is a weapons modification for both EDGE and ZDoom (although the ZDoom version does not have as many features as its EDGE counterpart). The EDGE version contains the following: Knife, .45 Pistols, Stock 12g Pump Shotgun, Customized Pump Shotgun (fires 'slasher rounds'), 12g Hand Cannon, 9mm Uzi SMG, Fragment Hand Grenades, 40mm Grenade/Tear Gas Gun, Assault Rifle with M203, Infantry Rifle with Bayonet, Minigun, 12g Sawed-off Shotgun, Beretta 9mm Pistol, Chrome Magnum Revolver, Sentry Turret Kit (summons helper turrets to attack enemies), Gas-Powered Chainsaw, Remote/Proximity Satchel Charges, and Marking/Visibility Flares. New items included a 50% medikit and Nightvision Goggles. New helper monsters included the Marine Corporal and Marine Private. Monsters have also been modified (for example, the baron of Hell's blood is green), and shells are ejected from weapons. It is a [[partial conversion]], sometimes mistaken for a [[total conversion]], and in Whittle's words, "With my stuff, you have all the millions of user-made Doom and Doom II levels at your disposal to be enhanced with new weapons and items."

* [[Covert Ops]] — an EDGE version of [[Twilight Warrior]]. It has many features, such as new weapons and interesting scripts.

* [[QDoom]] (Quake Doom) — Created by [[Marc "Fanatic" Pullen]], QDoom is a total conversion of Quake to Doom.

* [[EarthBound Doom|EBDoom]] (Earthbound Doom) - Created by [[Baron of Sigma]], this modification has generated mixed opinions. It is not a complete game, and many consider it more of a "monster modification" since roughly 100+ different species of monsters exist, most of them imported and emulated from [[Heretic]], [[Hexen]], Duke Nukem 3D, Shadow Warrior, and Blood, and 'evolved' versions of existing game monsters, such as Chainsaw Zombies, Gold Liches, and Elder Mancubi. The game also appears to use a near-perfect emulation of the [[Sigil]] from Strife as an Easter egg weapon. In addition, the player has hit points instead of a health percentage, and can take much more damage than the common version of [[Doomguy]]. There are also several 'helper' characters based on the heroes of many of the Doom-engine games, including [[Doomguy]], [[Corvus]], and the player classes in Hexen. Certain bosses are also among the few in many modifications to have over 50,000 HP, with at least one boss having over 6,000,000 HP. The weapons are more 'mystical' and energy-based, with few traditional Doom-style weapons. Another unique feature in EBDoom is that all melee attacks used either by the player or other monsters/allies can inflict "critical hits" up to 4x damage at times, as in an RPG. Despite the community's mixed opinions of the mod, it is often used as a resource wad by other modders who want to quickly import foreign monsters into their own mods (as the author appears not to mind this). It is also one of the three mods in the Doom community to use [[Hissy]] as a central plot player, and makes many references to another EDGE mod known as [[Cacodemon Squad]]. This modification was last updated at 6.56 on January 12, 2006.

* [[GoldenEye Doom2]] - A fairly large in-progress TC. Featuring a load of weapons in both single and multiplayer maps. Multiple versions are available: A single player DEH version compatible with Doom Legacy and Zdoom 1.22. Multiplayer levels for standard Doom2. An enhanced single player EDGE 1.27+ version. The Edge version contains the following weapons: punch/kick, Knives, Watch lazer, _Soviet_Tank_, Silencedable PP7, Dostovie, Cougar Magnum, Automatic Shotgun, pathetic Klobb, Duestch, Zmg, KF7, Sniper Rifle, Ak47, Moon Raker Laser, RCP-90, Golden Gun, Golden PP7, Rocket Launcher, and Grenades. Most of the weapons have alternate firing modes and some weapons can be dual-wielded.

* [[Cold Hard Cash]] - An unique weapons mod offering a larger variety of weapons. Cold Hard Cash's spin on the weapons mod is that instead of just finding weapons laying around or dropped from enemies, the player must mug monsters for money to use at special weapons dispensers, which replace the original weapons, and sometimes artifacts and appear in their place. An example is that the Chainsaw is now a dispenser that allows the player to buy a Knife, a Crowbar, and other melee-type items. Most dispensers have a special offer on it, usually an upgrade to an existing weapon, which requires the said weapon in question to be held by the player before they can use it. It is also the first EDGE mod to use the "Start_Map ALL" RTS function, introduced in the 3rd release candidate of EDGE 1.29, which allows the same scripts to be usable on all maps instead of having to add the same ones to each map individually.

== Sources ==
*{{dwforums|id=102456|title=EDGE 2.1.0 Impending Release}}
*{{zdforums|p=1073199|3DGE 2.1.0 Test3 Released}}
*{{edgewiki|Next version|Development roadmap}}
*[https://www.youtube.com/watch?v=PpzvWcz7uDY Heretic support demonstration]

== External links ==
*[http://edge2.sourceforge.net Official EDGE site]
*[https://sourceforge.net/projects/edge2/files/3DGE%20binaries/ EDGE release packages], hosted by {{wp|SourceForge}}
*[https://sourceforge.net/projects/edge/files/EDGE%20Binaries/ Legacy EDGE binary releases], hosted by {{wp|SourceForge}}
*[https://github.com/3dfxdev/hyper3DGE 3DGE git repository], hosted by {{wp|github}}
*[https://devbuilds.drdteam.org/3dge/ Compiled SVN builds] for Windows, Linux, Mac, and Dreamcast at [[DRD Team]]
*{{edgewiki|Main Page|Documentation}}
*Dream3DGE:
:* [https://sourceforge.net/projects/edge2/files/3DGE%20SOURCE/DreamEDGE/ Source code repository], hosted by {{wp|SourceForge}}
:* [http://gamedev.allusion.net/softprj/kos/ KallistOS]
:* [http://www.segatech.com/technical/cpu/ SH-4 CPU]
*Mapsets and add-ons:
:* [http://www.tdgmods.net/smf/viewforum.php?f=26/ All known projects including WIPs]
:* [http://www.moddb.com/mods/duke-it-out-in-doom/ Duke it Out in DOOM]
:* {{Dwforums|id=66125|title=Doom Forever}}
:* {{Dwforums|id=64491|title=QDOOM sequel}}
:* [http://facebook.com/slavefps/ SLaVE]
:* [https://www.facebook.com/pages/Isotope-TDGMods/232903863419077/ Hypertension: Harmony of Darkness]
:* [https://www.facebook.com/Isotope-TDGMods-232903863419077/ Isotope Softworks]
:* [http://www.goatstorepublishing.com/ Goat Store Publishing]

{{s-start}}
{{s-port}}
{{s-cond}}
{{s-bef-cond|rows=2|before=[[DOSDoom]]}}
{{s-ttl|rows=2|title=EDGE 1.x}}
{{s-aft-cond|after=3DGE}}
{{s-aft-cond|after=Dream3DGE}}
{{s-bef-cond|before=EDGE 1.x}}
{{s-ttl|title=3DGE}}
{{s-aft-cond|after=EDGE 2.x}}
{{s-bef-cond|before=EDGE 1.x}}
{{s-ttl|title=Dream3DGE}}
{{s-aft-cond|after=None}}
{{s-end}}

[[Category:Source ports]]
[[Category:Boom compatible]]
[[Category:Doom ports]]
[[Category:Limit removing source ports]]
[[Category:OpenGL ports]]

COAL Manual

2018-10-02T17:31:27Z

Corbin: added player.add_tactile() to the COAL Manual

== OVERVIEW ==

[[COAL|COAL]] is a new scripting language which has been developed especially for 3DGE. At the moment, 3DGE uses this to define custom HUD modules. This manual is designed to get you up-to-speed on all of the functions that COAL provides.<blockquote>The standard Coal scripts for drawing the DOOM HUD is loaded from this file: <code>doom_ddf/coal_hud.ec</code></blockquote><blockquote>The API that COAL itself is contained in is loaded from <code>doom_ddf/coal_api.ec</code>, which is a good reference to look at while developing your HUD. Take note that the API is hard-coded to 3DGE.</blockquote><blockquote>Additionally, each archive may contain a lump called "<code>COALHUDS</code>" which is automatically loaded (which can reside in the PAK/PK3 namespace ''<sub><code>./scripts</code></sub>''). Later scripts are able to replace any definitions (functions etc) in earlier scripts.</blockquote>

== FILES CONTENTS ==

=== The contents of each file or lump is simply the text of the COAL code. ===
The engine provides two modules: the "hud" module provides drawing functions and general queries, whereas the "player" module provides query functions about the current player. All of their functions and variables are described in separate sections below.

In order to customize the default HUDs, your COAL code ''needs'' to redefine one of the existing functions, as follows:<blockquote><big>'''doom_status_bar()'''</big> ''':''' <code>replace this function if you only want to customize the full status bar (including the one shown in the automap screen). The size has to be the same (width 320, height 32).</code></blockquote><blockquote><big>'''overlay_status_bar()'''</big> ''':''' <code>write your own version of this function if you only want to change the overlay status bar.</code></blockquote><blockquote><big>'''doom_automap()'''</big> ''':''' <code>this function draws the automap screen (including the status bar at the bottom). Replacing it means you can show other information here instead of (or in addition to) the automap.</code></blockquote><blockquote><big>'''draw_all()'''</big> ''':''' <code>this is the function which EDGE calls to draw everything. The normal version (in EDGE.WAD) will call the above functions depending on the user's current HUD and whether the automap is active or not. Replacing this function gives you total control: you could provide more hud configurations (or less) than the usual three, ignore the automap mode completely if you wanted, or even draw the view from multiple players.</code></blockquote>

== HUD MODULE ==

=== General Queries ===

==== <code>'''hud.check_automap() : float'''</code> ====
<blockquote><code>''This function returns true while the user is viewing the automap (by pressing TAB) and false for the normal view.''</code></blockquote>

==== <code>'''hud.which_hud() : float'''</code> ====
<blockquote><code>''This variable returns the current HUD number which the user cycles through when pressing '+' and '-' keys. It ranges from 0 to 119, allowing 120 different HUD screens, but in reality you must use the modulo operator '%' to convert this number to a smaller range.''</code></blockquote><blockquote><code>''For example, the standard code uses hud.which_hud() % 3 to select between three different huds (none, normal and overlay).''</code> </blockquote><blockquote><code>''The following are good modulo numbers: 2,3,4,5,6,8 and 10 (because they divide into 120).''</code></blockquote><blockquote><code>For a HUD which never changes, simply ignore this value.</code></blockquote>

==== '''<code>hud.get_time() : float</code>''' ====
<blockquote><code>''This function returns the current time, in terms of "tics" where there are 35 tics per second. In other words, after each 1/35th of a second the value of '''hud.now_time''' increases by one. It keeps going even during menus or while the game is paused.''</code></blockquote>

==== '''<code>hud.passed_time</code>''' ====
<blockquote><code>''This variable is updated by the '''hud.grab_times()''' call, and contains the number of "tics" that have passed since the last time the '''draw_all()''' function was called. Note that a result of zero is possible.''</code></blockquote>

==== '''<code>hud.game_mode() : string</code>''' ====
<blockquote><code>''This function returns a string for the current game mode: "sp" (Single Player), "coop" (Cooperative), or "dm" (Deathmatch).''</code></blockquote>

==== '''<code>hud.game_name() : string</code>''' ====
<blockquote>''<code>This function returns the DDF name of the current game being played (the one defined in [[GAMES|GAMES.DDF]]).</code>''</blockquote>

==== '''<code>hud.map_name() : string</code>''' ====
<blockquote>''<code>This function returns the DDF name of the current map being played (the one defined in [[LEVELS|LEVELS.DDF]]).</code>''</blockquote>

==== '''<code>hud.map_title() : string</code>''' ====
<blockquote>''<code>This function returns the title of the map being played, mainly to be displayed on the automap.</code>''</blockquote>

== * Drawing Stuff ==

==== '''<code>hud.coord_sys(w, h)</code>''' ====
<blockquote>''<code>In the original DOOM, the screen size was always 320x200, and by default all of the drawing functions here use screen coordinates as if that were the case (even when EDGE is running in different modes likes 640x480 or 1024x768). This function allows you to set a different "virtual" resolution, for example 640x400, and then all coordinates will be for this new system, plus the size of images and text characters will be affected as well.</code>''</blockquote>

==== <code>'''hud.text_font(name)'''</code> ====
<blockquote><code>''Sets the current text font, where the 'name' parameter refers to an entry in [[FONTS|FONTS.DDF]]. The default font is "DOOM" and is reset after each frame.''</code></blockquote>

==== '''<code>hud.text_color(name)</code>''' ====
<blockquote>''<code>Sets the current text color, which must refer to an entry in [[COLMAP|COLMAPS.DDF]], or can be the empty string "" which causes the text to be drawn normally (without being colormapped). The default is "" and is reset after each frame.</code>''</blockquote>

==== '''<code>hud.set_scale(value)</code>''' ====
<blockquote>''<code>Sets the scaling for drawing text and for '''hud.draw_image()'''. Larger values make the text/image bigger. The default scale is 1.0 and is reset after each frame.</code>''</blockquote>

==== '''<code>hud.set_alpha(value)</code>''' ====
<blockquote>''<code>Set the alpha value (translucency) for drawing text, lines, boxes and images. The 'value' parameter ranges from 0.0 (completely invisible) to 1.0 (completely solid). The default alpha is 1.0 and is reset after each frame.</code>''</blockquote>

==== '''<code>hud.solid_box(x, y, w, h, color)</code>''' ====
<blockquote><code>''Draws a solid rectangle consisting of a single color. The 'x' and 'y' parameters are the coordinates of the top left corner, whereas 'w' and 'h' are the width and height. The current alpha value is also applied.''</code></blockquote><blockquote>''<code>The 'color' parameter can take two different forms. Firstly it may be a string with the same notation as DDF and HTML, which begins with a "#" character and is followed by 6 hexadecimal digits. For example "#FF0000" for red and "#0000FF" for blue. Secondly it can be a Lua table with fields called 'r', 'g' and 'b' (for red, green and blue). Each of these fields is a number from 0 to 255. For example: { r=255, g=170, b=0 } for orange.</code>''</blockquote>

==== '''<code>hud.solid_line(x1, y1, x2, y2, color)</code>''' ====
<blockquote><code>''Draws a solid line between the start coordinate (x1,y1) to the end coordinate (x2, y2). The 'color' parameter is the same as for hud.solid_box(), and the current alpha value is also applied.''</code></blockquote>

==== '''<code>hud.thin_box(x, y, w, h, color)</code>''' ====
<blockquote>''<code>Similar to '''hud.solid_box()''', but only draws the outline of a rectangle. The inside area is not affected. The sides are always two pixels thick, and never go outside the specified area. The 'color' parameter is the same as for '''hud.solid_box()''', and the current alpha value is also applied.</code>''</blockquote>

==== '''<code>hud.gradient_box(x, y, w, h, TL, BL, TR, BR)</code>''' ====
<blockquote><code>''Similar to '''hud.solid_box()''', but the colors for each corner are specified individually: 'TL' for top left, 'BL' for bottom left, 'TR' for top right and 'BR' for bottom right. The current alpha value will also be applied.''</code></blockquote>

==== <code>'''hud.draw_image(x, y, name)'''</code> ====
<blockquote>''<code>Draws an image at the given coordinates, which specify the top/left corner of the image. The current alpha and scaling factors are applied as well.</code>''</blockquote>

==== '''<code>hud.stretch_image(x, y, w, h, name)</code>''' ====
<blockquote>''<code>Similar to '''hud.draw_image()''', but the image will be stretched or squashed so that it fits exactly into the given rectangle on the screen. The current alpha value is also applied.</code>''</blockquote>

==== '''<code>hud.tile_image(x, y, w, h, name, [x_offset, y_offset])</code>''' ====
<blockquote>''<code>Draws an image (usually a texture or flat) on the screen, where the image is tiled (repeated) to fill up the given rectangle. The current alpha and scaling factors are also applied. The 'x_offset' and 'y_offset' parameters are optional, and can be used to offset the texture by a certain number of pixels.</code>''</blockquote>

==== '''<code>hud.draw_text(x, y, str)</code>''' ====
<blockquote><code>''Draws some text on the screen using the current text font, color, alpha and scaling values. Newlines ("\n") in the string can be used to draw multi-line text.''</code></blockquote>

==== '''<code>hud.draw_num2(x, y, len, num)</code>''' ====
<blockquote>''<code>Draws a number (an integer) on the screen using the current text font, color, alpha and scaling. The number is right-aligned, in other words the 'x' parameter specified the right-most pixel, and the 'len' parameter gives the maximum number of characters (including the minus sign if the number is negative).</code>''</blockquote>

==== '''<code>hud.render_world(x, y, w, h)</code>''' ====
<blockquote><code>''Renders the view for the player on the screen, in a rectangle with the given coordinates. The player's weapon is also drawn. The views of different players can be rendered by using the '''hud.set_render_who()''' function below.''</code></blockquote>

==== '''<code>hud.render_automap(x, y, w, h, [options])</code>''' ====
<blockquote>''<code>Renders the automap for the player on the screen, in a rectangle with the given coordinates. Note that no background is drawn, hence you can use this function to create an overlay automap (drawn over the top of the player's view). If you need a solid color behind it, use the '''hud.solid_box()''' function first.</code>''</blockquote><blockquote><code>The 'options' parameter is optional, when present it is a table containing a set of variables which modify the way the automap is drawn. Variables which are not present in the table are not affected (stay the same as the user's normal automap). The following list shows all the possible variables:</code></blockquote><blockquote><code>Variable Description</code></blockquote>
** <code>zoom Set a fixed zoom factor, where 1.0 shows the whole map, and larger values make the map bigger</code>

** <code>grid force the grid lines on/off</code>
** <code>rotate force map rotation on/off</code>
** <code>follow force follow-player mode on/off</code>
** <code>things draw all things</code>
** <code>walls draw all walls (like IDDT cheat)</code>
** <code>allmap draw walls like All-Map powerup</code>

==== <code>'''hud.set_render_who(index)'''</code> ====
<blockquote>''<code>Sets the current player for rendering the world or the automap. The 'index' parameter is a small number: 1 for the "main player" on this computer (the person at the keyboard), 2 for the next player in the list, etc... upto the number of players in the game.</code>''</blockquote>

==== <code>'''hud.automap_colors(table)'''</code> ====
<blockquote>''<code>This function can be used to change some or all of the colors used when drawing the automap. The 'table' parameter is a Lua table where the names are automap parts and the values are the colors. For example: { grid = "#006666", wall = "#FFFFFF" }. Parts that are not present in the table are not affected (stay the same as before). Here is a list of all the automap parts that can be changed:</code>''</blockquote><blockquote><code>Automap Part Description</code></blockquote>
** grid Grid lines
** wall One sided walls
** step Floor height change, climable
** ledge Floor drop-off, too high to climb
** ceil Ceiling height difference
** secret Secret doors
** allmap Unseen walls when you have the All-Map
** player Player object
** monster Monsters
** corpse Dead monsters
** item Pickup items
** missile Missiles, fireballs, etc
** scenery Scenery items

== * Audio Functions ==

==== '''<code>hud.play_sound(name)</code>''' ====
<blockquote>''<code>Plays the given sound, which must be an entry in SOUNDS.DDF.</code>''</blockquote>

== PLAYER MODULE ==

=== General Queries ===

==== '''<code>player.is_bot()</code>''' ====
<blockquote>''<code>Returns true if the current player is a bot.</code>''</blockquote>

==== '''<code>player.get_name()</code>''' ====
<blockquote><code>''Returns the name of the current player.''</code></blockquote>

==== '''<code>player.get_angle()</code>''' ====
<blockquote><code>''Returns the angle of the current player.''</code></blockquote>

==== '''<code>player.get_pos()</code>''' ====
<blockquote><code>''Returns the position of the current player.''</code></blockquote>

==== '''<code>player.get_mlook()</code>''' ====
<blockquote><code>''Returns the mlook (mouse-look) angle of the current player.''</code></blockquote>

==== '''<code>player.health()</code>''' ====
<blockquote>''<code>Returns the health of the current player. The result will normally be in the range 0 to 100, regardless of the SPAWNHEALTH setting for the player in DDF (in other words, the result is a percentage value of the spawn health). Values higher than 100 are possible when the player has bonus health (e.g. from the Soul Sphere pickup).</code>''</blockquote>

==== '''<code>player.armor(type)</code>''' ====
<blockquote>''<code>For the given armor type, returns the amount the player is currently wearing. The 'type' parameter is a number in the range 1-5, but the following names can be used for more readable code:</code>''</blockquote>
** <code>ARMORS.green</code>
** <code>ARMORS.blue</code>
** <code>ARMORS.purple</code>
** <code>ARMORS.yellow</code>
** <code>ARMORS.red</code>

==== '''<code>player.total_armor(type)</code>''' ====
<blockquote>''<code>Returns the total amount of armor the player has.</code>''</blockquote>

==== '''<code>player.frags()</code>''' ====
<blockquote>''<code>Number of frags the player has (for Deathmatch games).</code>''</blockquote>

==== '''<code>player.move_speed()</code>''' ====
<blockquote>''<code>Returns a number for how fast the player is currently moving, roughly the number of map units per tic (there are 35 tics per second).</code>''</blockquote>

==== '''<code>player.air_in_lungs()</code>''' ====
<blockquote>''<code>Returns amount of air in the player lungs, as a percentage value from 0 to 100. Only guaranteed to be valid while the player is underwater.</code>''</blockquote>

==== '''<code>player.has_key(key)</code>''' ====
<blockquote>''<code>Returns true if the player currently has the specified key, which is a number from 1 to 16. For more readable code, the following names can be used:</code>''</blockquote>
** <code>KEYS.blue_card KEYS.gold_key</code>
** <code>KEYS.red_card KEYS.brass_key</code>
** <code>KEYS.yellow_card KEYS.steel_key</code>
** <code>KEYS.green_card KEYS.fire_key</code>
** <code>KEYS.blue_skull KEYS.silver_key</code>
** <code>KEYS.red_skull KEYS.copper_key</code>
** <code>KEYS.yellow_skull KEYS.wooden_key</code>
** <code>KEYS.green_skull KEYS.water_key</code>

==== '''<code>player.has_power(power)</code>''' ====
<blockquote>''<code>Returns true if the player currently has the specified powerup. The 'power' parameter is a number from 1 to 16. For more readable code, the following names can be used:</code>''</blockquote>
** <code>POWERS.invuln</code>
** <code>POWERS.berserk</code>
** <code>POWERS.invis</code>
** <code>POWERS.acid_suit</code>
** <code>POWERS.automap</code>
** <code>POWERS.goggles</code>
** <code>POWERS.jet_pack</code>
** <code>POWERS.night_vis</code>
** <code>POWERS.scuba</code>

==== '''<code>player.power_left(power)</code>''' ====
<blockquote>''<code>Returns the number of seconds remaining for the specified powerup, or zero when the player does not have it. The berserk powerup only counts down the red-screen effect, and returns -1 when that is finished. The automap powerup returns a large value when active and it never counts down. The result for invulnerability is not affected by the God-mode cheat.</code>''</blockquote>

== * Weapon Stuff ==

==== '''<code>player.has_weapon(name)</code>''' ====
<blockquote><code>''Returns true if the player currently owns the weapon, where 'name' is the DDF name of the weapon.''</code></blockquote>

==== '''<code>player.has_weapon_slot(slot)</code>''' ====
<blockquote>''<code>Returns true if the player currently owns any weapon which uses the given 'slot', which is a number for 0 to 9 (same as the BINDKEY command in the DDF).</code>''</blockquote>

==== '''<code>player.cur_weapon()</code>''' ====
<blockquote>''<code>Returns the DDF name of the weapon the player is currently holding, or the special value "none" when the player is holding no weapon at all, or "change" while the weapon is switching to a new one.</code>''</blockquote>

==== '''<code>player.cur_weapon_slot()</code>''' ====
<blockquote>''<code>Returns the slot number (i.e. BINDKEY) of the weapon the player is currently holding, or -1 when the player is holding no weapon at all.</code>''</blockquote>

==== '''<code>player.ammo(type)</code>''' ====
<blockquote>''<code>Returns the amount of ammo the player is carrying (not including any ammo inside the clips of weapons). The 'type' parameter is a number in the range 1-16. For more readable code, one of the following names can be used instead:</code>''</blockquote>
** <code>AMMOS.bullets AMMOS.pellets</code>
** <code>AMMOS.shells AMMOS.nails</code>
** <code>AMMOS.rockets AMMOS.grenades</code>
** <code>AMMOS.cells AMMOS.gas</code>

==== <code>'''player.ammomax(type)'''</code> ====
<blockquote>''<code>Returns the maximum amount of ammo the player can carry (not including weapon clips). The 'type' parameter is the same as the '''player.ammo()''' function.</code>''</blockquote>

==== '''<code>player.main_ammo()</code>''' ====
<blockquote><code>''Returns the main ammo quantity for the player's current weapon. This is zero for weapons that don't use any ammo (like the FIST). If the weapon has a clip and the SHOWCLIP command (in DDF) is true, then the amount of ammo inside the clip is returned instead. Note that only the primary attack is checked, the secondary attack (if present) will be ignored.''</code></blockquote>

==== '''<code>player.ammo_type(ATK)</code>''' ====
<blockquote>''<code>Returns the ammo type of the player's current weapon for the given attack (primary or secondary). The result is in the range 1-16, or can be 0 for the special case of NOAMMO. The 'ATK' parameter is 1 for the primary attack, 2 for the secondary attack, and is compulsory.</code>''</blockquote>

==== '''<code>player.ammo_pershot(ATK)</code>''' ====
<blockquote><code>''Returns the ammo used up per shot by the current weapon for the given attack (primary or secondary). Same as the AMMOPERSHOT commands in WEAPONS.DDF. The 'ATK' parameter is 1 for the primary attack, 2 for the secondary attack, and is compulsory.''</code></blockquote>

==== '''<code>player.clip_ammo(ATK)</code>''' ====
<blockquote>''<code>Returns the current amount of ammo the clip in the player's current weapon is holding, or zero if the weapon has no clip. The 'ATK' parameter is 1 for the primary attack, 2 for the secondary attack, and is compulsory.</code>''</blockquote>

==== '''<code>player.clip_size(ATK)</code>''' ====
<blockquote>''<code>Returns the maximum amount of ammo the clip in the player's current weapon can hold, or zero if the weapon has no clip. The 'ATK' parameter is 1 for the primary attack, 2 for the secondary attack, and is compulsory.</code>''</blockquote>

==== '''<code>player.clip_is_shared()</code>''' ====
<blockquote>''<code>Returns true if the player's current weapon is sharing a single clip between primary and secondary attackes (the SHARED_CLIP command).</code>''</blockquote>

== * Conditions ==

==== '''<code>player.on_ground()</code>''' ====
<blockquote>''<code>Returns true if player is standing on solid ground.</code>''</blockquote>

==== '''<code>player.under_water()</code>''' ====
<blockquote>''<code>Returns true if player is in AIRLESS water and doesn't have the Scuba powerup.</code>''</blockquote>

==== '''<code>player.is_swimming()</code>''' ====
<blockquote>''<code>Returns true if player is in swimmable water (i.e. the SWIM sector special).</code>''</blockquote>

==== '''<code>player.is_jumping()</code>''' ====
<blockquote>''<code>Returns true if player is jumping.</code>''</blockquote>

==== '''<code>player.is_crouching()</code>''' ====
<blockquote>''<code>Returns true if player is crouching.</code>''</blockquote>

==== '''<code>player.get_side_move()</code>''' ====
<blockquote>''<code>Returns true if player is strafing from side-to-side.</code>''</blockquote>

==== '''<code>player.is_attacking()</code>''' ====
<blockquote>''<code>Returns true if player is firing his weapon (either first or second attack).</code>''</blockquote>

==== '''<code>player.is_rampaging()</code>''' ====
<blockquote>''<code>Returns true if player has been firing his weapon for two seconds or more.</code>''</blockquote>

==== '''<code>player.is_using()</code>''' ====
<blockquote>''<code>Returns true if player is holding the USE button down.</code>''</blockquote>

==== '''<code>player.is_grinning()</code>''' ====
<blockquote>''<code>Returns true if player is grinning (after picking up a weapon).</code>''</blockquote>

== * Miscellaneous ==

==== '''<code>player.num_players()</code>''' ====
<blockquote>''<code>Returns the total number of players in the game, including bots.</code>''</blockquote>

==== '''<code>player.set_who(index)</code>''' ====
<blockquote><code>''Sets who the current player is. The 'index' parameter is a small number: 1 for the "main player" on this computer (the person at the keyboard), 2 for the next player in the list, for instance the split-screen player) etc... up to the number of players in the game. All the player query functions described here return their results for the current player.''</code></blockquote>

==== '''<code>player.hurt_by()</code>''' ====
<blockquote>''<code>If the player has been hurt in the last few seconds, this returns a string describing what did the damage. Otherwise this function returns nil. The result is usually "enemy", but could be "friend" for friendly fire. If the player hurt himself with his own damn stupidity then the result is "self", whereas damaging floors and crushers will return "other".</code>''</blockquote>

==== '''<code>player.hurt_mon()</code>''' ====
<blockquote>''<code>If the player has been hurt in the last few seconds, this returns the name of the monster or other player. Otherwise this function returns nil.</code>''</blockquote>

==== '''<code>player.hurt_pain()</code>''' ====
<blockquote>''<code>If the player was just hurt, this returns the damage amount, otherwise this function returns 0.</code>''</blockquote>

==== '''<code>player.hurt_dir()</code>''' ====
<blockquote>''<code>If the player was just hurt, this returns a direction relative to the player where the attacker was: -1 for the left side, +1 for the right side, and 0 for all other cases.</code>''</blockquote>

==== '''<code>player.hurt_angle()</code>''' ====
<blockquote>''<code>Like player.hurt_dir(), except this returns the map angle from the player to his attacker. The result is in degrees (ranging from 0 to 359), where East is 0 and North is 90.</code>''</blockquote>

==== <code>'''player.add_tactile(id, freq, amp)'''</code> ====
<blockquote><code>This function can be called to add a screen-shaking effect to the player's view. The three integers above are explained below. This can be used in conjunction with others like player.hurt_dir(), or RTS commands that call COAL directly.</code> </blockquote>
* '''The following integers for player.add_tactile are as described:'''
** <code>'''id''': the player whom is receiving the shake (integer)</code>
** <code>'''freq''': the frequency at which the screen shakes at (integer)</code>
** <code>'''amp''': the intensity at which the screen shakes (integer)</code>

== * CAMERA MODULE ==

==== '''<code>cam.set_vert_bob(f)</code>''' ====
<blockquote>''<code>Sets the Player bobbing. The parameter flags above are as follows:</code>''</blockquote>
* <blockquote>Parameter is a ''Float'' for controlling the vertical bobbing. This was previously encapsulated in DDF where it is now controlled via COAL.</blockquote>
* <blockquote>The default value is 1.2 - setting it to 0.0 will completely disable bobbing.</blockquote>

==== '''<code>cam.set_roll_bob(f)</code>''' ====
<blockquote>Parameter is a ''Float'' for customizing camera rolling. Note that this can be combined with set_vert_bob, OR can be called from other functions (such as being combined with player.get_side_move() or combined with player.hurt_pain()).</blockquote><blockquote>By Default the camera set_roll_bob amount is 0.0.</blockquote>

== CAMERA-MAN MODULE ==
The new Camera-Man system is in reality a COAL module, and can be completely configured through COAL. However, due to its complexity and the fact that the format is not in the QC extension (which is actually done with Console Commands), it has its own article and how-to's. [[CAMERA-MAN|You can visit that guide by clicking on this sentence.]]

COAL

2018-09-30T20:28:39Z

Corbin:

'''COAL''' is a [https://en.wikipedia.org/wiki/QuakeC QuakeC-derived language] used for controlling the heads-up display and player interactions in [[EDGE]]. It replaces plain [[LUA]] from earlier versions of ''EDGE''. COAL is based heavily on QuakeC itself.

<code>'''See the brand-new [[COAL Manual|COAL HUD MANUAL]] for specific descriptions of all available functions.'''</code>

==Loading==
In EDGE there are two files with hard-coded names (<code>./doom_ddf/coal_api.ec</code> and <code>./doom_ddf/coal_hud.ec</code>) which get loaded. As you can see, these scripts use the "'''EC'''" extension (<code>as opposed to the "QC" extension from QuakeC</code>). <blockquote>Coal scripts can also get loaded from wads, each wad given with <code>-file</code> can contain a lump called [[COALHUDS]] which will be loaded, and functions (such as [[COAL Manual|draw_al]]<nowiki/>l) can be replaced.</blockquote>Messages about loading and compiling errors get printed on the console and both EDGE.LOG and DEBUG.TXT.

==Type System==
Coal is ''statically typed'', which means variables and function parameters can only use a single type. For example if the variable takes strings, you cannot assign a number to it. 

The available types are:

*<blockquote>'''float''' : used for numbers (''floating point''), e.g. <code>123</code> or <code>-7.654</code></blockquote>
*<blockquote>'''string''' : used for strings, which are specified with double quotes, e.g. "foobar"</blockquote>
*<blockquote>'''vector''' : used for a 3D coordinate in the world. Vector constants are three numbers surrounded by a single quote, such as '0 -1 2'</blockquote>

==Operators==

* ! boolean not, e.g. !0 == 1

* ^ raise to the power, e.g. 2^3 == 8
* & integer bit-and, e.g. 3 & 6 == 4
* | integer bit-or, e.g. 3 | 6 == 7

* * multiplication
* / division
* % modulo
* + addition
* - subtraction

* == equals
* != not equals
* < less than
* > greater than
* <= less than or equals
* >= greater than or equals

* && boolean and
* || boolean or

'''Precedence table (highest to lowest):'''
* ^ * / % & |
* + -
* == != < > <= >=
* && ||

The * operator can be used on two vectors, and the result is the dot product (i.e. A * B calculates A.x * B.x + A.y * B.y + A.z * B.z).

The + operator can concatenate two strings, or a string and a float or vector (but the string must be on the left side). Hence a useful idiom is doing "" + x to convert a number to a string.

There is no unary - operator, to negate a value you need to do this: 0 - x

The && and || boolean operators are short-circuit, which means that the right side is not evaluated if the result is known from the left side only. For example: (1 && somefunc()) will never call that function.

==Declaration Kinds==

The following things can be declared globally: variables, constants, functions, and modules.

All of those (except for modules) can also be declared inside modules.

Within functions only variables can be declared (not constants, functions etc).

Global variables, constants and functions can be redeclared by later code (especially by a newer file), so long as the types are the same. Redefining a constant means that previous code using that constant will use the new value (in COAL constants are really just read-only variables).

Modules do not get redeclared, instead if the module already exists then the new contents are simply added to the existing module, and previous stuff can be redefined too.

==Syntax for Variables and Constants==
Variables are declared like this. When the type is not specified, float is assumed.

var name
var name : type

You can also give the initial value (otherwise the value defaults to 0 for numbers, "" for strings).

var foo = 123
var bar : string = "qwerty"

Constants always have a value and never use a typename (after ':') because the type is known from the value.

constant TIMEOUT = 300

==Syntax for Modules==

==== <code>module name { .....declarations here..... }</code> ====
==Syntax for functions==

Ordinary functions use the following syntax. The return type (and the ':') is optional, when omitted then the function does not return any value, like void functions in C. 

function name(arguments....) : type =
{
.....code here.....
}

Native functions are implemented by the host environment (EDGE) , and hence you cannot add your own. For completeness their syntax looks like this:

function name(arguments....) : type = native

COAL

2018-09-30T20:25:14Z

Corbin:

'''COAL''' is a [https://en.wikipedia.org/wiki/QuakeC QuakeC-derived language] used for controlling the heads-up display and player interactions in [[EDGE]]. It replaces plain [[LUA]] from earlier versions of ''EDGE''. COAL is based heavily on QuakeC itself.

<code>'''See the brand-new [[COAL Manual|COAL HUD MANUAL]] for specific descriptions of all available functions.'''</code>

==Loading==
In EDGE there are two files with hard-coded names (<code>./doom_ddf/coal_api.ec</code> and <code>./doom_ddf/coal_hud.ec</code>) which get loaded. As you can see, these scripts use the "'''EC'''" extension (<code>as opposed to the "QC" extension from QuakeC</code>).

Coal scripts can also get loaded from wads, each wad given with -file can contain a lump called [[COALHUDS]] which will be loaded, and functions (such as [[COAL Manual|draw_al]]<nowiki/>l) can be replaced.

Messages about loading and compiling errors get printed on the console and both EDGE.LOG and DEBUG.TXT.

==Type System==
Coal is ''statically typed'', which means variables and function parameters can only use a single type. For example if the variable takes strings, you cannot assign a number to it. 

The available types are:

*<blockquote>'''float''' : used for numbers (''floating point''), e.g. <code>123</code> or <code>-7.654</code></blockquote>
*<blockquote>'''string''' : used for strings, which are specified with double quotes, e.g. "foobar"</blockquote>
*<blockquote>'''vector''' : used for a 3D coordinate in the world. Vector constants are three numbers surrounded by a single quote, such as '0 -1 2'</blockquote>

==Operators==

* ! boolean not, e.g. !0 == 1

* ^ raise to the power, e.g. 2^3 == 8
* & integer bit-and, e.g. 3 & 6 == 4
* | integer bit-or, e.g. 3 | 6 == 7

* * multiplication
* / division
* % modulo
* + addition
* - subtraction

* == equals
* != not equals
* < less than
* > greater than
* <= less than or equals
* >= greater than or equals

* && boolean and
* || boolean or

'''Precedence table (highest to lowest):'''
* ^ * / % & |
* + -
* == != < > <= >=
* && ||

The * operator can be used on two vectors, and the result is the dot product (i.e. A * B calculates A.x * B.x + A.y * B.y + A.z * B.z).

The + operator can concatenate two strings, or a string and a float or vector (but the string must be on the left side). Hence a useful idiom is doing "" + x to convert a number to a string.

There is no unary - operator, to negate a value you need to do this: 0 - x

The && and || boolean operators are short-circuit, which means that the right side is not evaluated if the result is known from the left side only. For example: (1 && somefunc()) will never call that function.

==Declaration Kinds==

The following things can be declared globally: variables, constants, functions, and modules.

All of those (except for modules) can also be declared inside modules.

Within functions only variables can be declared (not constants, functions etc).

Global variables, constants and functions can be redeclared by later code (especially by a newer file), so long as the types are the same. Redefining a constant means that previous code using that constant will use the new value (in COAL constants are really just read-only variables).

Modules do not get redeclared, instead if the module already exists then the new contents are simply added to the existing module, and previous stuff can be redefined too.

==Syntax for Variables and Constants==
Variables are declared like this. When the type is not specified, float is assumed.

var name
var name : type

You can also give the initial value (otherwise the value defaults to 0 for numbers, "" for strings).

var foo = 123
var bar : string = "qwerty"

Constants always have a value and never use a typename (after ':') because the type is known from the value.

constant TIMEOUT = 300

==Syntax for Modules==

==== <code>module name { .....declarations here..... }</code> ====
==Syntax for functions==

Ordinary functions use the following syntax. The return type (and the ':') is optional, when omitted then the function does not return any value, like void functions in C. 

function name(arguments....) : type =
{
.....code here.....
}

Native functions are implemented by the host environment (EDGE) , and hence you cannot add your own. For completeness their syntax looks like this:

function name(arguments....) : type = native

TADE

2018-09-30T19:36:55Z

Corbin:

'''TADE''', or "Text-Accessible Doom Engine" was to be the original planned name for [[EDGE]], while [[DOSDoom]] was in the last stages of its development. The following is a communication between the developers internally from [[Andrew Apted]]:<blockquote>I joined the EDGE project near the start, I can remember the
discussions about what to call the project. One suggestion was
"TADE", I don't recall what the "A" meant but the whole thing was

something like "Text Accessible Doom Engine".</blockquote><blockquote>I think version 1.00 was where it all started, and there was 1.01,
1.02 etc.... which were all developed privately until the first public
release. Marc Pullen was part of the team, and features for his QDoom

project drove a lot of that early development.</blockquote><blockquote>Cheers,
-- Andrew</blockquote><ref>Referenced in an email dated 10/26/2014.</ref> ''Date of communication was 10/24/2014.''

[[Category:Trivia]]
<references />

TADE

2018-09-30T19:33:45Z

Corbin:

'''TADE''', or "Text-Accessible Doom Engine" was to be the original planned name for [[EDGE]]. The following is a communication between the developers internally from [[Andrew Apted]]:<blockquote>I joined the EDGE project near the start, I can remember the
discussions about what to call the project. One suggestion was
"TADE", I don't recall what the "A" meant but the whole thing was
something like "Text Accessible Doom Engine".</blockquote><blockquote>I think version 1.00 was where it all started, and there was 1.01,
1.02 etc.... which were all developed privately until the first public
release. Marc Pullen was part of the team, and features for his QDoom
project drove a lot of that early development.</blockquote><blockquote>Cheers,
-- Andrew</blockquote><ref>Referenced in an email dated 10/26/2014.</ref> ''Date of communication was 10/24/2014.''

[[Category:Trivia]]

TADE

2018-09-30T19:32:53Z

Corbin:

TADE

2018-09-30T19:29:31Z

Corbin: created TADE for reference primarily on DoomWiki, but added new category "DeveloperTrivia" for references.

'''TADE''', or "Text-Accessible Doom Engine" was to be the original planned name for [[EDGE]]. The following is a communication between the developers internally, which was in 2014:

I joined the EDGE project near the start, I can remember the
discussions about what to call the project. One suggestion was
"TADE", I don't recall what the "A" meant but the whole thing was
something like "Text Accessible Doom Engine".

I think version 1.00 was where it all started, and there was 1.01,
1.02 etc.... which were all developed privately until the first public
release. Marc Pullen was part of the team, and features for his QDoom
project drove a lot of that early development.

Cheers,
-- Andrew

[[Category:DeveloperTrivia]]

IWAD

2018-09-30T19:11:26Z

Corbin:

{{DoomWiki}}An '''IWAD''' - short for ''Internal WAD'' - is the main resource file for a [[Doom]]-engine game, containing all the game's original sounds, levels, and graphics. [[EDGE]] needs an IWAD file in order to play; without one the EDGE engine has no game data to use.

==Supported IWADs==
'''Notes:'''
* Some file names are links to a page on the {{DoomWiki|nolink=|Entryway|Doom Wiki}} where you will find checksums for known versions of the concerned file.
* Some files have conflicting names; EDGE provides you with possible aliases. Note that an IWAD is actually identified by its content rather than its name. Also, any [[archive format]] supported by EDGE can technically be an IWAD.

===Commercial games===

{| {{prettytable}}
!Game!!Name!!File name!!File aliases!!Notes and download links
|-
|rowspan="3" valign="top"|[[File:MiniDoomLogoIcon.png|link=]]
| Doom (Registered) || {{c|{{dwicon|nolink=|DOOM.WAD|doom.wad}}}} || ||rowspan="2"| {{goglink|game/the_ultimate_doom|Buy on GOG.com}} — {{steamlink|app/2280/|Buy on Steam}}
|-
| The Ultimate Doom || {{c|{{dwicon|nolink=|DOOM.WAD|doom.wad}}}} || {{c|doomu.wad}}
|-
| Doom "BFG Edition" || {{c|{{dwicon|nolink=|DOOM.WAD|doom.wad}}}} || {{c|bfgdoom.wad}}, {{c|doombfg.wad}} || {{goglink|game/doom_3_bfg_edition|Buy on GOG.com}} — {{steamlink|app/208200/|Buy on Steam}} — Part of {{dw|Doom 3: BFG Edition}}
|-
|rowspan="5" valign="top"|[[File:MiniDoom2LogoIcon.png|link=]]
| [[Doom II]] || {{c|{{dwicon|nolink=|DOOM2.WAD|doom2.wad}}}} || || {{goglink|game/doom_ii_final_doom|Buy on GOG.com}} — {{steamlink|app/2300/|Buy on Steam}}
|-
| Doom II "BFG Edition" || {{c|{{dwicon|nolink=|DOOM2.WAD|doom2.wad}}}} || {{c|bfgdoom2.wad}}, {{c|doom2bfg.wad}} || {{goglink|game/doom_3_bfg_edition|Buy on GOG.com}} — {{steamlink|app/208200/|Buy on Steam}} — Part of {{dw|Doom 3: BFG Edition}}; also loads {{c|{{dwicon|nolink=|NERVE.WAD|nerve.wad}}}}
|-
| [[Final Doom]] — TNT: Evilution || {{c|{{dwicon|nolink=|TNT.WAD|tnt.wad}}}} || ||rowspan="2"| {{goglink|game/doom_ii_final_doom|Buy on GOG.com}} — {{steamlink|app/2290/|Buy on Steam}}
|-
| Final Doom — The Plutonia Experiment || {{c|{{dwicon|nolink=|PLUTONIA.WAD|plutonia.wad}}}} ||
|-
| French Doom II || {{c|doom2f.wad}} || || No longer sold; {{idgames|id=16030||a patch is available}} for the original English version.
|-
| [[File:MiniHereticLogoIcon.png|link=]] || Heretic (Registered or Commercial) || {{c|{{dwicon|nolink=|HERETIC.WAD|heretic.wad}}}} || {{c|hereticsr.wad}} || {{steamlink|app/2390/|buy on Steam}}
|-
| [[File:MiniChexLogoIcon.png|link=]] || [[Chex Quest]] || {{c|{{dwicon|nolink=|CHEX.WAD|chex.wad}}}} || || No longer sold, originally distributed in cereal boxes.
|-
| [[File:ROTTLogoIcon.png|link=]] || [[Rise of the Triad]] || {{c|{{dwicon|nolink=|DARKWAR.WAD|darkwar.wad}}}} || || EDGE is the only DOOM engine that can read and support Rise of the Triad: Dark War.
|}

===Free-to-play games===

{| {{prettytable}}
!Game!!Name!!File name!!File aliases!!Notes and download links
|-

| [[File:MiniDoomLogoIcon.png|link=]] || [[Doom]] (Shareware) || {{c|{{dwicon|nolink=|DOOM1.WAD|doom1.wad}}}} || || {{idgames|id=7043|Doom shareware}}
|-
| [[File:MiniHereticLogoIcon.png|link=]] || [[Heretic]] (Shareware) || {{c|{{dwicon|nolink=|HERETIC1.WAD|heretic1.wad}}}} || || {{idgames|id=7044|Heretic shareware}}
|-
|rowspan="3" valign="top"|[[File:MiniFreedoomLogo.png|link=]]
| [[Freedoom]]: Phase 1 || {{c|freedoom1.wad}} || {{c|freedoomu.wad}} || [https://freedoom.github.io/download.html Official site]
|-
| [[Freedoom]]: Phase 2 || {{c|freedoom2.wad}} || {{c|freedoom.wad}} || [https://freedoom.github.io/download.html Official site]
|-
| FreeDM || {{c|freedm.wad}} || || [https://freedoom.github.io/download.html Official site]
|-
| [[File:MiniChex3LogoIcon.png|link=]] || [[Chex Quest 3]] || {{c|{{dwicon|nolink=|CHEX3.WAD|chex3.wad}}}} || || [http://www.chucktropolis.com/gamers.htm Official site]
|-
|rowspan="2" valign="top"| [[File:MiniHacxLogoIcon.png|link=]] || [[Hacx]] v1.2 || {{c|{{dwicon|nolink=|HACX.WAD|hacx.wad}}}} || || [http://drnostromo.com/hacx/page.php?content=download Official site]
|-
|Hacx v2.0 || {{c|hacx.wad}} || {{c|hacx2.wad}} || {{DRDForum|t=5771|WIP download thread}}
|}

In addition to them, some "total conversion"-type mods can be played as their own IWAD; however since they are not detected as such by EDGE, you need to use the -iwad [[command line parameter]].

In order to play a custom level designed for any of the above games you have to have that particular game's full IWAD (loading PWAD with shareware, demo or teaser versions is disabled). If you do not have the necessary IWAD, or if you have an old, [[IWAD Patching|unpatched]] version of the IWAD in question, you might experience undefined behavior. (But often old versions are accepted too.)

The IWAD file(s) should be placed in a directory where EDGE will find them. This includes the same directory as the EDGE executable, as well as those pointed to by the {{c|DOOMWADDIR}} environment variable. On Linux, the directories {{c|$HOME/.EDGE}} and {{c|/usr/local/share}} are checked by default.

==Obtaining IWADs==
As noted above, some IWADs can be downloaded freely; however most "full" games are not and must be bought from one of the following sources:
;[http://www.gog.com/games#/#sort=bestselling&devpub=id_software&page=1 GOG.com]
:This store offers downloadable versions of ''Ultimate Doom'', ''Doom II: Hell on Earth'' (bundled with ''Final Doom'' and the ''Master Levels for Doom II''), and ''Strife''. The Final Doom version offered is the later Anthology version, which fixes many mapping errors (such as the infamous [[doomwiki:MAP31: Pharaoh (TNT: Evilution)#Bugs|missing key in TNT MAP31]]).
;[http://store.steampowered.com/search/?sort_by=Name&sort_order=ASC&publisher=id+Software&category2=2&price=0%2C10&genre=Action Steam]
:This store offers downloadable versions of ''Ultimate Doom'', ''Doom II: Hell on Earth'', ''Final Doom'', ''Heretic: Shadow of the Serpent Riders'', ''Hexen: Beyond Heretic'', ''Hexen: Deathkings of the Dark Citadel'', and ''Strife''; as well as the ''Master Levels for Doom II'' which is a set of PWAD, not an IWAD.
:Warning: following the release of ''{{dw|Doom 3: BFG Edition}}'', the ''Master Levels'' are no longer available to purchase individually but can be bought as part of the Doom Classic Complete Pack.
:'''Note:''' The version of ''Hexen: Death Kings'' available on Steam is not patched. You need to download and apply the [http://www.doomworld.com/idgames/index.php?id=7022 Death Kings 1.1 patch] first. (The "readme.txt" file it tries to patch has been renamed readme-dk.txt by Steam, but is not important.) All other IWADs from Steam are fully patched.
;[http://www.amazon.com/ Amazon.com], [http://www.ebay.com/ eBay.com], etc.
:Second-hand copies of the original games can be found on such sites.
;Flea markets, used-games bins in brick-and-mortar stores, etc.
:It's mostly a matter of luck, but they can still sometimes be found this way.

==Custom IWADs==
EDGE is currently working on the ability to define any WAD/distro/archive as an IWAD or [[IPK]] (IwadPacKage) - currently this is only available by using the -iwad switch.

==See also==
*[[WAD]]
*[[PWAD]]
[[Category:Glossary]][[Category:Supported games|*]]

IWAD

2018-09-30T19:09:34Z

Corbin:

{{dw}}An '''IWAD''' - short for ''Internal WAD'' - is the main resource file for a [[Doom]]-engine game, containing all the game's original sounds, levels, and graphics. [[EDGE]] needs an IWAD file in order to play; without one the EDGE engine has no game data to use.

==Supported IWADs==
'''Notes:'''
* Some file names are links to a page on the {{dw|nolink=|Entryway|Doom Wiki}} where you will find checksums for known versions of the concerned file.
* Some files have conflicting names; EDGE provides you with possible aliases. Note that an IWAD is actually identified by its content rather than its name. Also, any [[archive format]] supported by EDGE can technically be an IWAD.

===Commercial games===

{| {{prettytable}}
!Game!!Name!!File name!!File aliases!!Notes and download links
|-
|rowspan="3" valign="top"|[[File:MiniDoomLogoIcon.png|link=]]
| Doom (Registered) || {{c|{{dwicon|nolink=|DOOM.WAD|doom.wad}}}} || ||rowspan="2"| {{goglink|game/the_ultimate_doom|Buy on GOG.com}} — {{steamlink|app/2280/|Buy on Steam}}
|-
| The Ultimate Doom || {{c|{{dwicon|nolink=|DOOM.WAD|doom.wad}}}} || {{c|doomu.wad}}
|-
| Doom "BFG Edition" || {{c|{{dwicon|nolink=|DOOM.WAD|doom.wad}}}} || {{c|bfgdoom.wad}}, {{c|doombfg.wad}} || {{goglink|game/doom_3_bfg_edition|Buy on GOG.com}} — {{steamlink|app/208200/|Buy on Steam}} — Part of {{dw|Doom 3: BFG Edition}}
|-
|rowspan="5" valign="top"|[[File:MiniDoom2LogoIcon.png|link=]]
| [[Doom II]] || {{c|{{dwicon|nolink=|DOOM2.WAD|doom2.wad}}}} || || {{goglink|game/doom_ii_final_doom|Buy on GOG.com}} — {{steamlink|app/2300/|Buy on Steam}}
|-
| Doom II "BFG Edition" || {{c|{{dwicon|nolink=|DOOM2.WAD|doom2.wad}}}} || {{c|bfgdoom2.wad}}, {{c|doom2bfg.wad}} || {{goglink|game/doom_3_bfg_edition|Buy on GOG.com}} — {{steamlink|app/208200/|Buy on Steam}} — Part of {{dw|Doom 3: BFG Edition}}; also loads {{c|{{dwicon|nolink=|NERVE.WAD|nerve.wad}}}}
|-
| [[Final Doom]] — TNT: Evilution || {{c|{{dwicon|nolink=|TNT.WAD|tnt.wad}}}} || ||rowspan="2"| {{goglink|game/doom_ii_final_doom|Buy on GOG.com}} — {{steamlink|app/2290/|Buy on Steam}}
|-
| Final Doom — The Plutonia Experiment || {{c|{{dwicon|nolink=|PLUTONIA.WAD|plutonia.wad}}}} ||
|-
| French Doom II || {{c|doom2f.wad}} || || No longer sold; {{idgames|id=16030||a patch is available}} for the original English version.
|-
| [[File:MiniHereticLogoIcon.png|link=]] || Heretic (Registered or Commercial) || {{c|{{dwicon|nolink=|HERETIC.WAD|heretic.wad}}}} || {{c|hereticsr.wad}} || {{steamlink|app/2390/|buy on Steam}}
|-
| [[File:MiniChexLogoIcon.png|link=]] || [[Chex Quest]] || {{c|{{dwicon|nolink=|CHEX.WAD|chex.wad}}}} || || No longer sold, originally distributed in cereal boxes.
|-
| [[File:ROTTLogoIcon.png|link=]] || [[Rise of the Triad]] || {{c|{{dwicon|nolink=|DARKWAR.WAD|darkwar.wad}}}} || || EDGE is the only DOOM engine that can read and support Rise of the Triad: Dark War.
|}

===Free-to-play games===

{| {{prettytable}}
!Game!!Name!!File name!!File aliases!!Notes and download links
|-

| [[File:MiniDoomLogoIcon.png|link=]] || [[Doom]] (Shareware) || {{c|{{dwicon|nolink=|DOOM1.WAD|doom1.wad}}}} || || {{idgames|id=7043|Doom shareware}}
|-
| [[File:MiniHereticLogoIcon.png|link=]] || [[Heretic]] (Shareware) || {{c|{{dwicon|nolink=|HERETIC1.WAD|heretic1.wad}}}} || || {{idgames|id=7044|Heretic shareware}}
|-
|rowspan="3" valign="top"|[[File:MiniFreedoomLogo.png|link=]]
| [[Freedoom]]: Phase 1 || {{c|freedoom1.wad}} || {{c|freedoomu.wad}} || [https://freedoom.github.io/download.html Official site]
|-
| [[Freedoom]]: Phase 2 || {{c|freedoom2.wad}} || {{c|freedoom.wad}} || [https://freedoom.github.io/download.html Official site]
|-
| FreeDM || {{c|freedm.wad}} || || [https://freedoom.github.io/download.html Official site]
|-
| [[File:MiniChex3LogoIcon.png|link=]] || [[Chex Quest 3]] || {{c|{{dwicon|nolink=|CHEX3.WAD|chex3.wad}}}} || || [http://www.chucktropolis.com/gamers.htm Official site]
|-
|rowspan="2" valign="top"| [[File:MiniHacxLogoIcon.png|link=]] || [[Hacx]] v1.2 || {{c|{{dwicon|nolink=|HACX.WAD|hacx.wad}}}} || || [http://drnostromo.com/hacx/page.php?content=download Official site]
|-
|Hacx v2.0 || {{c|hacx.wad}} || {{c|hacx2.wad}} || {{DRDForum|t=5771|WIP download thread}}
|}

In addition to them, some "total conversion"-type mods can be played as their own IWAD; however since they are not detected as such by EDGE, you need to use the -iwad [[command line parameter]].

In order to play a custom level designed for any of the above games you have to have that particular game's full IWAD (loading PWAD with shareware, demo or teaser versions is disabled). If you do not have the necessary IWAD, or if you have an old, [[IWAD Patching|unpatched]] version of the IWAD in question, you might experience undefined behavior. (But often old versions are accepted too.)

The IWAD file(s) should be placed in a directory where EDGE will find them. This includes the same directory as the EDGE executable, as well as those pointed to by the {{c|DOOMWADDIR}} environment variable. On Linux, the directories {{c|$HOME/.EDGE}} and {{c|/usr/local/share}} are checked by default.

==Obtaining IWADs==
As noted above, some IWADs can be downloaded freely; however most "full" games are not and must be bought from one of the following sources:
;[http://www.gog.com/games#/#sort=bestselling&devpub=id_software&page=1 GOG.com]
:This store offers downloadable versions of ''Ultimate Doom'', ''Doom II: Hell on Earth'' (bundled with ''Final Doom'' and the ''Master Levels for Doom II''), and ''Strife''. The Final Doom version offered is the later Anthology version, which fixes many mapping errors (such as the infamous [[doomwiki:MAP31: Pharaoh (TNT: Evilution)#Bugs|missing key in TNT MAP31]]).
;[http://store.steampowered.com/search/?sort_by=Name&sort_order=ASC&publisher=id+Software&category2=2&price=0%2C10&genre=Action Steam]
:This store offers downloadable versions of ''Ultimate Doom'', ''Doom II: Hell on Earth'', ''Final Doom'', ''Heretic: Shadow of the Serpent Riders'', ''Hexen: Beyond Heretic'', ''Hexen: Deathkings of the Dark Citadel'', and ''Strife''; as well as the ''Master Levels for Doom II'' which is a set of PWAD, not an IWAD.
:Warning: following the release of ''{{dw|Doom 3: BFG Edition}}'', the ''Master Levels'' are no longer available to purchase individually but can be bought as part of the Doom Classic Complete Pack.
:'''Note:''' The version of ''Hexen: Death Kings'' available on Steam is not patched. You need to download and apply the [http://www.doomworld.com/idgames/index.php?id=7022 Death Kings 1.1 patch] first. (The "readme.txt" file it tries to patch has been renamed readme-dk.txt by Steam, but is not important.) All other IWADs from Steam are fully patched.
;[http://www.amazon.com/ Amazon.com], [http://www.ebay.com/ eBay.com], etc.
:Second-hand copies of the original games can be found on such sites.
;Flea markets, used-games bins in brick-and-mortar stores, etc.
:It's mostly a matter of luck, but they can still sometimes be found this way.

==Custom IWADs==
EDGE is currently working on the ability to define any WAD/distro/archive as an IWAD or [[IPK]] (IwadPacKage) - currently this is only available by using the -iwad switch.

==See also==
*[[WAD]]
*[[PWAD]]
[[Category:Glossary]][[Category:Supported games|*]]

File:ROTTLogoIcon.png

2018-09-30T18:54:57Z

Corbin:

IWAD

2018-09-30T18:51:50Z

Corbin: completely redone IWAD page, using ZDoom's as a template

{{doomwiki}}An '''IWAD''' - short for ''Internal WAD'' - is the main resource file for a [[Doom]]-engine game, containing all the game's original sounds, levels, and graphics. [[EDGE]] needs an IWAD file in order to play; without one the EDGE engine has no game data to use.

==Supported IWADs==
'''Notes:'''
* Some file names are links to a page on the {{dwicon|nolink=|Entryway|Doom Wiki}} where you will find checksums for known versions of the concerned file.
* Some files have conflicting names; EDGE provides you with possible aliases. Note that an IWAD is actually identified by its content rather than its name. Also, any [[archive format]] supported by EDGE can technically be an IWAD.

===Commercial games===

{| {{prettytable}}
!Game!!Name!!File name!!File aliases!!Notes and download links
|-
|rowspan="3" valign="top"|[[File:MiniDoomLogoIcon.png|link=]]
| Doom (Registered) || {{c|{{dwicon|nolink=|DOOM.WAD|doom.wad}}}} || ||rowspan="2"| {{goglink|game/the_ultimate_doom|Buy on GOG.com}} — {{steamlink|app/2280/|Buy on Steam}}
|-
| The Ultimate Doom || {{c|{{dwicon|nolink=|DOOM.WAD|doom.wad}}}} || {{c|doomu.wad}}
|-
| Doom "BFG Edition" || {{c|{{dwicon|nolink=|DOOM.WAD|doom.wad}}}} || {{c|bfgdoom.wad}}, {{c|doombfg.wad}} || {{goglink|game/doom_3_bfg_edition|Buy on GOG.com}} — {{steamlink|app/208200/|Buy on Steam}} — Part of {{dw|Doom 3: BFG Edition}}
|-
|rowspan="5" valign="top"|[[File:MiniDoom2LogoIcon.png|link=]]
| [[Doom II]] || {{c|{{dwicon|nolink=|DOOM2.WAD|doom2.wad}}}} || || {{goglink|game/doom_ii_final_doom|Buy on GOG.com}} — {{steamlink|app/2300/|Buy on Steam}}
|-
| Doom II "BFG Edition" || {{c|{{dwicon|nolink=|DOOM2.WAD|doom2.wad}}}} || {{c|bfgdoom2.wad}}, {{c|doom2bfg.wad}} || {{goglink|game/doom_3_bfg_edition|Buy on GOG.com}} — {{steamlink|app/208200/|Buy on Steam}} — Part of {{dw|Doom 3: BFG Edition}}; also loads {{c|{{dwicon|nolink=|NERVE.WAD|nerve.wad}}}}
|-
| [[Final Doom]] — TNT: Evilution || {{c|{{dwicon|nolink=|TNT.WAD|tnt.wad}}}} || ||rowspan="2"| {{goglink|game/doom_ii_final_doom|Buy on GOG.com}} — {{steamlink|app/2290/|Buy on Steam}}
|-
| Final Doom — The Plutonia Experiment || {{c|{{dwicon|nolink=|PLUTONIA.WAD|plutonia.wad}}}} ||
|-
| French Doom II || {{c|doom2f.wad}} || || No longer sold; {{idgames|id=16030||a patch is available}} for the original English version.
|-
| [[File:MiniHereticLogoIcon.png|link=]] || Heretic (Registered or Commercial) || {{c|{{dwicon|nolink=|HERETIC.WAD|heretic.wad}}}} || {{c|hereticsr.wad}} || {{steamlink|app/2390/|buy on Steam}}
|-
| [[File:MiniChexLogoIcon.png|link=]] || [[Chex Quest]] || {{c|{{dwicon|nolink=|CHEX.WAD|chex.wad}}}} || || No longer sold, originally distributed in cereal boxes.
|-
| [[File:ROTTLogoIcon.png|link=]] || [[Rise of the Triad]] || {{c|{{dwicon|nolink=|DARKWAR.WAD|darkwar.wad}}}} || || EDGE is the only DOOM engine that can read and support Rise of the Triad: Dark War.
|}

===Free-to-play games===

{| {{prettytable}}
!Game!!Name!!File name!!File aliases!!Notes and download links
|-

| [[File:MiniDoomLogoIcon.png|link=]] || [[Doom]] (Shareware) || {{c|{{dwicon|nolink=|DOOM1.WAD|doom1.wad}}}} || || {{idgames|id=7043|Doom shareware}}
|-
| [[File:MiniHereticLogoIcon.png|link=]] || [[Heretic]] (Shareware) || {{c|{{dwicon|nolink=|HERETIC1.WAD|heretic1.wad}}}} || || {{idgames|id=7044|Heretic shareware}}
|-
|rowspan="3" valign="top"|[[File:MiniFreedoomLogo.png|link=]]
| [[Freedoom]]: Phase 1 || {{c|freedoom1.wad}} || {{c|freedoomu.wad}} || [https://freedoom.github.io/download.html Official site]
|-
| [[Freedoom]]: Phase 2 || {{c|freedoom2.wad}} || {{c|freedoom.wad}} || [https://freedoom.github.io/download.html Official site]
|-
| FreeDM || {{c|freedm.wad}} || || [https://freedoom.github.io/download.html Official site]
|-
| [[File:MiniChex3LogoIcon.png|link=]] || [[Chex Quest 3]] || {{c|{{dwicon|nolink=|CHEX3.WAD|chex3.wad}}}} || || [http://www.chucktropolis.com/gamers.htm Official site]
|-
|rowspan="2" valign="top"| [[File:MiniHacxLogoIcon.png|link=]] || [[Hacx]] v1.2 || {{c|{{dwicon|nolink=|HACX.WAD|hacx.wad}}}} || || [http://drnostromo.com/hacx/page.php?content=download Official site]
|-
|Hacx v2.0 || {{c|hacx.wad}} || {{c|hacx2.wad}} || {{DRDForum|t=5771|WIP download thread}}
|}

In addition to them, some "total conversion"-type mods can be played as their own IWAD; however since they are not detected as such by EDGE, you need to use the -iwad [[command line parameter]].

In order to play a custom level designed for any of the above games you have to have that particular game's full IWAD (loading PWAD with shareware, demo or teaser versions is disabled). If you do not have the necessary IWAD, or if you have an old, [[IWAD Patching|unpatched]] version of the IWAD in question, you might experience undefined behavior. (But often old versions are accepted too.)

The IWAD file(s) should be placed in a directory where EDGE will find them. This includes the same directory as the EDGE executable, as well as those pointed to by the {{c|DOOMWADDIR}} environment variable. On Linux, the directories {{c|$HOME/.EDGE}} and {{c|/usr/local/share}} are checked by default.

==Obtaining IWADs==
As noted above, some IWADs can be downloaded freely; however most "full" games are not and must be bought from one of the following sources:
;[http://www.gog.com/games#/#sort=bestselling&devpub=id_software&page=1 GOG.com]
:This store offers downloadable versions of ''Ultimate Doom'', ''Doom II: Hell on Earth'' (bundled with ''Final Doom'' and the ''Master Levels for Doom II''), and ''Strife''. The Final Doom version offered is the later Anthology version, which fixes many mapping errors (such as the infamous [[doomwiki:MAP31: Pharaoh (TNT: Evilution)#Bugs|missing key in TNT MAP31]]).
;[http://store.steampowered.com/search/?sort_by=Name&sort_order=ASC&publisher=id+Software&category2=2&price=0%2C10&genre=Action Steam]
:This store offers downloadable versions of ''Ultimate Doom'', ''Doom II: Hell on Earth'', ''Final Doom'', ''Heretic: Shadow of the Serpent Riders'', ''Hexen: Beyond Heretic'', ''Hexen: Deathkings of the Dark Citadel'', and ''Strife''; as well as the ''Master Levels for Doom II'' which is a set of PWAD, not an IWAD.
:Warning: following the release of ''{{dw|Doom 3: BFG Edition}}'', the ''Master Levels'' are no longer available to purchase individually but can be bought as part of the Doom Classic Complete Pack.
:'''Note:''' The version of ''Hexen: Death Kings'' available on Steam is not patched. You need to download and apply the [http://www.doomworld.com/idgames/index.php?id=7022 Death Kings 1.1 patch] first. (The "readme.txt" file it tries to patch has been renamed readme-dk.txt by Steam, but is not important.) All other IWADs from Steam are fully patched.
;[http://www.amazon.com/ Amazon.com], [http://www.ebay.com/ eBay.com], etc.
:Second-hand copies of the original games can be found on such sites.
;Flea markets, used-games bins in brick-and-mortar stores, etc.
:It's mostly a matter of luck, but they can still sometimes be found this way.

==Custom IWADs==
EDGE is currently working on the ability to define any WAD/distro/archive as an IWAD or [[IPK]] (IwadPacKage) - currently this is only available by using the -iwad switch.

==See also==
*[[WAD]]
*[[PWAD]]
[[Category:Glossary]][[Category:Supported games|*]]

EDGENEW

2018-09-23T00:39:01Z

Corbin: created for the DoomWiki, we can use this as a "sandbox" of sorts until we all agree on the final version.

{{InfoboxSourcePort
|title = EDGE, 3DGE, Hyper3DGE, Dream3DGE
|developer = [[Cora Annis (Chu)]], [[Joseph Fenton]], [[Rachael Alexanderson (Eruanna)]], [[Brendan Doe]], [[Damir Srpčič]], [[Maciej Kadlubowski]], [[Andrew Apted]], [[Andy Baker (darkknight)]]
|nondeveloper = [[Chris Mullen (CeeJay)]], [[UsernameAK]], [[gameblabla]], [[Josh Pearson]], [[Benjamin Moir]], [[Luke Brennan (Lobo)]], [[Marc A. Pullen (Fanatic)]]
|baseparent = [[DOSDoom]]
|programming language = [[Wikipedia:C++|C++]], [[Wikipedia:QuakeC|QuakeC (modified)]]
|status = Active
|initialdate = 2000-06-20
|initialversion = 1.22
|platform = Cross-Platform
|license = {{GPL||2+}}
|website = [http://edge.sourceforge.net/ http://edge.sourceforge.net/]
|repourl = [https://github.com/3dfxdev/hyper3DGE GitHub]
|website = [http://edge2.sf.net/ http://edge2.sf.net/]
}}'''EDGE''' (Enhanced Doom Gaming Engine) is a collaborative Open Source project based upon the [[Doom source code]]. EDGE is derived from an earlier project called [[DOSDoom]], and started development in 1999 immediately after DOSDoom 0.65 was released. '''EDGE''' is sometimes referred to as '''3DGE''', or '''hyper3DGE''' due to the long-standing development of the '''3DGE''' fork, which was initially released on 2011-04-11; it was originally created to power the ''Hypertension'' TC, and absorbed back into EDGE seven years later. The first official EDGE version was released on June 20, 2000. The latest version of EDGE is 2.0.4, released on 2017-12-13.

EDGE includes ports to many popular operating systems, including x86/x64 Windows, Linux, BeOS, Raspberry PI, Sega Dreamcast, and Mac OSX. The project is hardware-accelerated only, and also implements support for PowerVR2 CLX2 (through KallistiOS) for the Dreamcast platform. Previous versions of EDGE incorporated both software-rendered and hardware-accelerated versions, though the former was dropped with the release of version 1.29.

The most attractive feature of EDGE is its DDF system, which originated from DOSDoom. DDF describes all game behavior inside text files external to the executable file. As a result, it is popular among modders who use the extensibility to add many new weapons and features with many fewer of the limits present in other source ports. With DDF, for example, it is possible to create monsters which can possess multiple missile and melee attacks, or create custom pain and death states for monsters when hit by specific weapons or projectiles.

Combined together with [[RTS]] and the more modular, modern language [[COAL]], EDGE can rival what more modern source ports are capable of through their respective scripting language implementations.

A few notable mods in active development are [http://www.moddb.com/mods/duke-it-out-in-doom/ Duke it Out in DOOM] and {{Dwforums|id=66125|title=Doom Forever}}, both by Chris Mullen (CeeJay), and a {{Dwforums|id=64491|title=sequel}} to the [[Marc A. Pullen (Fanatic)]] mod QDOOM. [http://facebook.com/slavefps/ SLaVE] and [https://www.facebook.com/pages/Isotope-TDGMods/232903863419077/ Hypertension: Harmony of Darkness] are two commercial products using this engine, both being developed by [https://www.facebook.com/Isotope-TDGMods-232903863419077/ Isotope Softworks] and published by [http://www.goatstorepublishing.com/ Goat Store Publishing]. The full list of known and active mods are [http://www.tdgmods.net/smf/viewforum.php?f=26/ here].

'''Dream3DGE''' was a [[Sega]] Dreamcast-only port of EDGE 1.29, and has high compatibility with pre-1.31 mods, as it cannot currently run anything created with EDGE 1.31 or above. It must be built with [http://gamedev.allusion.net/softprj/kos/ KallistOS]. It contains most, if not all, functionality from the parent port. This branch (and EDGE 1.29, on which it was based) was abandoned officially and rewritten and integrated back into 3DGE with version 2.0. The Dreamcast code utilitizes KallistiGL instead of OpenGL for important rendering functions concerning the [http://www.segatech.com/technical/cpu/ SH-4 CPU].

== History ==

DOSDoom began development in 1997, initially by [[Chi Hoang]] and became the first source-port. [[Andy Baker]] was a frequent collaborator, and soon amassed a team of developers known as the [[DOSDoom Team]]. The entirety of the DOSDoom team began developing pioneering systems that other ports did not have at the time, including [[DDF]] and [[RTS]] scripting languages - the first such human-readable systems for DOOM. It is worth noting that the scripting systems were wholly different from [[DeHacked]] at the time because they did not need to modify the executable directly, and were split into several different files that could control much more at a granular level than DeHacked ever could.

Into 1998, the community was ripe with the emergence of other source-ports, including [[ZDoom]], [[Doom Legacy]], [[Boom]], as well as the first OpenGL accelerated engine, [[glDoom]]. glDoom especially made an impact on the team into 1999 as OpenGL was seen as a major advancement at the time - this would be highly influential later in development. DOSDoom continued to be a major powerhouse for modders well into development of EDGE.

In mid 1998, [[TeamTNT]] discussed with the [[DOSDoom Team]] about merging their project, [[OGRE]] directly into [[DOSDoom]]. The collaberation was announced in late 1998 and generated much interest as TeamTNT previously developed another ground-breaking port named [[BOOM]]; discussions were even joined by the inclusion of [[John Carmack]]. However, difficulties ensued for all parties and the project was abandoned. OGRE was quite possibly the progenitor of [[EDGE]] as several of the ideas both teams wanted to do was further realized with the development of EDGE. The failed merger didn't affect DOSDoom's ultimate standing and the port continued to be popular; though, possibly as a result of the planned/failed merger of DOSDoom and OGRE, Hoang left the DOSDoom Team and the DOOM community after v0.63 was released, followed by other DOSDoom members.

In early 1999, several more source-ports were released, all offering their own features. [[3D Floors]] were pioneered with DOSDoom which generated much interest, but the DOSDoom Team began rifting as some members left the community altogether, or joined different projects. Andrew Baker and his team devised that a re-haul of DOSDoom was inevitable; the primary motivation being that the port was no longer limited to the DOS operating system. In mid 1999, [[Andrew Apted]] joined the team and it was decided that the DOSDoom name would change to better reflect its status as the most advanced 3D source-port of its time. DOSDoom v0.653 was released in April 10, 1999, which would be its final version. What was left of the DOSDoom Team at the time, with Andrew Apted and Andrew Baker, immediately formed the EDGE project with the existing code-base.

EDGE was officially released on June 20, 2000, which was seen as a milestone as the DDF and RTS systems were more fully realized, as well as becoming an early adopter of OpenGL rendering. At the time, EDGE was the most advanced port as several other emergent technologies were realized in tandem, including [[glBSP]], the first true 3D node-builder for DOOM.

EDGE development continued into the next decade. While the early/mid part of the 2000's were notable for EDGE being the supreme choice for modders and OpenGL enthusiasts, the team began to experience strain. As most members of the DOSDoom team had left by 2001, development was primarily being shouldered by Andrew Baker and Andrew Apted. Later, with the major rewrites of the engine between 1.27 and 1.29, development was shifted primarily between the last two active developers; because of the strain of a largely two-man team, the engine was perceived as being somewhat unstable. With the release of 1.31, EDGE's standing improved and modders began returning to the engine, though [[ZDoom]] was tearing much of the share away. Since the engine had once again experienced large rendering and gameplay rewrites between 1.29 and 1.31, the remainder of development was primarily headed by Andrew Apted.

In 2010, Andrew Baker had fully retired from the team, and Andrew Apted was growing more interested in other projects. He was beginning to make plans to fix up any outstanding issues with EDGE and make the final release. Perhaps as a result of ZDoom's popularity, Andrew Apted could not keep up with all of the feature requests, as he had invested much work and time into the 1.3x branch of EDGE. He began hinting at his desire to shift to other projects, notably [[Eureka]] and [[OBLIGE]], which were later released and once a part of the EDGE repository itself.

Into 2011, the community was well aware of his plans to retire from development with the release of 1.35. At the time, a major TC named [[Hypertension]] was perhaps the biggest project to be developed on the engine recently. The team of that TC foresaw the closing, and development of a fork named '''3DGE''' began to continue development as the modding team still required features that were now not a possibility.

On April 9, 2011, Andrew Apted announced his retirement from EDGE development, leaving EDGE without a maintainer for over seven years. The last version of EDGE, v1.35, was released. Two days later, the first version of '''3DGE''' was released as a hotfix to 1.35, having merged from an abandoned earlier rewrite of EDGE itself.

3DGE development continued from 2011 well into 2018, introducing major features which were seen as somewhat standard for other modder-centric ports, including [[UDMF]], archive support, [[GLSL]] shaders, and much improved and expanded features for the [[DDF]], [[RTS]], and [[COAL]] systems; lots of hard work was put into the port since the last version was released in 2016.

EDGE's popularity and perseverance earned the respect and occasional development contributions from several other major developers in the community, including GZDoom programmers [[dpJudas]], [[Rachael Alexanderson (Eruanna)]] and [[Graf Zahl]]. Andrew Apted would occasionally assist the team by providing assistance as needed.

On September 18th, 2018, [[Corbin|Cora]] made an announcement of the next major version of EDGE, which would have been the first full version released by the new team since 2016. With Andrew Apted's support and blessing, the separated 3DGE fork (which was long thought as confusing due to naming and version issues) was officially absorbed back into EDGE. 2.1.0's ultimate release will mark the first version of EDGE officially released since 2011. EDGE is therefore split into two categories as far as releases are concerned - the 1x branches, and the 2.x branches.

The former EDGE team consisted of [[Andrew Apted]] and [[Andy Baker (darkknight)]] as the primary developers, and [[Marc A. Pullen (Fanatic)]] and [[Luke Brennan (Lobo)]] as distributors/promoters.

== Features ==
* OpenGL 1.1/2.1/3.1 Renderer Paths, with Mipmapping, Smoothing, Dynamic Lighting, mirrors, portals, and [[GLSL]] shader support; Bump-Mapping on model surfaces is only supported in the 3.1 and above rendering path.
* 64-bit support
* SDL2 integration
* [[UDMF]] support
* PAK/PK3/PK7/{{3dgewiki|EPK|EPK|linkonly=1}} {{3dgewiki|Using_ZIPs_as_WAD_replacement|archive support|linkonly=1}}
* Rendering interpolation and Vsync support
* JPEG, PNG, TGA, BMP, PSD, GIF, HDR, PIC, PNM texture support, including support for [[TX_START]]/TX_END and [[HI_START]]/HI_END texture namespaces.
* [[OPL]] synth playback (using nukeyT's OPLlib)
* Basic shadows restored from EDGE 1.27
* Integration of [[ZDBSP]] and improvements to [[glBSP]], including building nodes from archives; better 3D rendering of both existing Doom levels and newer levels.
* Several major and minor bugs squashed from [[EDGE]] 1.35
* [[Heretic]]/[[Chex Quest]] IWAD support
* {{3dgewiki|MD3|MD3|linkonly=1}} and {{3dgewiki|MD5|MD5|linkonly=1}} model support
* Two-player [[splitscreen]] [[co-op]] or [[deathmatch]] (local only)
* [[multimedia:RoQ|RoQ]] video support for cinematics
* [https://sourceforge.net/projects/edge2/files/3DGE%20SOURCE/DreamEDGE/ Runs] on the [[Wikipedia:Dreamcast|Sega Dreamcast]] console.
* Normal, specular and brightmap support on models
* [[DDF]]/[[RTS]]/[[COAL]] enhancements and bugfixes
* [[Polyobject]]s (more types will be supported in the future)
* {{3dgewiki|CAMERA-MAN|Camera-Man scripts|linkonly=1}}: New scripting language which utilizes cameras for complete camera control.
* Support for up to 64 defined weapons at once through DDF
* 16 Ammo types: BULLETS, SHELLS, ROCKETS, CELLS, and AMMO5 to AMMO16. (EDGE 1.29 only. AMMO1 to AMMO4 can be used as aliases for the 4 main ammo types.)
* [[3D floor|Extrafloors]] feature allows modders to create submersible liquids, [[Doom rendering engine|room-over-room]], or catwalks, as well as vertically moving platforms not embedded into the floor.
* Four armor types: GREEN (33% reduction), BLUE (50% reduction), YELLOW (75% reduction) and RED (90% reduction).
* Automap can be made to be stationary instead of rotating with the player's facing angle, through [[COAL]]. Automap can also be applied as a secondary layer over the normal viewing screen opposed to replacing it, allowing the player to fight enemies and keep track of their position at one time.
* Weapons can have secondary attacks. Weapons can also be made to be manually reloaded, or have idle stats as well. Integration through COAL and RTS means Weapons and animations can be granularity customized.
* Support for [[MUS]], MIDI, IT/MOD, and Ogg Vorbis music formats.
* [[DDF]] files allow the editing of many features (such monsters, attacks, and levels).
* Sprites can be viewed from 16 angles (see [[Sprite]]).
* RTS scripting format includes an option known as "Start_Map ALL" that allows global scripts to be created that affect all maps in the game without copying the script under each individual map.
* Sliding doors, which are done separately without using UDMF or PolyObjects.

== In-Progress ==
* RoQ Render-to-Texture (for models, world textures, and menus/backgrounds)
* New [[DDF]] types: Terrains.ddf, Sprites.ddf, Inventory.ddf and Shaders.ddf
* Cross-platform IWAD selector
* Dynamic GLSL shader compilation
* Normal, specular, and brightmap support on textures
* True [[inventory]] support
* Dynamic planar shadow system for [[dynamic light]]s
* ''Half-Life'' MDL and MS3D Model format support
* ''Quake 3: Arena''-style shader-based sky system
* Better [[Boom]] compatibility
* [[Decal]]s on all surfaces (using Decals.ddf)
* ''[[Wolfenstein_3D]]'' support (WLF_*)
* ''[[Rise of the Triad]]'' support (ROTT_*)
* ''Blake Stone'' support (BLK_*)
* ''[[Strife]]'' support

[https://www.youtube.com/watch?v=PpzvWcz7uDY Heretic support is being finalized] and is in beta as of {{:{{PAGENAME}}/Version}}, using a similarly named definition file called HDF (Heretic Definition File). The HDF definitions were written initially by CeeJay, before the 3DGE Team took over to write proper IWAD support.

== Popular add-ons ==
EDGE also brings its own unique set of popular add-ons to the Doom community. Although some dislike EDGE for its perceived instability, the following mods have in one way or another made their mark on the community.

Keep in mind that the mods listed below were developed a long time ago, and might require legacy versions of EDGE to run properly. EDGE 2.x is known to have broken some support for old mods.

* [[Don's Challenge]] — Created by [[Cory Whittle]], Don's Challenge is a 3-episode modification based around the supernatural adventures of Don P. Tello, a veteran cop who is summoned into Hell by Mortis, the incarnation of Death, to challenge thousands of hellspawned creatures that his soul might be deemed worthy by her as a vessel. At the end of Episode 1, Don transforms Mortis into a cat. However, her brother Fate summons Mortis to Hell and takes Don with her. In the third episode, Don and Mortis return to Earth, only to find it overrun by Demons and Don's own family dead; Don and Mortis attempt to take vengeance for the deaths. This mod became popular due to the use of new monsters, weapons, and levels. One weapon (cigarettes) could even be used to heal the player. Another weapon (Booze) could be used to increase armor value, but took away a small portion of health as well. As of now, only one episode is fully released, but Episode 2 is reportedly on the way.
* [[Immoral Conduct]] - Created by [[Cory Whittle]], Immoral Conduct is a weapons modification for both EDGE and ZDoom (although the ZDoom version does not have as many features as its EDGE counterpart). The EDGE version contains the following: Knife, .45 Pistols, Stock 12g Pump Shotgun, Customized Pump Shotgun (fires 'slasher rounds'), 12g Hand Cannon, 9mm Uzi SMG, Fragment Hand Grenades, 40mm Grenade/Tear Gas Gun, Assault Rifle with M203, Infantry Rifle with Bayonet, Minigun, 12g Sawed-off Shotgun, Beretta 9mm Pistol, Chrome Magnum Revolver, Sentry Turret Kit (summons helper turrets to attack enemies), Gas-Powered Chainsaw, Remote/Proximity Satchel Charges, and Marking/Visibility Flares. New items included a 50% medikit and Nightvision Goggles. New helper monsters included the Marine Corporal and Marine Private. Monsters have also been modified (for example, the baron of Hell's blood is green), and shells are ejected from weapons. It is a [[partial conversion]], sometimes mistaken for a [[total conversion]], and in Whittle's words, "With my stuff, you have all the millions of user-made Doom and Doom II levels at your disposal to be enhanced with new weapons and items."

* [[Covert Ops]] — an EDGE version of [[Twilight Warrior]]. It has many features, such as new weapons and interesting scripts.

* [[QDoom]] (Quake Doom) — Created by [[Marc "Fanatic" Pullen]], QDoom is a total conversion of Quake to Doom.

* [[EarthBound Doom|EBDoom]] (Earthbound Doom) - Created by [[Baron of Sigma]], this modification has generated mixed opinions. It is not a complete game, and many consider it more of a "monster modification" since roughly 100+ different species of monsters exist, most of them imported and emulated from [[Heretic]], [[Hexen]], Duke Nukem 3D, Shadow Warrior, and Blood, and 'evolved' versions of existing game monsters, such as Chainsaw Zombies, Gold Liches, and Elder Mancubi. The game also appears to use a near-perfect emulation of the [[Sigil]] from Strife as an Easter egg weapon. In addition, the player has hit points instead of a health percentage, and can take much more damage than the common version of [[Doomguy]]. There are also several 'helper' characters based on the heroes of many of the Doom-engine games, including [[Doomguy]], [[Corvus]], and the player classes in Hexen. Certain bosses are also among the few in many modifications to have over 50,000 HP, with at least one boss having over 6,000,000 HP. The weapons are more 'mystical' and energy-based, with few traditional Doom-style weapons. Another unique feature in EBDoom is that all melee attacks used either by the player or other monsters/allies can inflict "critical hits" up to 4x damage at times, as in an RPG. Despite the community's mixed opinions of the mod, it is often used as a resource wad by other modders who want to quickly import foreign monsters into their own mods (as the author appears not to mind this). It is also one of the three mods in the Doom community to use [[Hissy]] as a central plot player, and makes many references to another EDGE mod known as [[Cacodemon Squad]]. This modification was last updated at 6.56 on January 12, 2006.

* [[GoldenEye Doom2]] - A fairly large in-progress TC. Featuring a load of weapons in both single and multiplayer maps. Multiple versions are available: A single player DEH version compatible with Doom Legacy and Zdoom 1.22. Multiplayer levels for standard Doom2. An enhanced single player EDGE 1.27+ version. The Edge version contains the following weapons: punch/kick, Knives, Watch lazer, _Soviet_Tank_, Silencedable PP7, Dostovie, Cougar Magnum, Automatic Shotgun, pathetic Klobb, Duestch, Zmg, KF7, Sniper Rifle, Ak47, Moon Raker Laser, RCP-90, Golden Gun, Golden PP7, Rocket Launcher, and Grenades. Most of the weapons have alternate firing modes and some weapons can be dual-wielded.

* [[Cold Hard Cash]] - An unique weapons mod offering a larger variety of weapons. Cold Hard Cash's spin on the weapons mod is that instead of just finding weapons laying around or dropped from enemies, the player must mug monsters for money to use at special weapons dispensers, which replace the original weapons, and sometimes artifacts and appear in their place. An example is that the Chainsaw is now a dispenser that allows the player to buy a Knife, a Crowbar, and other melee-type items. Most dispensers have a special offer on it, usually an upgrade to an existing weapon, which requires the said weapon in question to be held by the player before they can use it. It is also the first EDGE mod to use the "Start_Map ALL" RTS function, introduced in the 3rd release candidate of EDGE 1.29, which allows the same scripts to be usable on all maps instead of having to add the same ones to each map individually.

== External links ==
*[http://edge2.sourceforge.net Official EDGE site]
*[https://sourceforge.net/projects/edge2/files/3DGE%20binaries/ EDGE release packages], hosted by {{wp|SourceForge}}
*[https://sourceforge.net/projects/edge/files/EDGE%20Binaries/ Legacy EDGE binary releases, hosted by {{wp|SourceForge}}
*[https://github.com/3dfxdev/hyper3DGE 3DGE git repository], hosted by github
*[https://devbuilds.drdteam.org/3dge/ Compiled SVN builds] for Windows, Linux, Mac, and Dreamcast at [[DRD Team]]
*{{3dgewiki|Main Page|Documentation}}
{{s-start}}
{{s-port}}
{{s-bef|before=[[DOSDoom]]}}
{{s-ttl|title=EDGE}}
{{s-aft|after=[[EDGE 2.x]]}}
{{s-end}}
[[Category:Source ports]]
[[Category:Boom compatible]]
[[Category:Doom ports]]
[[Category:OpenGL ports]]

Next version

2018-09-19T16:12:02Z

Corbin:

== Development RoadMap ==

The features listed as In-Progress are features tied into the engine currently, which need to be finished up.

== In-Progress ==
* PolyObjects (available in the latest devbuilds, more types will be supported in the future)
* Normal/Spec/Brightmap support on textures
* Rise of the Triad support (ROTT_*)
* Dynamic Planar Shadow System for Dynamic Lights (Models only)
* Quake 3: Arena-style shader-based sky system
* Better BOOM Compatibility
* Decals on all surfaces
* TERRAIN.DDF: new DDF type for floors, that can do all sorts of neat things according to what flat name is being accessed at the current time.
* SPRITES.DDF: new DDF type for plain sprites, to control things like Offsets, Brightmaps, etc.
* New Input system, for split-screen controls
* Wolfenstein 3D support (WLF_*)

== FUTURE ==
Future features are features that are not yet tied into the engine, but support will be coming soon for them.

* DECALS.DDF: new DDF type for wall decals (bullet holes) and floor decals (splats, explosions, etc)
* IWAD Selection Dialogue Box (like ZDoom)
* Blake Stone support (BLK_*)
* Strife IWAD
* Completed Heretic support, including an Inventory system
* True Networking, for internet play

COAL Manual

2018-09-14T21:09:49Z

Corbin: /* PLAYER MODULE */ updated Player Module

== OVERVIEW ==

[[COAL|COAL]] is a new scripting language which has been developed especially for 3DGE. At the moment, 3DGE uses this to define custom HUD modules. This manual is designed to get you up-to-speed on all of the functions that COAL provides.<blockquote>The standard Coal scripts for drawing the DOOM HUD is loaded from this file: <code>doom_ddf/coal_hud.ec</code></blockquote><blockquote>The API that COAL itself is contained in is loaded from <code>doom_ddf/coal_api.ec</code>, which is a good reference to look at while developing your HUD. Take note that the API is hard-coded to 3DGE.</blockquote><blockquote>Additionally, each archive may contain a lump called "<code>COALHUDS</code>" which is automatically loaded (which can reside in the PAK/PK3 namespace ''<sub><code>./scripts</code></sub>''). Later scripts are able to replace any definitions (functions etc) in earlier scripts.</blockquote>

== FILES CONTENTS ==

=== The contents of each file or lump is simply the text of the COAL code. ===
The engine provides two modules: the "hud" module provides drawing functions and general queries, whereas the "player" module provides query functions about the current player. All of their functions and variables are described in separate sections below.

In order to customize the default HUDs, your COAL code ''needs'' to redefine one of the existing functions, as follows:<blockquote><big>'''doom_status_bar()'''</big> ''':''' <code>replace this function if you only want to customize the full status bar (including the one shown in the automap screen). The size has to be the same (width 320, height 32).</code></blockquote><blockquote><big>'''overlay_status_bar()'''</big> ''':''' <code>write your own version of this function if you only want to change the overlay status bar.</code></blockquote><blockquote><big>'''doom_automap()'''</big> ''':''' <code>this function draws the automap screen (including the status bar at the bottom). Replacing it means you can show other information here instead of (or in addition to) the automap.</code></blockquote><blockquote><big>'''draw_all()'''</big> ''':''' <code>this is the function which EDGE calls to draw everything. The normal version (in EDGE.WAD) will call the above functions depending on the user's current HUD and whether the automap is active or not. Replacing this function gives you total control: you could provide more hud configurations (or less) than the usual three, ignore the automap mode completely if you wanted, or even draw the view from multiple players.</code></blockquote>

== HUD MODULE ==

=== General Queries ===

==== <code>'''hud.check_automap() : float'''</code> ====
<blockquote><code>''This function returns true while the user is viewing the automap (by pressing TAB) and false for the normal view.''</code></blockquote>

==== <code>'''hud.which_hud() : float'''</code> ====
<blockquote><code>''This variable returns the current HUD number which the user cycles through when pressing '+' and '-' keys. It ranges from 0 to 119, allowing 120 different HUD screens, but in reality you must use the modulo operator '%' to convert this number to a smaller range.''</code></blockquote><blockquote><code>''For example, the standard code uses hud.which_hud() % 3 to select between three different huds (none, normal and overlay).''</code> </blockquote><blockquote><code>''The following are good modulo numbers: 2,3,4,5,6,8 and 10 (because they divide into 120).''</code></blockquote><blockquote><code>For a HUD which never changes, simply ignore this value.</code></blockquote>

==== '''<code>hud.get_time() : float</code>''' ====
<blockquote><code>''This function returns the current time, in terms of "tics" where there are 35 tics per second. In other words, after each 1/35th of a second the value of '''hud.now_time''' increases by one. It keeps going even during menus or while the game is paused.''</code></blockquote>

==== '''<code>hud.passed_time</code>''' ====
<blockquote><code>''This variable is updated by the '''hud.grab_times()''' call, and contains the number of "tics" that have passed since the last time the '''draw_all()''' function was called. Note that a result of zero is possible.''</code></blockquote>

==== '''<code>hud.game_mode() : string</code>''' ====
<blockquote><code>''This function returns a string for the current game mode: "sp" (Single Player), "coop" (Cooperative), or "dm" (Deathmatch).''</code></blockquote>

==== '''<code>hud.game_name() : string</code>''' ====
<blockquote>''<code>This function returns the DDF name of the current game being played (the one defined in [[GAMES|GAMES.DDF]]).</code>''</blockquote>

==== '''<code>hud.map_name() : string</code>''' ====
<blockquote>''<code>This function returns the DDF name of the current map being played (the one defined in [[LEVELS|LEVELS.DDF]]).</code>''</blockquote>

==== '''<code>hud.map_title() : string</code>''' ====
<blockquote>''<code>This function returns the title of the map being played, mainly to be displayed on the automap.</code>''</blockquote>

== * Drawing Stuff ==

==== '''<code>hud.coord_sys(w, h)</code>''' ====
<blockquote>''<code>In the original DOOM, the screen size was always 320x200, and by default all of the drawing functions here use screen coordinates as if that were the case (even when EDGE is running in different modes likes 640x480 or 1024x768). This function allows you to set a different "virtual" resolution, for example 640x400, and then all coordinates will be for this new system, plus the size of images and text characters will be affected as well.</code>''</blockquote>

==== <code>'''hud.text_font(name)'''</code> ====
<blockquote><code>''Sets the current text font, where the 'name' parameter refers to an entry in [[FONTS|FONTS.DDF]]. The default font is "DOOM" and is reset after each frame.''</code></blockquote>

==== '''<code>hud.text_color(name)</code>''' ====
<blockquote>''<code>Sets the current text color, which must refer to an entry in [[COLMAP|COLMAPS.DDF]], or can be the empty string "" which causes the text to be drawn normally (without being colormapped). The default is "" and is reset after each frame.</code>''</blockquote>

==== '''<code>hud.set_scale(value)</code>''' ====
<blockquote>''<code>Sets the scaling for drawing text and for '''hud.draw_image()'''. Larger values make the text/image bigger. The default scale is 1.0 and is reset after each frame.</code>''</blockquote>

==== '''<code>hud.set_alpha(value)</code>''' ====
<blockquote>''<code>Set the alpha value (translucency) for drawing text, lines, boxes and images. The 'value' parameter ranges from 0.0 (completely invisible) to 1.0 (completely solid). The default alpha is 1.0 and is reset after each frame.</code>''</blockquote>

==== '''<code>hud.solid_box(x, y, w, h, color)</code>''' ====
<blockquote><code>''Draws a solid rectangle consisting of a single color. The 'x' and 'y' parameters are the coordinates of the top left corner, whereas 'w' and 'h' are the width and height. The current alpha value is also applied.''</code></blockquote><blockquote>''<code>The 'color' parameter can take two different forms. Firstly it may be a string with the same notation as DDF and HTML, which begins with a "#" character and is followed by 6 hexadecimal digits. For example "#FF0000" for red and "#0000FF" for blue. Secondly it can be a Lua table with fields called 'r', 'g' and 'b' (for red, green and blue). Each of these fields is a number from 0 to 255. For example: { r=255, g=170, b=0 } for orange.</code>''</blockquote>

==== '''<code>hud.solid_line(x1, y1, x2, y2, color)</code>''' ====
<blockquote><code>''Draws a solid line between the start coordinate (x1,y1) to the end coordinate (x2, y2). The 'color' parameter is the same as for hud.solid_box(), and the current alpha value is also applied.''</code></blockquote>

==== '''<code>hud.thin_box(x, y, w, h, color)</code>''' ====
<blockquote>''<code>Similar to '''hud.solid_box()''', but only draws the outline of a rectangle. The inside area is not affected. The sides are always two pixels thick, and never go outside the specified area. The 'color' parameter is the same as for '''hud.solid_box()''', and the current alpha value is also applied.</code>''</blockquote>

==== '''<code>hud.gradient_box(x, y, w, h, TL, BL, TR, BR)</code>''' ====
<blockquote><code>''Similar to '''hud.solid_box()''', but the colors for each corner are specified individually: 'TL' for top left, 'BL' for bottom left, 'TR' for top right and 'BR' for bottom right. The current alpha value will also be applied.''</code></blockquote>

==== <code>'''hud.draw_image(x, y, name)'''</code> ====
<blockquote>''<code>Draws an image at the given coordinates, which specify the top/left corner of the image. The current alpha and scaling factors are applied as well.</code>''</blockquote>

==== '''<code>hud.stretch_image(x, y, w, h, name)</code>''' ====
<blockquote>''<code>Similar to '''hud.draw_image()''', but the image will be stretched or squashed so that it fits exactly into the given rectangle on the screen. The current alpha value is also applied.</code>''</blockquote>

==== '''<code>hud.tile_image(x, y, w, h, name, [x_offset, y_offset])</code>''' ====
<blockquote>''<code>Draws an image (usually a texture or flat) on the screen, where the image is tiled (repeated) to fill up the given rectangle. The current alpha and scaling factors are also applied. The 'x_offset' and 'y_offset' parameters are optional, and can be used to offset the texture by a certain number of pixels.</code>''</blockquote>

==== '''<code>hud.draw_text(x, y, str)</code>''' ====
<blockquote><code>''Draws some text on the screen using the current text font, color, alpha and scaling values. Newlines ("\n") in the string can be used to draw multi-line text.''</code></blockquote>

==== '''<code>hud.draw_num2(x, y, len, num)</code>''' ====
<blockquote>''<code>Draws a number (an integer) on the screen using the current text font, color, alpha and scaling. The number is right-aligned, in other words the 'x' parameter specified the right-most pixel, and the 'len' parameter gives the maximum number of characters (including the minus sign if the number is negative).</code>''</blockquote>

==== '''<code>hud.render_world(x, y, w, h)</code>''' ====
<blockquote><code>''Renders the view for the player on the screen, in a rectangle with the given coordinates. The player's weapon is also drawn. The views of different players can be rendered by using the '''hud.set_render_who()''' function below.''</code></blockquote>

==== '''<code>hud.render_automap(x, y, w, h, [options])</code>''' ====
<blockquote>''<code>Renders the automap for the player on the screen, in a rectangle with the given coordinates. Note that no background is drawn, hence you can use this function to create an overlay automap (drawn over the top of the player's view). If you need a solid color behind it, use the '''hud.solid_box()''' function first.</code>''</blockquote><blockquote><code>The 'options' parameter is optional, when present it is a table containing a set of variables which modify the way the automap is drawn. Variables which are not present in the table are not affected (stay the same as the user's normal automap). The following list shows all the possible variables:</code></blockquote><blockquote><code>Variable Description</code></blockquote>
** <code>zoom Set a fixed zoom factor, where 1.0 shows the whole map, and larger values make the map bigger</code>

** <code>grid force the grid lines on/off</code>
** <code>rotate force map rotation on/off</code>
** <code>follow force follow-player mode on/off</code>
** <code>things draw all things</code>
** <code>walls draw all walls (like IDDT cheat)</code>
** <code>allmap draw walls like All-Map powerup</code>

==== <code>'''hud.set_render_who(index)'''</code> ====
<blockquote>''<code>Sets the current player for rendering the world or the automap. The 'index' parameter is a small number: 1 for the "main player" on this computer (the person at the keyboard), 2 for the next player in the list, etc... upto the number of players in the game.</code>''</blockquote>

==== <code>'''hud.automap_colors(table)'''</code> ====
<blockquote>''<code>This function can be used to change some or all of the colors used when drawing the automap. The 'table' parameter is a Lua table where the names are automap parts and the values are the colors. For example: { grid = "#006666", wall = "#FFFFFF" }. Parts that are not present in the table are not affected (stay the same as before). Here is a list of all the automap parts that can be changed:</code>''</blockquote><blockquote><code>Automap Part Description</code></blockquote>
** grid Grid lines
** wall One sided walls
** step Floor height change, climable
** ledge Floor drop-off, too high to climb
** ceil Ceiling height difference
** secret Secret doors
** allmap Unseen walls when you have the All-Map
** player Player object
** monster Monsters
** corpse Dead monsters
** item Pickup items
** missile Missiles, fireballs, etc
** scenery Scenery items

== * Audio Functions ==

==== '''<code>hud.play_sound(name)</code>''' ====
<blockquote>''<code>Plays the given sound, which must be an entry in SOUNDS.DDF.</code>''</blockquote>

== PLAYER MODULE ==

=== General Queries ===

==== '''<code>player.is_bot()</code>''' ====
<blockquote>''<code>Returns true if the current player is a bot.</code>''</blockquote>

==== '''<code>player.get_name()</code>''' ====
<blockquote><code>''Returns the name of the current player.''</code></blockquote>

==== '''<code>player.get_angle()</code>''' ====
<blockquote><code>''Returns the angle of the current player.''</code></blockquote>

==== '''<code>player.get_pos()</code>''' ====
<blockquote><code>''Returns the position of the current player.''</code></blockquote>

==== '''<code>player.get_mlook()</code>''' ====
<blockquote><code>''Returns the mlook (mouse-look) angle of the current player.''</code></blockquote>

==== '''<code>player.health()</code>''' ====
<blockquote>''<code>Returns the health of the current player. The result will normally be in the range 0 to 100, regardless of the SPAWNHEALTH setting for the player in DDF (in other words, the result is a percentage value of the spawn health). Values higher than 100 are possible when the player has bonus health (e.g. from the Soul Sphere pickup).</code>''</blockquote>

==== '''<code>player.armor(type)</code>''' ====
<blockquote>''<code>For the given armor type, returns the amount the player is currently wearing. The 'type' parameter is a number in the range 1-5, but the following names can be used for more readable code:</code>''</blockquote>
** <code>ARMORS.green</code>
** <code>ARMORS.blue</code>
** <code>ARMORS.purple</code>
** <code>ARMORS.yellow</code>
** <code>ARMORS.red</code>

==== '''<code>player.total_armor(type)</code>''' ====
<blockquote>''<code>Returns the total amount of armor the player has.</code>''</blockquote>

==== '''<code>player.frags()</code>''' ====
<blockquote>''<code>Number of frags the player has (for Deathmatch games).</code>''</blockquote>

==== '''<code>player.move_speed()</code>''' ====
<blockquote>''<code>Returns a number for how fast the player is currently moving, roughly the number of map units per tic (there are 35 tics per second).</code>''</blockquote>

==== '''<code>player.air_in_lungs()</code>''' ====
<blockquote>''<code>Returns amount of air in the player lungs, as a percentage value from 0 to 100. Only guaranteed to be valid while the player is underwater.</code>''</blockquote>

==== '''<code>player.has_key(key)</code>''' ====
<blockquote>''<code>Returns true if the player currently has the specified key, which is a number from 1 to 16. For more readable code, the following names can be used:</code>''</blockquote>
** <code>KEYS.blue_card KEYS.gold_key</code>
** <code>KEYS.red_card KEYS.brass_key</code>
** <code>KEYS.yellow_card KEYS.steel_key</code>
** <code>KEYS.green_card KEYS.fire_key</code>
** <code>KEYS.blue_skull KEYS.silver_key</code>
** <code>KEYS.red_skull KEYS.copper_key</code>
** <code>KEYS.yellow_skull KEYS.wooden_key</code>
** <code>KEYS.green_skull KEYS.water_key</code>

==== '''<code>player.has_power(power)</code>''' ====
<blockquote>''<code>Returns true if the player currently has the specified powerup. The 'power' parameter is a number from 1 to 16. For more readable code, the following names can be used:</code>''</blockquote>
** <code>POWERS.invuln</code>
** <code>POWERS.berserk</code>
** <code>POWERS.invis</code>
** <code>POWERS.acid_suit</code>
** <code>POWERS.automap</code>
** <code>POWERS.goggles</code>
** <code>POWERS.jet_pack</code>
** <code>POWERS.night_vis</code>
** <code>POWERS.scuba</code>

==== '''<code>player.power_left(power)</code>''' ====
<blockquote>''<code>Returns the number of seconds remaining for the specified powerup, or zero when the player does not have it. The berserk powerup only counts down the red-screen effect, and returns -1 when that is finished. The automap powerup returns a large value when active and it never counts down. The result for invulnerability is not affected by the God-mode cheat.</code>''</blockquote>

== * Weapon Stuff ==

==== '''<code>player.has_weapon(name)</code>''' ====
<blockquote><code>''Returns true if the player currently owns the weapon, where 'name' is the DDF name of the weapon.''</code></blockquote>

==== '''<code>player.has_weapon_slot(slot)</code>''' ====
<blockquote>''<code>Returns true if the player currently owns any weapon which uses the given 'slot', which is a number for 0 to 9 (same as the BINDKEY command in the DDF).</code>''</blockquote>

==== '''<code>player.cur_weapon()</code>''' ====
<blockquote>''<code>Returns the DDF name of the weapon the player is currently holding, or the special value "none" when the player is holding no weapon at all, or "change" while the weapon is switching to a new one.</code>''</blockquote>

==== '''<code>player.cur_weapon_slot()</code>''' ====
<blockquote>''<code>Returns the slot number (i.e. BINDKEY) of the weapon the player is currently holding, or -1 when the player is holding no weapon at all.</code>''</blockquote>

==== '''<code>player.ammo(type)</code>''' ====
<blockquote>''<code>Returns the amount of ammo the player is carrying (not including any ammo inside the clips of weapons). The 'type' parameter is a number in the range 1-16. For more readable code, one of the following names can be used instead:</code>''</blockquote>
** <code>AMMOS.bullets AMMOS.pellets</code>
** <code>AMMOS.shells AMMOS.nails</code>
** <code>AMMOS.rockets AMMOS.grenades</code>
** <code>AMMOS.cells AMMOS.gas</code>

==== <code>'''player.ammomax(type)'''</code> ====
<blockquote>''<code>Returns the maximum amount of ammo the player can carry (not including weapon clips). The 'type' parameter is the same as the '''player.ammo()''' function.</code>''</blockquote>

==== '''<code>player.main_ammo()</code>''' ====
<blockquote><code>''Returns the main ammo quantity for the player's current weapon. This is zero for weapons that don't use any ammo (like the FIST). If the weapon has a clip and the SHOWCLIP command (in DDF) is true, then the amount of ammo inside the clip is returned instead. Note that only the primary attack is checked, the secondary attack (if present) will be ignored.''</code></blockquote>

==== '''<code>player.ammo_type(ATK)</code>''' ====
<blockquote>''<code>Returns the ammo type of the player's current weapon for the given attack (primary or secondary). The result is in the range 1-16, or can be 0 for the special case of NOAMMO. The 'ATK' parameter is 1 for the primary attack, 2 for the secondary attack, and is compulsory.</code>''</blockquote>

==== '''<code>player.ammo_pershot(ATK)</code>''' ====
<blockquote><code>''Returns the ammo used up per shot by the current weapon for the given attack (primary or secondary). Same as the AMMOPERSHOT commands in WEAPONS.DDF. The 'ATK' parameter is 1 for the primary attack, 2 for the secondary attack, and is compulsory.''</code></blockquote>

==== '''<code>player.clip_ammo(ATK)</code>''' ====
<blockquote>''<code>Returns the current amount of ammo the clip in the player's current weapon is holding, or zero if the weapon has no clip. The 'ATK' parameter is 1 for the primary attack, 2 for the secondary attack, and is compulsory.</code>''</blockquote>

==== '''<code>player.clip_size(ATK)</code>''' ====
<blockquote>''<code>Returns the maximum amount of ammo the clip in the player's current weapon can hold, or zero if the weapon has no clip. The 'ATK' parameter is 1 for the primary attack, 2 for the secondary attack, and is compulsory.</code>''</blockquote>

==== '''<code>player.clip_is_shared()</code>''' ====
<blockquote>''<code>Returns true if the player's current weapon is sharing a single clip between primary and secondary attackes (the SHARED_CLIP command).</code>''</blockquote>

== * Conditions ==

==== '''<code>player.on_ground()</code>''' ====
<blockquote>''<code>Returns true if player is standing on solid ground.</code>''</blockquote>

==== '''<code>player.under_water()</code>''' ====
<blockquote>''<code>Returns true if player is in AIRLESS water and doesn't have the Scuba powerup.</code>''</blockquote>

==== '''<code>player.is_swimming()</code>''' ====
<blockquote>''<code>Returns true if player is in swimmable water (i.e. the SWIM sector special).</code>''</blockquote>

==== '''<code>player.is_jumping()</code>''' ====
<blockquote>''<code>Returns true if player is jumping.</code>''</blockquote>

==== '''<code>player.is_crouching()</code>''' ====
<blockquote>''<code>Returns true if player is crouching.</code>''</blockquote>

==== '''<code>player.get_side_move()</code>''' ====
<blockquote>''<code>Returns true if player is strafing from side-to-side.</code>''</blockquote>

==== '''<code>player.is_attacking()</code>''' ====
<blockquote>''<code>Returns true if player is firing his weapon (either first or second attack).</code>''</blockquote>

==== '''<code>player.is_rampaging()</code>''' ====
<blockquote>''<code>Returns true if player has been firing his weapon for two seconds or more.</code>''</blockquote>

==== '''<code>player.is_using()</code>''' ====
<blockquote>''<code>Returns true if player is holding the USE button down.</code>''</blockquote>

==== '''<code>player.is_grinning()</code>''' ====
<blockquote>''<code>Returns true if player is grinning (after picking up a weapon).</code>''</blockquote>

== * Miscellaneous ==

==== '''<code>player.num_players()</code>''' ====
<blockquote>''<code>Returns the total number of players in the game, including bots.</code>''</blockquote>

==== '''<code>player.set_who(index)</code>''' ====
<blockquote><code>''Sets who the current player is. The 'index' parameter is a small number: 1 for the "main player" on this computer (the person at the keyboard), 2 for the next player in the list, for instance the split-screen player) etc... up to the number of players in the game. All the player query functions described here return their results for the current player.''</code></blockquote>

==== '''<code>player.hurt_by()</code>''' ====
<blockquote>''<code>If the player has been hurt in the last few seconds, this returns a string describing what did the damage. Otherwise this function returns nil. The result is usually "enemy", but could be "friend" for friendly fire. If the player hurt himself with his own damn stupidity then the result is "self", whereas damaging floors and crushers will return "other".</code>''</blockquote>

==== '''<code>player.hurt_mon()</code>''' ====
<blockquote>''<code>If the player has been hurt in the last few seconds, this returns the name of the monster or other player. Otherwise this function returns nil.</code>''</blockquote>

==== '''<code>player.hurt_pain()</code>''' ====
<blockquote>''<code>If the player was just hurt, this returns the damage amount, otherwise this function returns 0.</code>''</blockquote>

==== '''<code>player.hurt_dir()</code>''' ====
<blockquote>''<code>If the player was just hurt, this returns a direction relative to the player where the attacker was: -1 for the left side, +1 for the right side, and 0 for all other cases.</code>''</blockquote>

==== '''<code>player.hurt_angle()</code>''' ====
<blockquote>''<code>Like player.hurt_dir(), except this returns the map angle from the player to his attacker. The result is in degrees (ranging from 0 to 359), where East is 0 and North is 90.</code>''</blockquote>

== * CAMERA MODULE ==

==== '''<code>cam.set_vert_bob(f)</code>''' ====
<blockquote>''<code>Sets the Player bobbing. The parameter flags above are as follows:</code>''</blockquote>
* <blockquote>Parameter is a ''Float'' for controlling the vertical bobbing. This was previously encapsulated in DDF where it is now controlled via COAL.</blockquote>
* <blockquote>The default value is 1.2 - setting it to 0.0 will completely disable bobbing.</blockquote>

==== '''<code>cam.set_roll_bob(f)</code>''' ====
<blockquote>Parameter is a ''Float'' for customizing camera rolling. Note that this can be combined with set_vert_bob, OR can be called from other functions (such as being combined with player.get_side_move() or combined with player.hurt_pain()).</blockquote><blockquote>By Default the camera set_roll_bob amount is 0.0.</blockquote>

== CAMERA-MAN MODULE ==
The new Camera-Man system is in reality a COAL module, and can be completely configured through COAL. However, due to its complexity and the fact that the format is not in the QC extension (which is actually done with Console Commands), it has its own article and how-to's. [[CAMERA-MAN|You can visit that guide by clicking on this sentence.]]

COAL Manual

2018-09-14T20:25:36Z

Corbin: Updated COAL documentation

== OVERVIEW ==

[[COAL|COAL]] is a new scripting language which has been developed especially for 3DGE. At the moment, 3DGE uses this to define custom HUD modules. This manual is designed to get you up-to-speed on all of the functions that COAL provides.<blockquote>The standard Coal scripts for drawing the DOOM HUD is loaded from this file: <code>doom_ddf/coal_hud.ec</code></blockquote><blockquote>The API that COAL itself is contained in is loaded from <code>doom_ddf/coal_api.ec</code>, which is a good reference to look at while developing your HUD. Take note that the API is hard-coded to 3DGE.</blockquote><blockquote>Additionally, each archive may contain a lump called "<code>COALHUDS</code>" which is automatically loaded (which can reside in the PAK/PK3 namespace ''<sub><code>./scripts</code></sub>''). Later scripts are able to replace any definitions (functions etc) in earlier scripts.</blockquote>

== FILES CONTENTS ==

=== The contents of each file or lump is simply the text of the COAL code. ===
The engine provides two modules: the "hud" module provides drawing functions and general queries, whereas the "player" module provides query functions about the current player. All of their functions and variables are described in separate sections below.

In order to customize the default HUDs, your COAL code ''needs'' to redefine one of the existing functions, as follows:<blockquote><big>'''doom_status_bar()'''</big> ''':''' <code>replace this function if you only want to customize the full status bar (including the one shown in the automap screen). The size has to be the same (width 320, height 32).</code></blockquote><blockquote><big>'''overlay_status_bar()'''</big> ''':''' <code>write your own version of this function if you only want to change the overlay status bar.</code></blockquote><blockquote><big>'''doom_automap()'''</big> ''':''' <code>this function draws the automap screen (including the status bar at the bottom). Replacing it means you can show other information here instead of (or in addition to) the automap.</code></blockquote><blockquote><big>'''draw_all()'''</big> ''':''' <code>this is the function which EDGE calls to draw everything. The normal version (in EDGE.WAD) will call the above functions depending on the user's current HUD and whether the automap is active or not. Replacing this function gives you total control: you could provide more hud configurations (or less) than the usual three, ignore the automap mode completely if you wanted, or even draw the view from multiple players.</code></blockquote>

== HUD MODULE ==

=== General Queries ===

==== <code>'''hud.check_automap() : float'''</code> ====
<blockquote><code>''This function returns true while the user is viewing the automap (by pressing TAB) and false for the normal view.''</code></blockquote>

==== <code>'''hud.which_hud() : float'''</code> ====
<blockquote><code>''This variable returns the current HUD number which the user cycles through when pressing '+' and '-' keys. It ranges from 0 to 119, allowing 120 different HUD screens, but in reality you must use the modulo operator '%' to convert this number to a smaller range.''</code></blockquote><blockquote><code>''For example, the standard code uses hud.which_hud() % 3 to select between three different huds (none, normal and overlay).''</code> </blockquote><blockquote><code>''The following are good modulo numbers: 2,3,4,5,6,8 and 10 (because they divide into 120).''</code></blockquote><blockquote><code>For a HUD which never changes, simply ignore this value.</code></blockquote>

==== '''<code>hud.get_time() : float</code>''' ====
<blockquote><code>''This function returns the current time, in terms of "tics" where there are 35 tics per second. In other words, after each 1/35th of a second the value of '''hud.now_time''' increases by one. It keeps going even during menus or while the game is paused.''</code></blockquote>

==== '''<code>hud.passed_time</code>''' ====
<blockquote><code>''This variable is updated by the '''hud.grab_times()''' call, and contains the number of "tics" that have passed since the last time the '''draw_all()''' function was called. Note that a result of zero is possible.''</code></blockquote>

==== '''<code>hud.game_mode() : string</code>''' ====
<blockquote><code>''This function returns a string for the current game mode: "sp" (Single Player), "coop" (Cooperative), or "dm" (Deathmatch).''</code></blockquote>

==== '''<code>hud.game_name() : string</code>''' ====
<blockquote>''<code>This function returns the DDF name of the current game being played (the one defined in [[GAMES|GAMES.DDF]]).</code>''</blockquote>

==== '''<code>hud.map_name() : string</code>''' ====
<blockquote>''<code>This function returns the DDF name of the current map being played (the one defined in [[LEVELS|LEVELS.DDF]]).</code>''</blockquote>

==== '''<code>hud.map_title() : string</code>''' ====
<blockquote>''<code>This function returns the title of the map being played, mainly to be displayed on the automap.</code>''</blockquote>

== * Drawing Stuff ==

==== '''<code>hud.coord_sys(w, h)</code>''' ====
<blockquote>''<code>In the original DOOM, the screen size was always 320x200, and by default all of the drawing functions here use screen coordinates as if that were the case (even when EDGE is running in different modes likes 640x480 or 1024x768). This function allows you to set a different "virtual" resolution, for example 640x400, and then all coordinates will be for this new system, plus the size of images and text characters will be affected as well.</code>''</blockquote>

==== <code>'''hud.text_font(name)'''</code> ====
<blockquote><code>''Sets the current text font, where the 'name' parameter refers to an entry in [[FONTS|FONTS.DDF]]. The default font is "DOOM" and is reset after each frame.''</code></blockquote>

==== '''<code>hud.text_color(name)</code>''' ====
<blockquote>''<code>Sets the current text color, which must refer to an entry in [[COLMAP|COLMAPS.DDF]], or can be the empty string "" which causes the text to be drawn normally (without being colormapped). The default is "" and is reset after each frame.</code>''</blockquote>

==== '''<code>hud.set_scale(value)</code>''' ====
<blockquote>''<code>Sets the scaling for drawing text and for '''hud.draw_image()'''. Larger values make the text/image bigger. The default scale is 1.0 and is reset after each frame.</code>''</blockquote>

==== '''<code>hud.set_alpha(value)</code>''' ====
<blockquote>''<code>Set the alpha value (translucency) for drawing text, lines, boxes and images. The 'value' parameter ranges from 0.0 (completely invisible) to 1.0 (completely solid). The default alpha is 1.0 and is reset after each frame.</code>''</blockquote>

==== '''<code>hud.solid_box(x, y, w, h, color)</code>''' ====
<blockquote><code>''Draws a solid rectangle consisting of a single color. The 'x' and 'y' parameters are the coordinates of the top left corner, whereas 'w' and 'h' are the width and height. The current alpha value is also applied.''</code></blockquote><blockquote>''<code>The 'color' parameter can take two different forms. Firstly it may be a string with the same notation as DDF and HTML, which begins with a "#" character and is followed by 6 hexadecimal digits. For example "#FF0000" for red and "#0000FF" for blue. Secondly it can be a Lua table with fields called 'r', 'g' and 'b' (for red, green and blue). Each of these fields is a number from 0 to 255. For example: { r=255, g=170, b=0 } for orange.</code>''</blockquote>

==== '''<code>hud.solid_line(x1, y1, x2, y2, color)</code>''' ====
<blockquote><code>''Draws a solid line between the start coordinate (x1,y1) to the end coordinate (x2, y2). The 'color' parameter is the same as for hud.solid_box(), and the current alpha value is also applied.''</code></blockquote>

==== '''<code>hud.thin_box(x, y, w, h, color)</code>''' ====
<blockquote>''<code>Similar to '''hud.solid_box()''', but only draws the outline of a rectangle. The inside area is not affected. The sides are always two pixels thick, and never go outside the specified area. The 'color' parameter is the same as for '''hud.solid_box()''', and the current alpha value is also applied.</code>''</blockquote>

==== '''<code>hud.gradient_box(x, y, w, h, TL, BL, TR, BR)</code>''' ====
<blockquote><code>''Similar to '''hud.solid_box()''', but the colors for each corner are specified individually: 'TL' for top left, 'BL' for bottom left, 'TR' for top right and 'BR' for bottom right. The current alpha value will also be applied.''</code></blockquote>

==== <code>'''hud.draw_image(x, y, name)'''</code> ====
<blockquote>''<code>Draws an image at the given coordinates, which specify the top/left corner of the image. The current alpha and scaling factors are applied as well.</code>''</blockquote>

==== '''<code>hud.stretch_image(x, y, w, h, name)</code>''' ====
<blockquote>''<code>Similar to '''hud.draw_image()''', but the image will be stretched or squashed so that it fits exactly into the given rectangle on the screen. The current alpha value is also applied.</code>''</blockquote>

==== '''<code>hud.tile_image(x, y, w, h, name, [x_offset, y_offset])</code>''' ====
<blockquote>''<code>Draws an image (usually a texture or flat) on the screen, where the image is tiled (repeated) to fill up the given rectangle. The current alpha and scaling factors are also applied. The 'x_offset' and 'y_offset' parameters are optional, and can be used to offset the texture by a certain number of pixels.</code>''</blockquote>

==== '''<code>hud.draw_text(x, y, str)</code>''' ====
<blockquote><code>''Draws some text on the screen using the current text font, color, alpha and scaling values. Newlines ("\n") in the string can be used to draw multi-line text.''</code></blockquote>

==== '''<code>hud.draw_num2(x, y, len, num)</code>''' ====
<blockquote>''<code>Draws a number (an integer) on the screen using the current text font, color, alpha and scaling. The number is right-aligned, in other words the 'x' parameter specified the right-most pixel, and the 'len' parameter gives the maximum number of characters (including the minus sign if the number is negative).</code>''</blockquote>

==== '''<code>hud.render_world(x, y, w, h)</code>''' ====
<blockquote><code>''Renders the view for the player on the screen, in a rectangle with the given coordinates. The player's weapon is also drawn. The views of different players can be rendered by using the '''hud.set_render_who()''' function below.''</code></blockquote>

==== '''<code>hud.render_automap(x, y, w, h, [options])</code>''' ====
<blockquote>''<code>Renders the automap for the player on the screen, in a rectangle with the given coordinates. Note that no background is drawn, hence you can use this function to create an overlay automap (drawn over the top of the player's view). If you need a solid color behind it, use the '''hud.solid_box()''' function first.</code>''</blockquote><blockquote><code>The 'options' parameter is optional, when present it is a table containing a set of variables which modify the way the automap is drawn. Variables which are not present in the table are not affected (stay the same as the user's normal automap). The following list shows all the possible variables:</code></blockquote><blockquote><code>Variable Description</code></blockquote>
** <code>zoom Set a fixed zoom factor, where 1.0 shows the whole map, and larger values make the map bigger</code>

** <code>grid force the grid lines on/off</code>
** <code>rotate force map rotation on/off</code>
** <code>follow force follow-player mode on/off</code>
** <code>things draw all things</code>
** <code>walls draw all walls (like IDDT cheat)</code>
** <code>allmap draw walls like All-Map powerup</code>

==== <code>'''hud.set_render_who(index)'''</code> ====
<blockquote>''<code>Sets the current player for rendering the world or the automap. The 'index' parameter is a small number: 1 for the "main player" on this computer (the person at the keyboard), 2 for the next player in the list, etc... upto the number of players in the game.</code>''</blockquote>

==== <code>'''hud.automap_colors(table)'''</code> ====
<blockquote>''<code>This function can be used to change some or all of the colors used when drawing the automap. The 'table' parameter is a Lua table where the names are automap parts and the values are the colors. For example: { grid = "#006666", wall = "#FFFFFF" }. Parts that are not present in the table are not affected (stay the same as before). Here is a list of all the automap parts that can be changed:</code>''</blockquote><blockquote><code>Automap Part Description</code></blockquote>
** grid Grid lines
** wall One sided walls
** step Floor height change, climable
** ledge Floor drop-off, too high to climb
** ceil Ceiling height difference
** secret Secret doors
** allmap Unseen walls when you have the All-Map
** player Player object
** monster Monsters
** corpse Dead monsters
** item Pickup items
** missile Missiles, fireballs, etc
** scenery Scenery items

== * Audio Functions ==

==== '''<code>hud.play_sound(name)</code>''' ====
<blockquote>''<code>Plays the given sound, which must be an entry in SOUNDS.DDF.</code>''</blockquote>

== PLAYER MODULE ==

=== General Queries ===

==== '''<code>player.is_bot()</code>''' ====
<blockquote>''<code>Returns true if the current player is a bot.</code>''</blockquote>

==== '''<code>player.get_name()</code>''' ====
<blockquote><code>''Returns the name of the current player.''</code></blockquote>

==== '''<code>player.health()</code>''' ====
<blockquote>''<code>Returns the health of the current player. The result will normally be in the range 0 to 100, regardless of the SPAWNHEALTH setting for the player in DDF (in other words, the result is a percentage value of the spawn health). Values higher than 100 are possible when the player has bonus health (e.g. from the Soul Sphere pickup).</code>''</blockquote>

==== '''<code>player.armor(type)</code>''' ====
<blockquote>''<code>For the given armor type, returns the amount the player is currently wearing. The 'type' parameter is a number in the range 1-5, but the following names can be used for more readable code:</code>''</blockquote>
** <code>ARMORS.green</code>
** <code>ARMORS.blue</code>
** <code>ARMORS.purple</code>
** <code>ARMORS.yellow</code>
** <code>ARMORS.red</code>

==== '''<code>player.total_armor(type)</code>''' ====
<blockquote>''<code>Returns the total amount of armor the player has.</code>''</blockquote>

==== '''<code>player.frags()</code>''' ====
<blockquote>''<code>Number of frags the player has (for Deathmatch games).</code>''</blockquote>

==== '''<code>player.move_speed()</code>''' ====
<blockquote>''<code>Returns a number for how fast the player is currently moving, roughly the number of map units per tic (there are 35 tics per second).</code>''</blockquote>

==== '''<code>player.air_in_lungs()</code>''' ====
<blockquote>''<code>Returns amount of air in the player lungs, as a percentage value from 0 to 100. Only guaranteed to be valid while the player is underwater.</code>''</blockquote>

==== '''<code>player.has_key(key)</code>''' ====
<blockquote>''<code>Returns true if the player currently has the specified key, which is a number from 1 to 16. For more readable code, the following names can be used:</code>''</blockquote>
** <code>KEYS.blue_card KEYS.gold_key</code>
** <code>KEYS.red_card KEYS.brass_key</code>
** <code>KEYS.yellow_card KEYS.steel_key</code>
** <code>KEYS.green_card KEYS.fire_key</code>
** <code>KEYS.blue_skull KEYS.silver_key</code>
** <code>KEYS.red_skull KEYS.copper_key</code>
** <code>KEYS.yellow_skull KEYS.wooden_key</code>
** <code>KEYS.green_skull KEYS.water_key</code>

==== '''<code>player.has_power(power)</code>''' ====
<blockquote>''<code>Returns true if the player currently has the specified powerup. The 'power' parameter is a number from 1 to 16. For more readable code, the following names can be used:</code>''</blockquote>
** <code>POWERS.invuln</code>
** <code>POWERS.berserk</code>
** <code>POWERS.invis</code>
** <code>POWERS.acid_suit</code>
** <code>POWERS.automap</code>
** <code>POWERS.goggles</code>
** <code>POWERS.jet_pack</code>
** <code>POWERS.night_vis</code>
** <code>POWERS.scuba</code>

==== '''<code>player.power_left(power)</code>''' ====
<blockquote>''<code>Returns the number of seconds remaining for the specified powerup, or zero when the player does not have it. The berserk powerup only counts down the red-screen effect, and returns -1 when that is finished. The automap powerup returns a large value when active and it never counts down. The result for invulnerability is not affected by the God-mode cheat.</code>''</blockquote>

== * Weapon Stuff ==

==== '''<code>player.has_weapon(name)</code>''' ====
<blockquote><code>''Returns true if the player currently owns the weapon, where 'name' is the DDF name of the weapon.''</code></blockquote>

==== '''<code>player.has_weapon_slot(slot)</code>''' ====
<blockquote>''<code>Returns true if the player currently owns any weapon which uses the given 'slot', which is a number for 0 to 9 (same as the BINDKEY command in the DDF).</code>''</blockquote>

==== '''<code>player.cur_weapon()</code>''' ====
<blockquote>''<code>Returns the DDF name of the weapon the player is currently holding, or the special value "none" when the player is holding no weapon at all, or "change" while the weapon is switching to a new one.</code>''</blockquote>

==== '''<code>player.cur_weapon_slot()</code>''' ====
<blockquote>''<code>Returns the slot number (i.e. BINDKEY) of the weapon the player is currently holding, or -1 when the player is holding no weapon at all.</code>''</blockquote>

==== '''<code>player.ammo(type)</code>''' ====
<blockquote>''<code>Returns the amount of ammo the player is carrying (not including any ammo inside the clips of weapons). The 'type' parameter is a number in the range 1-16. For more readable code, one of the following names can be used instead:</code>''</blockquote>
** <code>AMMOS.bullets AMMOS.pellets</code>
** <code>AMMOS.shells AMMOS.nails</code>
** <code>AMMOS.rockets AMMOS.grenades</code>
** <code>AMMOS.cells AMMOS.gas</code>

==== <code>'''player.ammomax(type)'''</code> ====
<blockquote>''<code>Returns the maximum amount of ammo the player can carry (not including weapon clips). The 'type' parameter is the same as the '''player.ammo()''' function.</code>''</blockquote>

==== '''<code>player.main_ammo()</code>''' ====
<blockquote><code>''Returns the main ammo quantity for the player's current weapon. This is zero for weapons that don't use any ammo (like the FIST). If the weapon has a clip and the SHOWCLIP command (in DDF) is true, then the amount of ammo inside the clip is returned instead. Note that only the primary attack is checked, the secondary attack (if present) will be ignored.''</code></blockquote>

==== '''<code>player.ammo_type(ATK)</code>''' ====
<blockquote>''<code>Returns the ammo type of the player's current weapon for the given attack (primary or secondary). The result is in the range 1-16, or can be 0 for the special case of NOAMMO. The 'ATK' parameter is 1 for the primary attack, 2 for the secondary attack, and is compulsory.</code>''</blockquote>

==== '''<code>player.ammo_pershot(ATK)</code>''' ====
<blockquote><code>''Returns the ammo used up per shot by the current weapon for the given attack (primary or secondary). Same as the AMMOPERSHOT commands in WEAPONS.DDF. The 'ATK' parameter is 1 for the primary attack, 2 for the secondary attack, and is compulsory.''</code></blockquote>

==== '''<code>player.clip_ammo(ATK)</code>''' ====
<blockquote>''<code>Returns the current amount of ammo the clip in the player's current weapon is holding, or zero if the weapon has no clip. The 'ATK' parameter is 1 for the primary attack, 2 for the secondary attack, and is compulsory.</code>''</blockquote>

==== '''<code>player.clip_size(ATK)</code>''' ====
<blockquote>''<code>Returns the maximum amount of ammo the clip in the player's current weapon can hold, or zero if the weapon has no clip. The 'ATK' parameter is 1 for the primary attack, 2 for the secondary attack, and is compulsory.</code>''</blockquote>

==== '''<code>player.clip_is_shared()</code>''' ====
<blockquote>''<code>Returns true if the player's current weapon is sharing a single clip between primary and secondary attackes (the SHARED_CLIP command).</code>''</blockquote>

== Conditions ==

==== '''<code>player.on_ground()</code>''' ====
<blockquote>''<code>Returns true if player is standing on solid ground.</code>''</blockquote>

==== '''<code>player.under_water()</code>''' ====
<blockquote>''<code>Returns true if player is in AIRLESS water and doesn't have the Scuba powerup.</code>''</blockquote>

==== '''<code>player.is_swimming()</code>''' ====
<blockquote>''<code>Returns true if player is in swimmable water (i.e. the SWIM sector special).</code>''</blockquote>

==== '''<code>player.is_jumping()</code>''' ====
<blockquote>''<code>Returns true if player is jumping.</code>''</blockquote>

==== '''<code>player.is_crouching()</code>''' ====
<blockquote>''<code>Returns true if player is crouching.</code>''</blockquote>

==== '''<code>player.get_side_move()</code>''' ====
<blockquote>''<code>Returns true if player is strafing from side-to-side.</code>''</blockquote>

==== '''<code>player.is_attacking()</code>''' ====
<blockquote>''<code>Returns true if player is firing his weapon (either first or second attack).</code>''</blockquote>

==== '''<code>player.is_rampaging()</code>''' ====
<blockquote>''<code>Returns true if player has been firing his weapon for two seconds or more.</code>''</blockquote>

==== '''<code>player.is_using()</code>''' ====
<blockquote>''<code>Returns true if player is holding the USE button down.</code>''</blockquote>

==== '''<code>player.is_grinning()</code>''' ====
<blockquote>''<code>Returns true if player is grinning (after picking up a weapon).</code>''</blockquote>

== * Miscellaneous ==

==== '''<code>player.num_players()</code>''' ====
<blockquote>''<code>Returns the total number of players in the game, including bots.</code>''</blockquote>

==== '''<code>player.set_who(index)</code>''' ====
<blockquote><code>''Sets who the current player is. The 'index' parameter is a small number: 1 for the "main player" on this computer (the person at the keyboard), 2 for the next player in the list, etc... upto the number of players in the game. All the player query functions described here return their results for the current player.''</code></blockquote>

==== '''<code>player.hurt_by()</code>''' ====
<blockquote>''<code>If the player has been hurt in the last few seconds, this returns a string describing what did the damage. Otherwise this function returns nil. The result is usually "enemy", but could be "friend" for friendly fire. If the player hurt himself with his own damn stupidity then the result is "self", whereas damaging floors and crushers will return "other".</code>''</blockquote>

==== '''<code>player.hurt_mon()</code>''' ====
<blockquote>''<code>If the player has been hurt in the last few seconds, this returns the name of the monster or other player. Otherwise this function returns nil.</code>''</blockquote>

==== '''<code>player.hurt_pain()</code>''' ====
<blockquote>''<code>If the player was just hurt, this returns the damage amount, otherwise this function returns 0.</code>''</blockquote>

==== '''<code>player.hurt_dir()</code>''' ====
<blockquote>''<code>If the player was just hurt, this returns a direction relative to the player where the attacker was: -1 for the left side, +1 for the right side, and 0 for all other cases.</code>''</blockquote>

==== '''<code>player.hurt_angle()</code>''' ====
<blockquote>''<code>Like player.hurt_dir(), except this returns the map angle from the player to his attacker. The result is in degrees (ranging from 0 to 359), where East is 0 and North is 90.</code>''</blockquote>

== CAMERA MODULE ==
'''<code>cam.set_bob(1|0, [, 1.0,0.0)</code>'''<blockquote>''<code>Sets the Player bobbing. The parameter flags above are as follows:</code>''</blockquote>
* <blockquote>First Parameter is an '''Integer''' for enabling or disabling the camera bob. This can either be 1 or 0.</blockquote>
* <blockquote>Second Parameter is a '''Float''' for controlling the Up/Down bobbing scale.</blockquote>
* <blockquote>Third Parameter is a '''Float''' for controlling the camera roll bobbing scale.</blockquote>

== GAME MODULE ==

==== '''<code>player.is_bot()</code>''' ====
<blockquote>''<code>Returns true if the current player is a bot.</code>''</blockquote>

Texture Formats (Dreamcast)

2018-09-03T18:10:30Z

Corbin: Created page with "This tutorial will explain how you can store image data on the Dreamcast's PVR graphics chip for efficient drawing and compact storage. List of texture formats: http://game..."

This tutorial will explain how you can store image data on the Dreamcast's PVR graphics chip for efficient drawing and compact storage.

List of texture formats: [[http://gamedev.allusion.net/docs/kos-current/group__pvr__txr__fmts.html]]

= Color formats =
== Truecolor ==
This table describes the color information that can be stored in textures.

{|RGB565 || 5 bits of red, 6 bits of green, 5 bits of blue, no transparency
|-
|ARGB1555 || each color channel has 5 bits, transparency is on or off
|-
|ARGB4444 || each channel has 4 bits, use if you need a transparent gradient
|-
|BUMP || bumpmap format (stores angles for vertex displacement effects in lighting calculations), similar to a normal map
|-
|YUV422 || mostly used for video decoding, uncommonly used
|}

== Paletted ==
There are also paletted texture formats which can be combined with the above color formats as well as ARGB8888.

4BPP_PAL (or 8BPP_PAL)
# Define an array of 2^4 = 16 (or 2^8 = 256) color values.
# Copy the array to the graphics chip, then send textures that use 4-bit (or 8-bit) indices into that array instead of 16 bit argb as pixel values.

ARGB8888 is slow when used with filtering.

You can set multiple palettes on the graphics chip at the same time (1024 bytes total), so they're not per-texture at all, but global.

Paletted textures are always twiddled and never strided.

= Additional attributes =
Textures can be twiddled, VQ compressed, strided or mipmapped.

== Twiddled ==
Pixels aren't stored row-by-row, but in a z-shape arrangement which puts neighboring pixels closer together. This makes texture filtering cheaper and you definitely want to use it. Twiddled textures must have power-of-two dimensions (e.g. 512x512, 256x1024).

== VQ compressed ==
Vector Quantization is a lossy texture compression. The Dreamcast graphics chip has special hardware to decode it, so you suffer no performance loss for the decoding step when texture data is read by it for drawing. Textures will use less video memory.

== Strided ==
A way to draw non-power-of-two textures by defining gaps.

== Mipmapped ==
Each texture stores smaller versions of itself (512x256 -> 256x128 -> 128x64..). Makes textures 1/3 bigger, texture filtering cheaper and improves rendering performance when textures are displayed at a smaller than original size.

= Converting art assets to Dreamcast texture formats =
It is more efficient to convert your PNG/TGA/etc. art assets during the build process of your game instead of during runtime.

There are tools for conversion in the KOS utils folder. Be aware that the KOS conversion tool does not support non-square VQ textures, although it should.
This conversion tool by tvspelsfreak offers support for that in addition to a handy preview feature [[https://github.com/tvspelsfreak/texconv]]

= Comparison between uncompressed and compressed =
To see how useful applying the proper texture format is, check out [http://dcemulation.org/phpBB/viewtopic.php?f=29&t=103369&p=1045482 this thread]

Consider face.png, 1024x1024, RGB888 for example.

* 304K face.png
* 3.1M face.tga
* 516K face.dds
* 344K face.kmg
* 108K face.kmg.gz

If you store this texture on the CD as PNG, it will will take 304 kilobytes.

After unpacking it and storing it in video memory it will take 3 megabytes (1024*1024 * 3 bytes = 3 MB).

If you convert it from RGB888 to RGB565 it will still take 2 megabytes.

The VQ compressed RGB565 texture takes 344 kilobytes in video memory. No decompression is required, it is quicker to upload to the PVR graphics chip and requires 6 times less video memory.
Depending on the amount of colors in the original image the quality loss may not be noticeable.

ROQ Videos

2018-07-09T18:09:32Z

Corbin:

RoQ is a video file format that originated in The 11th Hour game. After Graeme Devine, the creator of the format joined id Software, the RoQ file format has been in use in every game the company has released such as Quake III, Return to Castle Wolfenstein and DOOM 3. As it applies to id Tech 4 , these files are used for video sequences and animated materials and are stored in / base/video .

EDGE uses ROQ as the format of choice for cinematic playback.

__TOC__

== Technical details ==
The format runs at a fixed 30 frames per second with an optional 22050 Hz mono or stereo sound track. Videos may technically be up to 65520 x 65520 pixels with both dimensions divisible by 16 and produce a valid RoQ file, but none of id Software’s games will play back a video with dimensions that aren’t a power of two, most likely because of OpenGL’s texture sizing restrictions.<blockquote>'''NOTE''' : It’s been reported that movies with dimensions greater than 512 x 512 cause issues in EDGE. Whatever the dimensions, make sure they are POWER-OF-TWO!</blockquote>RoQ is a motion compensating vector quanitizer format, similar to Cinepak, but higher quality due to the use of the ITU-R BT.601 colorspace (the same one used in component video, PAL televisions, JPEG and MPEG), whereas Cinepak uses a low-quality YUV-like colorspace designed for faster decoding that often results in gamut degradation before compression even begins.

Because it’s a vector quantizer, RoQ files are very fast to decode and very slow to encode. Decoding involves nothing more than converting the colorspace of the codebooks and then copying data, whereas encoding involves using several complicated schemes to produce a “palette” of image fragments that will result in the least degradation.

RoQ uses two codebooks per frame, with the second being constructed from pieces of the first, with up to 256 entries each. Due to this, only 1024 new colors can be introduced each frame, severely limiting the color gamut. This could arguably be improved by better predicting which sections will be motion compensated, but doing so is difficult, since codebook entries are generated from non-motion-compensated image sections, but whether or not they’ll be used depends on the quality of them compared to motion compensated sections, resulting in a chicken-and-egg problem. This is made worse by the fact that all three major RoQ codecs are single-pass.

While the format is limited and much lower quality than MPEG and Indeo Video, it was presumedly preferred by id Software because of the lack of royalties, the lack of patent liability that presents a serious problem with most video formats, and the absence of complex platform-specific APIs.

== Content creation ==
You can create your own RoQ files using one of the following:
* FFMPEG (see Tutorial below)
* [http://www.swift-tools.net/Quake/QVM/ Quake Video Maker]
* [http://icculus.org/~riot/ Switchblade] (also includes a patch for FFMPEG).

== TUTORIAL ==
# To create a movie from a source file (either MP4 or AVI, but AVI is preferred) - you must have FFMPEG downloaded first. You can download the version you need from the [https://www.ffmpeg.org/ FFMPEG Website].
# Put your source movie into the same directory as you have the binary for FFMPEG.
# Next, open the command-prompt (or your CLR of choice), and type in the following switches:
<blockquote>ffmpeg -i {yourmovie.format} -r 30 -s 512x512 -ar 22050 {output}.Roq</blockquote>Where {<code>yourmovie</code>} is the source title, <code>format</code> is either MP4/AVI, and <code>output</code> is the name of your ROQ. The technical gist is that it encodes the movie at <code>30FPS</code> (which is hard-coded, so better to have your video at 30FPS before you encode it), with a fixed resolution of <code>512x512</code> (power-of-two will upscale it automatically), and <code>22050</code> is the sound frequency (MUST BE 22KHZ!).

<code>It's a good idea to do some video checks first. ROQ is limited to 512x512, but EDGE has scaling routines that make it look pretty decent in higher resolutions. '''Make sure your video is POWER OF TWO''', otherwise your ROQ will decode poorly.</code>
# With your ROQ, name it {intro.roq} and put it in the /video namespace inside of your archive. Right now, EDGE is limited to playing ROQ animations on startup only.

TODO: EDGE over-all integration

ROQ Videos

2018-07-09T18:06:20Z

Corbin:

RoQ is a video file format that originated in The 11th Hour game. After Graeme Devine, the creator of the format joined id Software, the RoQ file format has been in use in every game the company has released such as Quake III, Return to Castle Wolfenstein and DOOM 3. As it applies to id Tech 4 , these files are used for video sequences and animated materials and are stored in / base/video .

EDGE uses ROQ as the format of choice for cinematic playback.

__TOC__

== Technical details ==
The format runs at a fixed 30 frames per second with an optional 22050 Hz mono or stereo sound track. Videos may technically be up to 65520 x 65520 pixels with both dimensions divisible by 16 and produce a valid RoQ file, but none of id Software’s games will play back a video with dimensions that aren’t a power of two, most likely because of OpenGL’s texture sizing restrictions.

'''NOTE''' : It’s been reported that movies with dimensions greater than 512 x 512 cause issues in various id Software games. Until this can be positively confirmed or denied it’s best to avoid higher resolutions.

RoQ is a motion compensating vector quanitizer format, similar to Cinepak, but higher quality due to the use of the ITU-R BT.601 colorspace (the same one used in component video, PAL televisions, JPEG and MPEG), whereas Cinepak uses a low-quality YUV-like colorspace designed for faster decoding that often results in gamut degradation before compression even begins.

Because it’s a vector quantizer, RoQ files are very fast to decode and very slow to encode. Decoding involves nothing more than converting the colorspace of the codebooks and then copying data, whereas encoding involves using several complicated schemes to produce a “palette” of image fragments that will result in the least degradation.

RoQ uses two codebooks per frame, with the second being constructed from pieces of the first, with up to 256 entries each. Due to this, only 1024 new colors can be introduced each frame, severely limiting the color gamut. This could arguably be improved by better predicting which sections will be motion compensated, but doing so is difficult, since codebook entries are generated from non-motion-compensated image sections, but whether or not they’ll be used depends on the quality of them compared to motion compensated sections, resulting in a chicken-and-egg problem. This is made worse by the fact that all three major RoQ codecs are single-pass.

While the format is limited and much lower quality than MPEG and Indeo Video, it was presumedly preferred by id Software because of the lack of royalties, the lack of patent liability that presents a serious problem with most video formats, and the absence of complex platform-specific APIs.

== Content creation ==
You can create your own RoQ files using one of the following:
* FFMPEG (see Tutorial below)
* [http://www.swift-tools.net/Quake/QVM/ Quake Video Maker]
* [http://icculus.org/~riot/ Switchblade] (also includes a patch for FFMPEG).

== TUTORIAL ==
# To create a movie from a source file (either MP4 or AVI, but AVI is preferred) - you must have FFMPEG downloaded first. You can download the version you need from the [https://www.ffmpeg.org/ FFMPEG Website].
# Put your source movie into the same directory as you have the binary for FFMPEG.
# Next, open the command-prompt (or your CLR of choice), and type in the following switches:
<blockquote>ffmpeg -i {yourmovie.format} -r 30 -s 512x512 -ar 22050 {output}.Roq</blockquote>Where {<code>yourmovie</code>} is the source title, <code>format</code> is either MP4/AVI, and <code>output</code> is the name of your ROQ. The technical gist is that it encodes the movie at <code>30FPS</code> (which is hard-coded, so better to have your video at 30FPS before you encode it), with a fixed resolution of <code>512x512</code> (power-of-two will upscale it automatically), and <code>22050</code> is the sound frequency (MUST BE 22KHZ!).

<code>It's a good idea to do some video checks first. ROQ is limited to 512x512, but EDGE has scaling routines that make it look pretty decent in higher resolutions. '''Make sure your video is POWER OF TWO''', otherwise your ROQ will decode poorly.</code>
# With your ROQ, name it {intro.roq} and put it in the /video namespace inside of your archive. Right now, EDGE is limited to playing ROQ animations on startup only.

TODO: EDGE over-all integration

ROQ Videos

2018-07-09T18:04:46Z

Corbin:

{TOC}
RoQ is a video file format that originated in The 11th Hour game. After Graeme Devine, the creator of the format joined id Software, the RoQ file format has been in use in every game the company has released such as Quake III, Return to Castle Wolfenstein and DOOM 3. As it applies to id Tech 4 , these files are used for video sequences and animated materials and are stored in / base/video .

EDGE uses ROQ as the format of choice for cinematic playback.

== Technical details ==
The format runs at a fixed 30 frames per second with an optional 22050 Hz mono or stereo sound track. Videos may technically be up to 65520 x 65520 pixels with both dimensions divisible by 16 and produce a valid RoQ file, but none of id Software’s games will play back a video with dimensions that aren’t a power of two, most likely because of OpenGL’s texture sizing restrictions.

'''NOTE''' : It’s been reported that movies with dimensions greater than 512 x 512 cause issues in various id Software games. Until this can be positively confirmed or denied it’s best to avoid higher resolutions.

RoQ is a motion compensating vector quanitizer format, similar to Cinepak, but higher quality due to the use of the ITU-R BT.601 colorspace (the same one used in component video, PAL televisions, JPEG and MPEG), whereas Cinepak uses a low-quality YUV-like colorspace designed for faster decoding that often results in gamut degradation before compression even begins.

Because it’s a vector quantizer, RoQ files are very fast to decode and very slow to encode. Decoding involves nothing more than converting the colorspace of the codebooks and then copying data, whereas encoding involves using several complicated schemes to produce a “palette” of image fragments that will result in the least degradation.

RoQ uses two codebooks per frame, with the second being constructed from pieces of the first, with up to 256 entries each. Due to this, only 1024 new colors can be introduced each frame, severely limiting the color gamut. This could arguably be improved by better predicting which sections will be motion compensated, but doing so is difficult, since codebook entries are generated from non-motion-compensated image sections, but whether or not they’ll be used depends on the quality of them compared to motion compensated sections, resulting in a chicken-and-egg problem. This is made worse by the fact that all three major RoQ codecs are single-pass.

While the format is limited and much lower quality than MPEG and Indeo Video, it was presumedly preferred by id Software because of the lack of royalties, the lack of patent liability that presents a serious problem with most video formats, and the absence of complex platform-specific APIs.

== Content creation ==
You can create your own RoQ files using one of the following:
* FFMPEG (see Tutorial below)
* [http://www.swift-tools.net/Quake/QVM/ Quake Video Maker]
* [http://icculus.org/~riot/ Switchblade] (also includes a patch for FFMPEG).

== TUTORIAL ==
# To create a movie from a source file (either MP4 or AVI, but AVI is preferred) - you must have FFMPEG downloaded first. You can download the version you need from the [https://www.ffmpeg.org/ FFMPEG Website].
# Put your source movie into the same directory as you have the binary for FFMPEG.
# Next, open the command-prompt (or your CLR of choice), and type in the following switches:
<blockquote>ffmpeg -i {yourmovie.format} -r 30 -s 512x512 -ar 22050 {output}.Roq</blockquote>Where {<code>yourmovie</code>} is the source title, <code>format</code> is either MP4/AVI, and <code>output</code> is the name of your ROQ. The technical gist is that it encodes the movie at <code>30FPS</code> (which is hard-coded, so better to have your video at 30FPS before you encode it), with a fixed resolution of <code>512x512</code> (power-of-two will upscale it automatically), and <code>22050</code> is the sound frequency (MUST BE 22KHZ!).

<code>It's a good idea to do some video checks first. ROQ is limited to 512x512, but EDGE has scaling routines that make it look pretty decent in higher resolutions. '''Make sure your video is POWER OF TWO''', otherwise your ROQ will decode poorly.</code>
# With your ROQ, name it {intro.roq} and put it in the /video namespace inside of your archive. Right now, EDGE is limited to playing ROQ animations on startup only.

TODO: EDGE over-all integration

ROQ Videos

2018-07-09T18:04:29Z

Corbin: Created ROQ Videos, made a little tutorial.

RoQ is a video file format that originated in The 11th Hour game. After Graeme Devine, the creator of the format joined id Software, the RoQ file format has been in use in every game the company has released such as Quake III, Return to Castle Wolfenstein and DOOM 3. As it applies to id Tech 4 , these files are used for video sequences and animated materials and are stored in / base/video .

EDGE uses ROQ as the format of choice for cinematic playback.

== Technical details ==
The format runs at a fixed 30 frames per second with an optional 22050 Hz mono or stereo sound track. Videos may technically be up to 65520 x 65520 pixels with both dimensions divisible by 16 and produce a valid RoQ file, but none of id Software’s games will play back a video with dimensions that aren’t a power of two, most likely because of OpenGL’s texture sizing restrictions.

'''NOTE''' : It’s been reported that movies with dimensions greater than 512 x 512 cause issues in various id Software games. Until this can be positively confirmed or denied it’s best to avoid higher resolutions.

RoQ is a motion compensating vector quanitizer format, similar to Cinepak, but higher quality due to the use of the ITU-R BT.601 colorspace (the same one used in component video, PAL televisions, JPEG and MPEG), whereas Cinepak uses a low-quality YUV-like colorspace designed for faster decoding that often results in gamut degradation before compression even begins.

Because it’s a vector quantizer, RoQ files are very fast to decode and very slow to encode. Decoding involves nothing more than converting the colorspace of the codebooks and then copying data, whereas encoding involves using several complicated schemes to produce a “palette” of image fragments that will result in the least degradation.

RoQ uses two codebooks per frame, with the second being constructed from pieces of the first, with up to 256 entries each. Due to this, only 1024 new colors can be introduced each frame, severely limiting the color gamut. This could arguably be improved by better predicting which sections will be motion compensated, but doing so is difficult, since codebook entries are generated from non-motion-compensated image sections, but whether or not they’ll be used depends on the quality of them compared to motion compensated sections, resulting in a chicken-and-egg problem. This is made worse by the fact that all three major RoQ codecs are single-pass.

While the format is limited and much lower quality than MPEG and Indeo Video, it was presumedly preferred by id Software because of the lack of royalties, the lack of patent liability that presents a serious problem with most video formats, and the absence of complex platform-specific APIs.

== Content creation ==
You can create your own RoQ files using one of the following:
* FFMPEG (see Tutorial below)
* [http://www.swift-tools.net/Quake/QVM/ Quake Video Maker]
* [http://icculus.org/~riot/ Switchblade] (also includes a patch for FFMPEG).

== TUTORIAL ==
# To create a movie from a source file (either MP4 or AVI, but AVI is preferred) - you must have FFMPEG downloaded first. You can download the version you need from the [https://www.ffmpeg.org/ FFMPEG Website].
# Put your source movie into the same directory as you have the binary for FFMPEG.
# Next, open the command-prompt (or your CLR of choice), and type in the following switches:
<blockquote>ffmpeg -i {yourmovie.format} -r 30 -s 512x512 -ar 22050 {output}.Roq</blockquote>Where {<code>yourmovie</code>} is the source title, <code>format</code> is either MP4/AVI, and <code>output</code> is the name of your ROQ. The technical gist is that it encodes the movie at <code>30FPS</code> (which is hard-coded, so better to have your video at 30FPS before you encode it), with a fixed resolution of <code>512x512</code> (power-of-two will upscale it automatically), and <code>22050</code> is the sound frequency (MUST BE 22KHZ!).

<code>It's a good idea to do some video checks first. ROQ is limited to 512x512, but EDGE has scaling routines that make it look pretty decent in higher resolutions. '''Make sure your video is POWER OF TWO''', otherwise your ROQ will decode poorly.</code>
# With your ROQ, name it {intro.roq} and put it in the /video namespace inside of your archive. Right now, EDGE is limited to playing ROQ animations on startup only.

TODO: EDGE over-all integration

CAMERA-MAN

2018-06-04T18:13:21Z

Corbin: finally added CAMERA-MAN basics

== Introduction ==
'''Camera-Man''' governs setup and handling of in-engine cameras. With Camera-Man, you can create dynamic, trigger-able (via [[Radius Trigger Script]] or [[COAL]]) cameras, using a simple-to-understand console commands.

== Loading ==
In EDGE, cameras are recorded and stored as ''.CAMDAT'' files. The current directory the Camera-Man scripts are saved to is '''../doom_ddf/cameras/MAPNAME''', where ''MAPNAME'' is either a Map in ExMx, MAPxx, or any format tied to [[GlBSP|edgeBSP]] (using the GL_ prefixes for a custom map).

<nowiki><code>'''</nowiki>You can control the default directory to save CAMDAT files to, using the console command ''camera_subdir<nowiki></code></nowiki>.''

== Basics ==

=== 2.1 Console Commands ===
Basic setup of the camera-man system is done via set of console commands, listed below:<blockquote>- 'actcam' - activates (turns on) the system, by default it is inactive; the command requires a single parameter to indicated whether to turn on or off the system (1 or 0),</blockquote><blockquote>- 'rstcam' - resets the system to its default state (erases all stored cameras and turns it off),</blockquote><blockquote>- 'addcam' - adds a new camera in player's current location and orientation; it requires two parameters - field-of-view angle, in degrees and a name for the camera (which is optional),</blockquote><blockquote>- 'remcam' - removes a camera of given idetifier (provided by 'addcam') or name; removal by name requires the first parameter to be set to -1,</blockquote><blockquote>- 'swtcam' - switches the view to the camera given by an identifier or a name; switching by name requires the first parameter to be set to -1,</blockquote><blockquote>- 'strcam' - sets the camera of given identifier or name as the first one (start) to interpolate between; setting the camera by name requires the first parameter to be set to -1,</blockquote><blockquote>- 'endcam' - sets the camera of given identifier or name as the second one (end) to interpolate between; setting the camera by name requires the first parameter to be set to -1,</blockquote><blockquote>- 'poscam' - sets position of the camera of given identifier or name to be players current position; setting the camera by name requires the first parameter to be set to -1,</blockquote><blockquote>- 'angcam' - sets angles of the camera of given identifier or name to be players current angles (vertical and horizontal); setting the camera by name requires the first parameter to be set to -1,</blockquote><blockquote>- 'fovcam' - sets field-of-view angle (in degrees) of the camera of given identifier or name to be of the given value; setting the camera by name requires the first parameter to be set to -1,</blockquote><blockquote>- 'savcam' - saves current state of the system to a file located in a sub-directory specified in 'camera_subdir' global variable (by default set to 'doom_ddf/cameras'); saved file name is the same as the name of the currently open map,</blockquote><blockquote>- 'lddcam' - loads the state of the system from a file located in a sub-directory specified in 'camera_subdir' global variable (by default set to 'doom_ddf/cameras'); loaded file name is the same as the name of the currently open map,</blockquote><blockquote>- 'prtcam' - prints debugging information about current state of the system (i.e. lists all cameras avaiable),</blockquote><blockquote>- 'tghelp' - toggles rendering of helper gizmos in the engine (e.g. gizmos showing where cameras were set up).</blockquote>

=== 2.2 COAL Interface ===
Camera-man system is also controllable via COAL scripts, see the [[CAMERA-MAN Manual]] for more information.

- [TODO]

=== 2.3 RTS Interface ===
Camera-man system is also controllable via RTS scripts, see the [[CAMERA-MAN Manual]] for more information.

Supported data formats

2018-05-06T00:30:59Z

Corbin:

3DGE supports a wide array of data formats for the end-user. Below is a short list:

=[[Archive_format|ARCHIVE FORMATS]]=
* While 3DGE supports more, below are the most commonly used nowadays:
[[EPK]] - EDGE PAcKage: almost identical to [[PK3]], used only for EDGE<br />
[[PK3]] - Quake 3 (etc) '''ZIP''' format with namespace support<br />
[[PK7]] - 7Zip compressed archive format<br />
[[PAK]] - Quake WAD equivalent<br />

=MODEL FORMATS=
[[MD2]] - Quake 2 Model format<br />
[[MD3]] - Quake 3: Arena Model format (3DGE only)<br />
[[MD5]] - DOOM 3 Model format (3DGE-only)<br />
[[MDL]] - Half-Life Model format (3DGE-only)<br />

=SOUNDS=
[[OGG]] - Ogg Vorbis sound format<br />
[[WAV]] - DOOM WAV format<br />
[[MIDI]] - DOOM MIDI format<br />
[[VOC]] - ROTT VOC format<br />

=GRAPHICS=
[[JPG]]<br />
[[PNG]]<br />
[[TGA]]<br />
[[PATCH]] - DOOM's INTERNAL PATCH FORMAT
[[ROTT PATCH]] - [[Rise of the Triad]]'s PATCH FORMAT

Radius Trigger Script

2018-04-20T17:39:44Z

Corbin:

RTS ("'''Radius Trigger Script'''") is the scripting language invented by [[DOSDoom]] and greatly expanded upon in [[3DGE]]. It was the first such scripting language to be implemented in any source port.

=Introduction=
RTS is not intended to replace [[DDF]], but accents and enhances DDF. Using both DDF and RTS together, you can create amazing events that even Quake 2 is not capable of.

With RTS, you can create scripted events that cannot be controlled by [[linedef]] triggers alone, such as a simple on-screen tip message, multiple [[linetypes]] being triggered by one switch, or a complex event where an entire structure is destroyed, monsters are spawned, sounds are played, and light levels are changed dramatically.

Somewhat more technically defined, a script is something a person writes in a text editor of some sort, that contains individual scripts (kind of like subroutines), commands, variable declarations, and so on. You cannot use word processor files (like "DOC" files), because these are not text files and 3DGE cannot read them.

The RTS specs were originally written by [[John Cole]] for [[DosDoom]] v[[0.64]].

=Getting Started=
This guide is still being migrated over from the old EDGE SourceForge RTS Documentation website. [http://edge.sourceforge.net/rts_online/start.htm Please visit the old site until this guide is completed].

==Some general points about RTS scripting:==

* [[#CLEAR_ALL]] (if used) must be at the top of your script, or else everything before it will be cleared.

* [[#VERSION]] and [[#DEFINE]] values (if used) must be after #CLEARALL, but before the rest of your script

* You must place all your radius triggers between [[START_MAP]] and [[END_MAP]].

* All other commands can only exist between [[RADIUS_TRIGGER]] (or [[RECT_TRIGGER]]) and [[END_RADIUS_TRIGGER]].

* '''Commands are not case sensitive''', hence "start_map", "Start_Map" and "START_MAP" are all acceptable. Whether you use lowercase or uppercase is just a matter of personal taste.

You can include comments (text which will be ignored by 3DGE) by simply placing a double slash "//" at the beginning of a line and then typing your text after it.

'''For example:'''
//This is a comment
//and this is another one

<div style="background: #f2e0ce; border: 2px solid #bfb1a3; padding: 0.6em; margin-top: 0.8em;">Commands in RTS scripts can be extended over two (or more) actual lines by placing the \ character at the end.
'''There must not be any spaces after the \ character, otherwise it doesn't work.'''</div>

==General Tips==

Check your spelling and values carefully, and add a few functions at a time, then test.

Just like [[DDF]] development, adding a lot of entries without testing makes it much harder to find problems. If you add a little and test often, you have less scripting to rummage through to find errors.

==Conventions==

Most RTS commands take one or more parameters. Some parameters must be given, and the remaining parameters are optional (may be left out). Throughout this documentation the following bracket styles are used:

<Name> : a compulsory parameter
[Name] : an optional parameter

[[Category:Languages]]

----
{{RTS}}

DOSDoom Team

2018-04-20T17:19:59Z

Corbin:

[[File:DOSDoomlogo.png|thumb]]

The [[DOSDoom]] Team, headed by [[Andrew Baker]], took over for [[Chi Hoang]] and continued development of the port, until version [[0.653]] was released in 1999, when it was decided to change the name to [[EDGE]].

The DOSDoom Team:
* [[Chi Hoang]] : programming
* [[Andrew Baker]] (darkknight): programming
* [[Kester Maddock]] : programming
* [[Martin Howe]] : programming, cat lover
* [[John Cole]]: programming
* [[Rasem Brsiq]]: programming
* [[Captain Mellow]]: support, graphics
* [[CowMonster]] : support, graphics
* [[Ziggy Gnarly]]: support, graphics
* [[Sidearm Joe]]: support, graphics
* [[Matt Cooke]]: support
* [[Eric Simpson]] : support
Some team members would continue development of DOSDoom under its new name, EDGE.