hyper3DGE Project Files

3DGE 1.36 README
===============================
Welcome to 3DGE, 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 3DGE or have further questions about
using the port, please navigate to our 3DGE forums @ http://tdgmods.net/smf

Website: http://edge2.sf.net
Forums: http://tdgmods.net/smf
EDGE site: http://edge.sourceforge.net

===============================
Archive listing:
  * edge2.exe          - 3DGE Executable
  * edge2.wad          - EDGE2 WAD, version 7
  * demo-XXXX.wad      - Demos of various 3DGE features
  * SDL.dll            - Simple DirectMedia Layer, version 1.2.13
  * 3DGE-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 3DGE
  * 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:
  - Pentium-class 800 MHz CPU or faster (1.2 GHz recommended for modern modifications).
  - 128MB RAM (512MB RAM recommended).
  - Hardware accelerated 3D card with OpenGL drivers.

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

  For Win32:
    - DirectX 7.0 or higher.

  For Linux:
    - SDL (Simple DirectMedia Layer) version 1.2.
    - 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 3DGE. You need to copy the
    .WAD file you want to use into your 3DGE 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

===============================
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 3DGE in a window!)
  * Fullscreen mode: -fullscreen
     (Play 3DGE 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 all of the
	  supported IWADS in your 3DGE directory, they will show up in the NEW GAME, SELECT EPISODE
	  listing! No need to set this option!)
  * Play PWAD file: -file [addon wad file]
     (Plays a PWAD from a directory. 3DGE 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 3DGE version: -version
  * Disable sound: -nosound
  * Disable music: -nomusic
  * Disable warnings: -nowarn
  
There is a complete list of parameters in the 3DGE-CVARS.txt document.

===============================
NOTEABLE ENGINE FEATURES
===============================
Because we like to flaunt them too, alright!? 3DGE 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.  3DGE 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).

  - 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 3DGE - 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 3DGE
===============================
Alright, we'll admit - Music Support has always been a craft issue in
EDGE and 3DGE is no different! Below is a short explanation of Timidity,
a platform we use for enabling DOOM music in Linux. 

*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! ;)

===============================
    Timidity is a program for playing MIDI music, and 3DGE 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.  Otherwise
    a good quality patchset can be found in the idgames archive:
    search for "8mbgmpat", download the zip, navigate to where
    3DGE is installed, and unpack the files into the "8mbgmpat"
	folder (which will be empty).  Run 3DGE 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 3DGE
	directory - this is the console output. There is another
	file called DEBUG, but it usually isn't neccesary unless
	reporting bugs or finding serious problems with mods.

NOTE: SoundFonts (SF2 files) are different from GUS patch files
      and are NOT supported by 3DGE. I know, we wish they were too.
===============================

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

For Changes, please see the file "CHANGELOG"

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

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

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


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




**** CREDITS ****

Current 3DGE Team:
    Corbin Annis                     : programming, support & documentation
	Maceij Kadlubowski               : OpenGL Programming
	Chilly Whilly                    : SEGA/PowerVR Programming

Former EDGE Team:
    Andrew Apted (aka "andrewj")     : programming
    Luke Brennan (aka "Lobo")        : support & documentation
    Andrew Baker (aka "Darkknight")  : programming
    Marc Pullen  (aka "Fanatic")     : support & music
    Erik Sandberg                    : programming
    David Leatherdale                : support & programming

Patches:
    Darren Salt  (aka "dsalt")       : programming

DOSDoom Contributors:
    Kester Maddock                   : programming
    Martin Howe                      : programming, cat lover
    John Cole, Rasem Brsiq           : programming
    Captain Mellow, CowMonster       : support, graphics
    Ziggy Gnarly & Sidearm Joe       : support, graphics
    Matt Cooke, Eric Simpson         : support

Special Thanks:
    Chi Hoang                        : DOSDoom Author
    id Software                      : The Original Doom Engine


--- END OF README.TXT ---