DOOM 2 Mania/doomiimaniavolume1techexpresssoftware1995.iso/doommisc/waded142/waded.doc

Text File | 1994-10-10 | 18KB | 375 lines

               ───────────────────────────────
                 -= WADED =-
                  A DOOM Map Editor
               ───────────────────────────────
             Programmed by Matthew Ayres


    I've cut most of the documentation that used to be included here.  It
was all out of date and incomplete.  What's left is sort of a mess.  Better
documentation is in the works (with help from Michael Giles).  For now, this,
along with WADED.REF and DMSPEC13.TXT should be enough.


  ┌───┐────────────┐
──│ 1 │  Overview  │──────────────────────────────────────────────────────────
  └───└────────────┘

    WADED was designed to be an  easy  and  decent DOOM map editor.  It is
completely mouse controlled, and run from DOS.  The obvious goal was to  write
a  good  editor,  so  people would be able to create some good new DOOM levels
from scratch that could be distributed in small patch .WAD (PWAD) files.

    Understanding of the structure of WADs is very helpful in creating
them.  With WADED I've included the "Unofficial DOOM Specs 1.3" by Matt Fell
(DMSPEC13.TXT).  Understanding how WADED works is also important, the
WADED.REF file includes important information.  It isn't complete either, and
future versions of WADED will include better documentation and on-line help.

    Please read over the Main Functions before using WADED, you can't just
enter  a  pitch-black  forest without a flashlight.  Hopefully it shouldn't be
too hard for you get used to the interface.  Once you've fiddled with it for a
while, it's easy to use.  All  effort  has  been  taken to make WADED easy and
simple to use, but parts might not appear simple at first.

    WADED can be run from any  directory  on your hard drive.  It needs no
data  files,  nor  does  it  create  any  configuration  files.   All  WADED's
information is kept within itself.  It will attempt to locate your  main  .WAD
file, but if it can't, you'll be prompted for one.  WADED  requires  a  mouse,
VGA  video  card,  and  at  least  460k of lower memory free.

    Tired of having  to  load  Windows  to  use  a  map  editor?  Tired of
programs that are hard to figure out,  and  offer  little  ease  in  designing
levels?   Tired  of  editors  that don't use the mouse to it's fullest extent?
Tired of editors incapable of  generating  the  NODES?  Tired of reading this?
Then give WADED a try and see whatchya think.

    PLEASE!!!   REPORT  ANY  BUGS,  MISTAKES,  IDEAS,  REMARKS,  PROBLEMS,
DISLIKES, OPINIONS, COMMENTS, SUGGESTIONS, NOTES.....  TO ME IMMEDIATELY!  SEE
THE SECTION BELOW ABOUT CONTACTING ME, THANKS!


  ┌───┐──────────────────┐
──│ 2 │  Main Functions  │────────────────────────────────────────────────────
  └───└──────────────────┘

    Throughout  the  editor,  there  are many buttons (like "+" and "-" or
arrow buttons/selections).  There is  an  important mouse feature to remember.
That is,  if  you  click  the  left  mouse  button  on  one  of  these  screen
buttons/selections, it will do nothing more than that operation once.  Holding
down  the  right  mouse  button  will perform that operation until you let go.
This is handy to scroll quickly  through  a  set  of numbers or a list of wall
textures, etc.  Sometimes the right mouse button is used to increment a value
by one, and holding down both mouse buttons will perform the operation

    Another note about the mouse,  sometimes  a  middle  mouse  button  is
mentioned.   If you only have a two button mouse (like I), you can emulate the
middle mouse button by hitting both  the  left  and right mouse buttons at the
same time.

    Yet another IMPORTANT NOTE about the mouse...  If you're  just  coming
out  of Windows, the mouse cursor movement rate is set to like intervals of 8.
Some other programs do this too.   They  for some reason don't reset the mouse
upon exiting.  WADED doesn't reset the mouse, and if  it  in  that  mode,  the
mouse  will  bounce around insanely when you try to move it.  To counter this,
exit by hitting "Q", then  run  the  DOS  program  "EDIT" and exit that.  That
program will reset the mouse.  Sorry for the inconvenience that WADED  doesn't
(YET) properly reset the mouse.

    Once  WADED  is  run,  on the right edge of the screen, there are many
selections.  The  top  four  are:  THINGS,  LINEDEFS,  SECTORS,  and Draw Map.
Editing features and commands for each are listed further on in this document.
WADED starts out on the THINGS editing selection.

    Below these four selections are arrows that allow you  to  scroll  the
map  view around.  Also note that using the arrow keys on the keyboard will do
this.  Under the arrows are plus  and  minus buttons that will adjust the zoom
level of the map view.  The plus and minus keys on your keyboard will also  do
this.

    Next  the  current  X and Y coordinates are displayed.  They represent
exactly where the mouse is currently  pointing  to on the map, while the mouse
is in map view area.  Under this is the "Grid" selection button.  By  clicking
this you can toggle the grid on and off.  Grid lines are every 128 units.

    Then  come  four  more  selections:  Pick Map, Load WAD, Save WAD, and
Quit.  The "Pick Map" selection will let you select which map to edit from the
currently loaded .WAD file.  Use "Load  WAD"  to load map WAD files created by
WADED or any other map editor.  "Save WAD" obviously saves your map to  a  WAD
file, and "Quit" exits WADED.

    The  selection  windows  in the lower part of the screen, usually have
four buttons, and a list  of  items,  wall  textures, etc.  The top and bottom
buttons will scroll the list one page up and down at a time.  The  middle  two
buttons  will  scroll  the  bar  up and down one at a time.  Also note you can
select any item in the selection window by clicking on it.


  ┌───┐────────────────────────┐
──│ 4 │  Keyboard Equivalents  │──────────────────────────────────────────────
  └───└────────────────────────┘

    For those of you who  aren't  mouse  dependent (like me), here are the
keyboard equivalents of most features:

     F1  »  Edit THINGS
     F2  »  Edit LINEDEFS
     F3  »  Edit SECTORS
     F4  »  Map Drawing Utilities ("Draw Map" selection)
     F5  »  Drawing mode
     F6  »  MakeSector mode
     F7  »  SECTORS Definer
     F9  »  VERTEXES move/create/delete mode
    F10  »  LINEDEFS move/create/delete mode
    F11  »  SECTORS move/delete mode
    DEL  »  Delete currently highlighted LINEDEF
      B  »  Build NODES, SEGS, and SSECTORS
      C  »  Clean up extra VERTEXES
      F  »  Flip currently highlighted LINEDEF
      G  »  Grid toggle on/off
      I  »  Info window on statistics of current map
      L  »  Load .WAD created by WADED or other map editor
      M  »  Pick Map from currently loaded .WAD file
      Q  »  Quit WADED
      S  »  Save .WAD (and builds everything needed, NODES, etc.)
      T  »  LINEDEF two-sided toggle
      V  »  View currently select wall texture or floor/ceiling tile
      ]  »  Go to next selection in lower right selection window
      [  »  Go to previous selection in lower right selection window
      }  »  Go to next page in lower right selection window
      {  »  Go to previous page in lower right selection window
      +  »  Zoom in map
      -  »  Zoom out map
      ARROWs »  Scroll map around


  ┌───┐──────────────────────────┐
──│ 5 │  About DOOM Map Editing  │────────────────────────────────────────────
  └───└──────────────────────────┘

    Drawing and editing level maps for DOOM isn't as  easy  as  one  might
think.   A good sized, decent level can take 50 or more hours to complete.  If
you're already familiar with the basics  of  how  DOOM maps work, you can skip
this section.

    WADED has been designed so you don't have to worry about every  aspect
of  a DOOM map, yet, there are still some things that you must understand.  In
brief, they are: THINGS, LINEDEFS, and SECTORS.

    I'd highly suggest reading  over  the  "Unofficial  DOOM specs" if you
don't completely understand THINGS, LINEDEFS, and SECTORS.  The latest version
of the specs is 1.3, and is included with WADED as DMSPEC13.TXT.

    To use a map you've created with WADED or  any  other  fine  DOOM  map
editor,  simply  have  the  .WAD  file  that  the  editor creates in your DOOM
directory.  Then type "DOOM -file  filename.WAD" (without quotes of course) on
the DOS command line.  So, if you saved a level called "TEST", you'd run it by
typing "DOOM -file TEST.WAD"


  ┌────┐───────────────────┐
──│  6 │  SECTORS Definer  │──────────────────────────────────────────────────
  └────└───────────────────┘

    This feature is out of date...  please use the 'MakeSector' feature.
If for some reason it isn't working properly, or there is something special
you need to edit as far as sector definitions go, this feature is here to do
that.

    The command option "Sec Definer" stands for SECTORS Definer.  This  is
probably  one of the hardest parts to understand and actually do when creating
a map.  WADED now has two  ways  to  define SECTORS.  Hopefully with those two
ways, and with the first one improved, SECTORS defining shouldn't be  as  hard
as  it  used  to  be.   However,  keep  in mind that almost all of this SECTOR
defining can be avoided be  using  the  "Smart Draw" feature (meaning the main
purpose of the SECTORS definer should be to fix or define something the "Smart
Draw" feature couldn't handle).

    The SECTOR you're currently  defining  will  be highlighted.  To add a
LINEDEF to this current SECTOR, click on it with the left  mouse  button.   If
the LINEDEF has never been defined to a SECTOR, then the front side of it will
automatically be chosen.  Otherwise you'll be prompted as to which side of the
LINEDEF you want to become part of the currently highlighted SECTOR.


  ┌────┐───────────────────┐
──│  7 │  Authors's Notes  │──────────────────────────────────────────────────
  └────└───────────────────┘

    Well, another new version is here again!  Once again, I'm  sorry  it's
taking  so  long  to progress on WADED.  However, I don't always have all that
much time on my hands to work  on  WADED.  That, and sometimes I'm just not in
the mood for programming!

    I'm doing my best to work on it though.  With ideas from other people,
and a ton more I have in mind, you should be seeing plenty  more  versions  of
WADED.   There  just  seems to be an endless river of things to add to it, but
someday they'll all be added.   And  some  (later?)  day  all the bugs will be
gone.  But now I'm starting to dream on...

    WADED was completely programmed  by  me  (Matthew  Ayres).   The  only
information  I  have  used  in creating WADED is from the "Unofficial DOOM WAD
Specs" released by Hank Luekart and written by Matt Fell (very helpful!).  And
also I'd like to mention,  I've  obtained some information from Alistair Brown
regarding NODES, SEGS, and SSECTORS.  Of course I've gotten a few  ideas  from
other  DOOM  editors,  and  I'd  like  to thank those authors for writing such
excellent programs.   Also  thanks  everyone  else  that  has  pestered  me to
continue writing this.

    Oh yeah, for those of you who  are interested in knowing, I'm 18 years
old.  Why am I telling you this?  I don't know, it just  seems  every  time  I
read  the  documentation  to someone else's program, I would just like to know
how old the person is.  Strange isn't it?  Maybe not...  or maybe...


  ┌────┐────────────────┐
──│  8 │  Registration  │─────────────────────────────────────────────────────
  └────└────────────────┘

    Please register WADED!  If you continue to use WADED for more than two
 weeks, you are required to register it.  I can't demand that you pay, I can
only hope you're willing to help out.  Registering is what keeps up my will to
program this, it isn't always a bundle of joy.  As you could have probably
guessed, this program has taken quite a bit of my time, and I think that I
only rightfully deserve some compensation.

    Registration is only US$15.   It  entitles  you  to a personal copy of
WADED, without the beginning delay.  Your name will be placed on  the  opening
screen   in  a  graphical  font.   You  only  have  to  register  WADED  once.
Once you register, you'll be given WADEDREG.  It will register any future
version of WADED that you obtain, with your name.

    If you'd like WADED  sent  to  you  via  mail,  please add an extra $5
(making the total $20).  WADEDREG will be sent to you on a 3.5" diskette.

    Send, in an envelope, your full name and address, along with cash or
check to the address listed below.  Be sure to tell me if you  want  WADED
sent to you via mail, or if you plan on downloading the latest releases from
my BBS.  The address listed below is similar to a P.O.  Box, but from a
private company (Mail Boxes Etc.).  Please be sure that you get all the
information on the envelope correctly.

    ──────────────────────────────────────────────
        Matthew Ayres
        977 E. Stanley Blvd., Unit 349
        Livermore, CA  94550
    ──────────────────────────────────────────────

    Thanks to all those who register and I hope you enjoy WADED.


  ┌────┐───────────────────┐
──│  9 │  Acknowledgments  │──────────────────────────────────────────────────
  └────└───────────────────┘

Kirk Yokomizo (Otaku, internet: [e-mail])
    Handles  distributing  WADED  on  the  internet, and should be able to
    answer most general questions  about  WADED.   He's  also very good at
    pestering me to work on it.

Michael Giles (Dwarf, internet: [e-mail])
    Testing and pestering.  Is now working on the new documentation for
    WADED, much thanks for that!

Steve Benner (internet: [e-mail])
    Handing me long lists of bugs, both tiny and big, new ideas and
    changes that should be made to make WADED all the better.  Me want
    more, more!  Also helping Michael Giles on the new docs.

Nathan Kidney (Morgoth)
    Talks to me voice all  the  way  across the continent, to discuss bugs
    and great ideas concerning WADED.  Much thanks!

Alistair Brown (internet: [e-mail])
    Great deal of help with the NODES.  My node  generating  algorithm  is
    almost  completely  based  on information from him.  Also came up with
    some very good ideas to add.

"Unofficial DOOM Specs"
    Written  by: Matt Fell (internet: [e-mail])
    Released by: Hank Leukart (internet: [e-mail])
    Nothing was possible without these specs that explain the structure of
    the WAD file that DOOM uses.

ID Software
    Seems WADED would be completely useless if the group of people  at  ID
    Software hadn't created a great game like DOOM.

Everyone else...
    Thanks  to  all  the  original  beta  testers  of  the  early,  buggy,
    prerelease's  of WADED, and to all of those who have tested the public
    releases and reported back to me.


  ┌────┐─────────────────────┐
──│ 10 │  Upcoming Features  │────────────────────────────────────────────────
  └────└─────────────────────┘

    There really are so many you wouldn't believe me...  WADED v2.00 is
  slated to be out pretty soon, it will be a lot better.  Of course :)


  ┌────┐─────────────────────────┐
──│ 11 │  Contacting the author  │────────────────────────────────────────────
  └────└─────────────────────────┘

    I can be contacted through my BBS, or through the Internet:

    BBS:       Lithium BBS [phone]
           4 nodes, call hunting
           28.8k V.FAST support

    Internet:  [e-mail]

    IRC:       WhiteFang, usually in #doom channel ;)


  ┌────┐────────────────────────────────────────────────────┐
──│ 12 │  Distribution and where to get the latest version  │──────────────────
  └────└────────────────────────────────────────────────────┘

    The latest version of WADED can  always  be  found on my BBS, the name
and number for it are listed above.  Hopefully it will get  spread  around  on
other fine boards.  It can also be found on the Internet at:

    Address:        ftp.cdrom.com
    Directory:      /pub/doom/wad_edit/editors/

    Address:        infant2.sphs.indiana.edu
    Directory:      /pub/doom/wad_edit/editors/

    WADED  will  be always be distributed in a ZIP file, and it's filename
will always be the format  of:  WADEDxxx.ZIP  of course the "xxx" standing for
the version number (i.e.  099 means version 0.99, duh).  The files within  the
WADED archive will be: WADED.EXE, WADED.DOC, WADED.REF, WADED.HIS, README.1ST,
FILE_ID.DIZ, WADCAT05.ZIP, and DMSPEC13.TXT.  If you're going to distribute
WADED, please leave it in its original format.  Do not add nor delete any
files from the archive.  Do not tamper with or otherwise modify any of the
files.  Thanks.

    You may NOT charge any fee for distribution of WADED.  You may NOT
sell or bundle WADED with any product in a retail environment (shareware disk
distribution, CD-ROM, profit business BBS system.)  You may give WADED to your
friends, upload it to a BBS, or ftp it to another internet site, as long as
you don't charge anything for it.


  ┌────┐──────────────┐
──│ 13 │  Disclaimer  │───────────────────────────────────────────────────────
  └────└──────────────┘

    Usage of WADED is at your own risk.  Running it is at your  own  will,
and  therefore  you are completely responsible for anything that happens after
you run WADED.  Anything you do  or  create with WADED is your responsibility,
and not the author's.  Any damage caused to any  person,  computer,  software,
hardware,  company,  or  business by running WADED is your responsibility, and
not author's liability, since you have chosen to run it.

    If you don't understand these terms,  or are not sure of something, or
are afraid something bad might come of using WADED, don't  use  it.   You  are
here forewarned.

    DOOM is a registered trademark of id Software
    WADED is (c)1994 by Matthew Ayres