doomatic.txt

The source code of Doom legacy for windows

  --------------------------------------------------------------------------
  THIS VERSION OF DOOMATIC SUPPORTS UP TO 32 PLAYERS FOR NEW DOOM PORTS
        WITH DOOM LEGACY  (the documentation was not updated since)
  --------------------------------------------------------------------------


               ###    ###   ###   #   #   ###  ##### #  ###
               #  #  #   # #   # ##   ## #   #   #   # #   #
               #   # #   # #   # # # # # #   #   #   # #
               #   # #   # #   # #  #  # #####   #   # #
               #   # #   # #   # #     # #   #   #   # #
               #   # #   # #   # #     # #   #   #   # #   #
               ####   ###   ###  #     # #   #   #   #  ###


                   - The Automatic Deathmatch Launcher -

                     Release v1.10 - May 19, 1998
              programmed by: Denis Fabrice & Boris Pereira

                    now on Doom LEGACY website
                    HTTP://legacy.newdoom.com


  --------------------------------------------------------------------------
  send your comments, bug reports, ... to: [e-mail]
  --------------------------------------------------------------------------

Except what's new section : Last update: 11-Nov-1997.

 What's New
 **********
   1.20 :
     - added support for full join in game of legacy 1.30
       this only wotk when there is a server with at least two players
       also don't work with any linux or win32 version
     - fixed lot of little bugs
   1.10 :
     - check the date for copy the file (copy file if date are differnet)
     - added local parameter in pref menu
     - correct bug in sending file
     - up to 32 maxplayer but the server have a maxplayers attribute
     - put maxplayer in the menu normal value : 4
          put 8 for legacy 1.12 and 32 for legacy 1.20
   1.02
     - finish a unfinished feature for copy file
     - correct bug now the config is a local parmater
     - boost up file copy to 500 Kb/s
     - choose a unused socket automaticly

 INTRODUCTION
 ************

 Let me tell you something : Doomatic is a great utility!

 Before it, we were using DM, and we were playing the same ole boring map
 nearly all the time. Using PATCHES was a GREAT PAIN in the a#s.

 Worst : it was very difficult to convince other people to join our games
  because we had to copy the files and install the patches to everybody...

 !!!!  NOW DOOMATIC HAS ARRIVED AND ITS TOTALLY UTTERLY PURE HEAVEN  !!!!

 Now we are playing a lot of different maps, there's never more than five
 seconds between deathmatches (except for entering our comments into our
 demos!), and we use several EXE patches in a breeze.

 Even better : we can invite anyone to play with us, even if he/she doesnt
  have the wad files and patches. We just copy him the DOOMATIC.EXE, and
  he/she joins our game!

 Well, it should be pretty obvious by now :


                  DOOMATIC ...

                  IT's - M A G I C -

                  IT'S - A U T O M A T I C -

                  IT'S - W U N D E R B A R -

                  IT's - M E R V E I L L E U X -

                  IT's - F A N T A S T I C -

                  IT's ... DOOMATIC !


  ... but it's only for IPX network by now. We'll add TCP/IP support
  and/or modem support in the future if we receive enough feedback!


 INSTALLATION
 ************

 Just unpack the Doomatic archive into your DOOM2 directory.

 ( ! Doomatic must be run from the main directory of Doom2 )

 Skip to the 'QUICKSTART' section if you want to try Doomatic immediately.


 Quick file description:


  DOOMATIC.EXE  - the thing that we're talking about.

  DOOMATIC.CFG  - this is the default Doomatic configuration file. We have
                  provided a basic configuration file so that you can play
                  some maps of Doom2 very fast.

                  DOOMATIC will create a default configuration file if the
                  doomatic.cfg file is not found.


  LMPMAST.EXE   - I have written this program waaaaay before Doomatic,
                  because I like to keep demos, and I wanted to record
                  comments, names of the players and have some statistics
                  about my demos.

                  Now it's PURE HEAVEN since DOOMATIC simply calls LMPMAST
                  with the right options when you activate the 'record demos'
                  option of Doomatic.

                  If you have some demos in your Doom2 dir , try the
                  following:

                  LMPMAST /dir


 QUICK START
 ***********

 We have put a default configuration file with Doomatic, so that you can
 launch a game in two secs and see how cool it is!

 1. The 'master' (he chooses levels and set the options) needs DOOMATIC.EXE
    and DOOMATIC.CFG unpacked into Doom2 directory.

    The 'slaves' (who simply join the server) only need DOOMATIC.EXE.


 2. Everybody run a IPX driver, if playing under real DOS. Else, everybody
    play under Win95 (create a shortcut to DOOMATIC on your desktop, this
    will leave more memory to the program instead of using the DOS box).


 3. Everybody run DOOMATIC.


 4. In the WADLIST (window to the left), you will see WADSETS, which are
    the levels you can play.

    Press ENTER on 'hipafrag'. You have created a server!

    Everybody else (up to 4 players) press 'J' to join a server, and
    choose the newly created server (only when they see it on the right
    window).


 5. When the master sees that everybody has joined, he presses 'S' to start
    the game!

    If you have chosen 'HIPAFRAG', the 'hipafrag.wad' will be automatically
    copied over the IPX network to the other players! Cool uh?!


 Now changing the basic options like TIMER , TURBO and such is very easy:
 the keyboard shortcuts are enclosed in brackets, and displayed in diffe-
 rent colors. Just press the associated key, or click on the option.

 You might want to look at the 'QUICK OVERVIEW' section to understand the
 difference between 'Game options' and 'Wadset defaults'.


 QUICK SETUP
 ***********

 1. Enter your name by clicking on the '[N]ame' box or press 'N' key.

    Your name will be recorded into demos, and it will identify yourself
    when you create/join a server.


 2. Select your preferred player color by clicking on 'Co[l]or' or use
    'L' key.

    If multiple players chooses the same preferred color, the first to
    join will receive their color, the later to join will get the remaining
    colors.

    This means of course that the server will ALWAYS have his favorite
    color!


 3. DO NOT change the '[C]onfig' option, unless you use a particular
    configuration file for Doom which is not 'default.cfg'.

    See 'TIPS' section to know more about how '[C]onfig' can be useful.


 QUICK OVERVIEW
 **************


 Let's have a look at the windows:


 'Wadset'        : the main vertical window to the left. This is where you
                   choose a level and optional patch to play.

                   Press ENTER on a Wadset to create a server.

                   Press DELETE to delete a Wadset (after confirmation).

                   You can Duplicate, Rename, Create wadsets by using the
                   WADSET menu options (use right mouse button or ESCAPE).


 '[J]oin game'   : in this window, you will see currently active Doomatic
                   servers.

                   If a server is already started, you will see 'playing'
                   next to it. You can't join a game when it's already
                   started.

                   Press 'J' to join a server (if you see one!).


 'Game options'  : the main game options. These are general options that
                   are active whatever WADSET you choose.

                   The game options are:

                   'Record [d]emo' : activate it if you want to record demos
                                     (LMP files).
                   'T[u]rbo'       : turbo value, enter 0 to disable it.
                   '[T]imer'       : timer value, enter 0 to disable timer.


 'Wadset defaults': each WADSET has its own associated settings.

                    THIS IS A REALLY NICE FEATURE!

                    It means that you will always have the right options
                    for each map.

                    Eg: you can have 'XXX.WAD' which is at MAP02 and is
                        better using 'Old deathmatch', and No monsters.

                        you can have 'YYY.WAD' which is at MAP05, plays
                        at skill level 3, with monsters.

                    To set the options for a particular Wadset:

                     1. highlight the Wadset into the WAdset list using
                        cursor [Up] and [Down] keys (don't press Enter!)

                     2. the options for the currently highlighted wadset
                        are displayed in the 'WAdset default' window.

                     3. the WAD files are displayed in the '[W]AD list'
                        window at the bottom of the screen.

                    All the settings are saved when you quit DOOMATIC, so
                    be careful.


 QUICK TEST WADSET
 *****************

 The 'Quick test WadSet' allow you to quickly test new levels without having
 to create a WadSet for it.

     - enter the 'WadDir' mode by pressing TAB key. Check the 'WadDir' title
       at the top of the left window.
     - the WadDir window displays the current directory and the wad files.
       Browse through your dirs until and locate a wad file that you'd like
       to play.
     - set the right options in the 'Quick test WadSet' window (map number,
       skill, ...).
     - if you want to play only this wad file, check that the 'Wad list'
       window is empty, and press ENTER on the wad file.
       if you want to use more than one wad file, use the SPACEBAR key to
       add each wad file to the 'Wad list' window. Once it is done, press
       the ENTER key.
     - by pressing the ENTER key, you have created a server, you will be
       asked a name for it: people who join your game will see it in the
       Servers window.
     - wait for other players to join, and use 'S' key as usual to Start
       the game!


 HOW TO CREATE A WADSET
 **********************

 In the future we will add an 'automatic Wadset creation' which scans for
 your wad files and creates a Wadset for each one... but for now, you'll
 have to setup them more or less by hand . Let's see how!

 PLEASE NOTE!

 *   You create WadSets only for the levels that you like to play often,
     so that you can launch them in a breeze.

 *   You don't need to create a Wadset when you want to quickly test
     wad files, use the 'WadDir' mode for this (press 'TAB').

 *   Only ONE person (the 'master') need to define WadSets!
     Everybody who join your game will receive the WadSet, but it is not
     recorded into their WadSet list (it's just temporary).

 WadSets are very useful for compilations wads like 'DwangoX.wad'. Because
 you have to remember which cool map you liked is at which map number...
  with WadSets you can give a description for each cool map that you liked
 into a Wad compilation, and simply launch each map by looking at its
 description in the WadSet list.


 There is 3 ways to create a Wadset (long to read, quick to do) :

 1. EASY CREATE A WADSET FROM 'WADDIR' MODE :

    This mode is useful when you don't know exactly the name of your wads:

        - press 'TAB' if you're not in WadDir mode (look at the top of the
          left window).
        - Now you can browse through your directories using the mouse or
          keyboard (ENTER, CURSOR UP / DOWN).
        - Press SPACE to add a WAD file to the Wad list (bottom window).
        - Press SPACE again to remove a WAD file from the Wad list, or
          edit the Wad list (click on it, use 'W' key).
        - choose the settings in the 'Quick test Wadset', like Map number,
          skill...
        - Pressing 'ENTER' will create a server, like in WadSet mode.
        - Enter a description that everybody will see when joining your
          game.

    Now, suppose you liked that map, and you want to keep it into your
    WadSet list :

        Press 'INSERT' to add the 'Quick test WadSet' to the WadSet list.

    The 'Quick test WadSet' is simply a temporary WadSet for launching
    games without having to add it to your WadSet list.