The EDGE Project Files

EDGE 2.0.1-RC1 README
===============================
Welcome to EDGE, the most powerful & advanced alternative DOOM engine!
This guide should serve all of your questions, as well as providing
help and support for the engine itself. If you are curious about
helping out the development of EDGE or have further questions about
using the port, please navigate to our EDGE forums @ http://tdgmods.net/smf

Website: http://edge2.sf.net
Forums: http://tdgmods.net/smf
EDGEWiki: http://3dfxdev.net/edgewiki
Github: http://github.com/3dfxdev/hyperEDGE

Discord:  https://discord.gg/tmTSDTp
{Note: Subject to ZDoom Terms and Approval: https://forum.zdoom.org/viewtopic.php?f=48&t=54921}


===============================
Archive listing:
  * edge.exe          - EDGE Executable
  * edge.epk          - EDGE EPK, version 8
  * demo-XXXX.wad      - Demos of various EDGE features
  * SDL2.dll            - Simple DirectMedia Layer, version 2.0.8
  * EDGE-Readme.txt    - This support document.
  
Important Documents:
 (these documents are found in the docs subfolder)
  * CHANGELOG.txt      - Changes between versions
  * issues.txt         - A list of known issues and bugs with EDGE
  * support.txt        - If you're having trouble, you should read this.
  * cvars.txt          - A list of all command-line switches and console CVARs.
  * TODO.txt           - A glimpse into what we have on the cutting room floor.
  * license.txt        - Standard copy of the GPL v2 License.
  * SDL-readme.txt     - Standard copy of the SDL License.

===============================
System Requirements:
  - Dual-Core Processor or higher recommended
  - x64 processors MUST support AVX extensions or EDGE will NOT run.
  - x86 processors MUST support SSE/SSE2 or EDGE will NOT run.
  
  - 2GB RAM (4GB or more recommended)
  - Hardware accelerated 3D card with OpenGL drivers (2GB recommended)
  - OpenGL 3.1 support is a requirement, even for the old path.

  - Either a DOOM, DOOM II, HACX, Heretic, or Final DOOM IWAD file.
    (See "Getting hold of game data" below).

  For Win32/Win64:
    - DirectX 9.0c or higher.
	- VS 2015/2017 Runtimes: https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads
	- Windows XP support will only work on 32-bit builds.
	- SDL2 2.0.5 or SDL2 2.0.8 

  For Linux:
    - SDL (Simple DirectMedia Layer) version 2.0.8.
    - glibc 2.

===============================
GETTING AHOLD OF GAME DATA
===============================

    You can get hold of FreeDoom from freedoom.sourceforge.net which 
    is _free_ and has been produced by fans of the game in their
    spare time, or you can purchase "The Ultimate Doom", "Doom II" or 
    "Final Doom" (Plutonia/TNT) from id software at www.idsoftware.com. 
    The shareware data will also work with EDGE. You need to copy the
    .WAD file you want to use into your EDGE directory. The wad names 
    and what game they belong to are listed below: 

    doom1.wad    -> Shareware Doom.
    doom.wad     -> Doom/Ultimate Doom.
    doom2.wad    -> Doom II
    plutonia.wad -> Final Doom (Plutonia)
    tnt.wad      -> Final Doom (TNT)
	hacx.wad     -> HACX
	heretic.wad  -> Heretic
	darkwar.wad  -> Rise of the Triad: DarkWar

===============================
USEFUL PARAMETERS
===============================
Sometimes knowing a little is better than not knowing at all, but the same could be said otherwise.
Look here for various useful command-line options - if your game does not start after modifying
these switches, it is recommended you delete the EDGE2.CFG file, as these values are written into
it anytime something is changed. If it's not starting, you now know what to do!

  * Screen size: -width [screenwidth] -height [screenheight]
     (Sets the current screen size. This is also an option in the engine itself.)
  * Colour depth: -bpp [depth]  (2 for 16-bit, 4 for 32-bit)
     (Sets Color Depth. Usually handled by Windows at runtime.)
  * Windowed mode: -windowed
     (Play EDGE in a window!)
  * Fullscreen mode: -fullscreen
     (Play EDGE fullscreen! This is the default mode.)
  * Pick IWAD file: -iwad [main wad file]
     (Pick an IWAD to play - there is also a hidden feature in the engine - if you put Doom2.wad and Doom.wad in your EDGE directory, start up EDGE with the command-line parameter -iwad doom2.wad -file doom.wad. EDGE will combine both together
	 and allow you to play both games at the same time! This will also work subbing out doom2.wad with tnt or plutonia.
  * Play PWAD file: -file [addon wad file]
     (Plays a PWAD from a directory. EDGE also supports "Drag-and-Drop".)
  * Jump to level: -warp [mapname]  (in the form of MAP01 or E2M9 etc..) 
     (Warps you to desired level. Also functions in the CONSOLE and via cheat code in game.)
  * External DDFs: -ddf [dirname]  (use external DDFs in 'dirname')
     (Quite useful for modmakers, or those with multiple EDGE mods in the base dir. Specifies
	 where the engine should look for the DDFs. Default directory is "doom_ddf".)
  * Show EDGE version: -version
  * Disable sound: -nosound
  * Disable music: -nomusic
  * Disable warnings: -nowarn
  
There is a complete list of parameters in the EDGE-CVARS.txt document.

===============================
NOTEABLE ENGINE FEATURES
===============================
Because we like to flaunt them too, alright!? EDGE comes with various special features
that greatly enhance the gameplay/environment/modifications over the vanilla DOOM exe. 
Here's a short list of features we provide:

  - Extrafloors (3D floors), removing the original DOOM limitation
    which didn't allow rooms over rooms.  EDGE supports real 3D
    room-over-room, bridges, and liquids via OpenGL acceleration.

  - DDF (Data Definition Files), allow Mod/TC/PC creators to
    completely customise monsters, attacks, weapons, pickup and
    scenery items, linetypes, sectortypes, intermissions, ETC...
    using fairly simple to understand text files.

  - RTS (Radius Trigger Scripting), provides per-level scripting
    support, allowing custom scripts to run when the player enters
    certain parts of the map, or performs certain actions, or when
    certain monsters have been killed (to name a few possibilities).
	
	COAL virtual-machine language for HUD and player interactions!

  - Hardware accelerated 3D rendering (via OpenGL), along with a
    good amount of customization options. Feast your eyes on what
	we think is the most stable-rated OpenGL rendering amongst
	DOOM engines!

  - Hub system, like in Quake II or Hexen, which allows you to
    come back to a certain map and everything is the same as when
    you left it, plus you get your weapons and keys. Very cool -
	documentation for this feature is available via the EDGE forums.
	
  - Splitscreen Local Multiplayer, finally breathing some form of
    life into EDGE - take on a partner in furious Deathmatch or take
	them along for a Cooperative adventure - the choice is yours! Come
	on, you know you want to load up Don's Challenge... ;)

  - MD2 and MD3 support for monsters, items, special effects, weapons...
    whatever else you can think of! (hint: architecture...)

  - Jumping and Crouching.
  
  - Look up/down and Zooming.
  
  - Flying (JetPack) and Swimmable water.

  - Many limits and bugs from original DOOM removed, as well as various
    bugfixes from the EDGE parent code.

===============================
NOTE ABOUT MUSIC SUPPORT IN EDGE
===============================
Alright, we'll admit - Music Support has always been a craft issue in
EDGE, but we can do our best to help. 

*If you have Windows Vista or 7, you will need to follow 
the instructions beforehand to get set up. Microsoft changed the way Windows
handles MIDI beginning with Vista so the standard playback method no
longer becomes supported. Any XP users out there? You're covered, no need
to grab these sets, though you theoretically *can* if you're music whores
like us! ;)

By default, OPL is set as the default music playback system on all operating
systems! 

Below is a short explanation of Timidity,
a platform we use for enabling DOOM music in Linux and Win32.
===============================
    Timidity is a program for playing MIDI music, and EDGE includes
    a built-in version of it.  For Linux users this is the only
    way to hear DOOM format music, but Windows users can use it too
    (see the Music Device entry in the Sound Options menu). As stated
	above, if you have Vista or 7 you *must* select Timidity.

    Timidity requires "GUS Patch" files to work, which are special
    sound data for musical instruments.  Under Linux you can simply
    install the 'freepats' package and it should work.  
	
	For Windows users, starting with version 1.36F, the patchets are
	already installed and ready-for-use. They are located in the folder
	named 8MBGMPAT. You can swap these patchsets out for anything else,
	such as EAWPATS. If you still don't hear music, make sure Timidity is
	selected from the OPTIONS menu as the default Music device, and make
	sure you haven't deleted the 8MBGMPAT folder.
	
	Run EDGE and the following
	messages should appear in the console:

    >  Loading Timidity config: ./8mbgmpat/TIMIDITY.CFG
    >  I_StartupMusic: Timidity Init OK
     
	If you can't see it, open the EDGE2.LOG file in your EDGE
	directory - this is the console output. There is another
	file called DEBUG, but it usually isn't necessary unless
	reporting bugs or finding serious problems with mods.

NOTE: SoundFonts (SF2 files) are different from GUS patch files
      and are NOT supported by EDGE.
===============================

------------------------------------------------------------------------

For Changes, please see the file "CHANGELOG"

Contact points:
  * For the latest news and developments visit the EDGE Website
    at http://edge2.sourceforge.net

  * For Forums, Bug Reports and SVN Access visit the EDGE Project
    site at http://tdgmods.net/smf

  * For more information on "GL Nodes", see the glBSP homepage at
    http://glbsp.sourceforge.net


Compiling EDGE:
  Please read the file "INSTALL" in the source package.




**** CREDITS ****

See AUTHORS.md for full list of credits.


--- END OF README.TXT ---