home *** CD-ROM | disk | FTP | other *** search
/ DeathMatch for Doom 1 & 2 / DeathMatch.bin / other / alfred.txt < prev    next >
Text File  |  1994-03-24  |  16KB  |  351 lines
  1.      A L F R E D -  THE AUTOMATIC LMP FILE RECORDER AND DEVELOPER v1.2
  2.  
  3.                              INSTRUCTION MANUAL
  4.                                   03/12/94
  5.  
  6. ================
  7. [1] INTRODUCTION
  8. ================
  9.  
  10. The Automatic Lmp File REcorder and Developer (ALFRED) is a very handy
  11. utility to simplfy the recording, viewing and storing of the many .LMPs one
  12. may collect over time. It automatically looks for the chosen .LMP file in the
  13. seven .LMP directories, and will act accordingly for .LMPs that were made with
  14. RANDOOM .W or PWAD .wad files.
  15.  
  16. The program was simple enough to be written in the DOS batch language, which
  17. has one major advantage- practically ANYONE can change the way it works to
  18. suit whatever needs they want. If you don't like the way it works, FIX IT
  19. YOURSELF! 
  20.  
  21. Please read ALL of this document, since some things mentioned early in this
  22. document may only be explained in later sections (RanDOOM & PWAD .LMPs).
  23.  
  24.  
  25. ============
  26. [2] FEATURES
  27. ============
  28.  
  29. ALFRED has been designed to record and play many different types of .LMPs
  30. quickly and efficiently. ALFRED can currently do the following:
  31.  
  32.   -     Record regular .LMPs from any episode, map, and skill through 
  33.         user-friendly prompts.
  34.  
  35.   -     Play .LMPs from other directories, which avoids cluttering up your
  36.         DOOM directory with .LMPs.
  37.  
  38.   -     Display introductory text files before the .LMP is played. Very 
  39.         handy for remembering what each .LMP is about.
  40.  
  41.   -     Play and record .LMPs made with a RanDOOM configuration. All you need
  42.         to provide is the weight file and the character seed, and ALFRED
  43.         will take care of the rest.
  44.  
  45.   -     Creates (from a Blank template) or edits introductory text files and
  46.         RanDOOM weight files using the MS-DOS editor.
  47.  
  48.   -     Play and record .LMPs made with different PWAD files. 
  49.         
  50. As with most programmers, however, I have the nasty habit of always 
  51. adding "just one more" feature. There's always room for improvment, and in 
  52. the future I plan to add the following:
  53.  
  54.   -   Recording Multiplayer .LMPs (if possible).
  55.   -   Automatic compression and uncompression of .LMPs using .zip files.
  56.   -   Slideshow feature. 
  57.   -   Full screen, frame-by-frame .LMP editor, allowing you to pause,
  58.       rewind and fast-forward an .LMP -- NOT! (Still, I wonder if that could
  59.       be done in a batch file? Hmmm...)
  60.  
  61. Programming Gurus please note: ALFRED was originally just a 5 line batch file 
  62. designed just to play an .LMP, but as you can see things sorta got out of 
  63. hand. Since the program is a batch file, you've been given the chance to see 
  64. how much my code looks like pasta. Please, no comments. I already know you 
  65. can do better. I am in no way a professional programmer, and if I was, I'd 
  66. be working for ID software. 
  67.  
  68.  
  69. ==============================
  70. [3] ALFRED'S FILE ORGANIZATION
  71. ==============================
  72.  
  73. Because of the large amount of .LMP files one can collect over time, ALFRED 
  74. has been designed to group them into seven separate directories (in the LMP 
  75. directory), named as follows:
  76.  
  77.    HALL         :   Hall of Fame .LMPs
  78.    LEVELS       :   .LMPs of every level
  79.    MISC         :   Strange and/or weird miscellaneous .LMPs
  80.    MULTIPLR     :   Multiplayer .LMPs (none found yet - sorry!)
  81.    NITEMARE     :   NIGHTMARE! .LMPs
  82.    PWAD         :   PWAD .LMPs and their respective .wad pwad files.
  83.    RANDOOM      :   RanDOOM .LMPs with their respective .W weight files.
  84.  
  85. (NOTE: whenever I mention 'the seven directories' later on in the document, 
  86.  I am referring to those above)
  87.  
  88. ALFRED will ONLY look for .LMPs in these seven directories. If you want 
  89. ALFRED to play your old .LMPs you will either have to copy them into any of
  90. these directories, or modify the LMP.BAT to make ALFRED look elsewhere. When 
  91. recording an .LMP with ALFRED, you will be asked what directory you wish the 
  92. .LMP to be stored in. Once the .LMP is recorded, it will be moved to the 
  93. chosen directory. NOTE: RanDOOM and PWAD .LMPs will automatically be stored 
  94. in their respective directories. 
  95.  
  96. Right now ALFRED, called LMP.BAT ('ALFRED' is too long to type, ok?), is 
  97. configured to run in your DOOM directory, and assumes to have the LMP 
  98. directory (and its seven subdirectories) in the DOOM directory as well. Once 
  99. again, being a batch file, ALFRED can be edited and changed to look elsewhere. 
  100.  
  101.  
  102. ==========================
  103. [4] PARAMETER DESCRIPTIONS
  104. ==========================
  105.  
  106. ALFRED has several parameters, some of which must be executed in order. 
  107. The general usage is as follows:
  108.  
  109.               LMP [r|w|t|p] lmpfile [pwadfile|seed]
  110.  
  111. Please note:
  112.                 - No extensions (.lmp, .w, .txt, .wad) are necessary.
  113.                 - typing LMP LIST will get a directory of all the .LMP files
  114.                   in the seven directories.
  115.  
  116. Descriptions:
  117.  
  118. lmpfile :  Could be either lmpfile.lmp, lmpfile.w or lmpfile.txt 
  119.  
  120.   r     :  Record an .LMP. If a 3rd parameter is given, it is assumed to be
  121.            a pwad file. If the pwad file is not in the WADS directory, 
  122.            ALFRED will ask if the 3rd parameter was intended to be the seed
  123.            of a RanDOOM .LMP.
  124.  
  125.   w     :  Create/edit RanDOOM .W file as lmpfile.w from a template. It looks
  126.            for and saves these files in the LMP\RANDOOM directory.
  127.  
  128.   t     :  Create/edit introductory text file as lmpfile.txt. ALFRED will 
  129.            check the seven directories for a corresponding lmpfile.lmp, and
  130.            if it does not find any, ALFRED will ask where to put it.
  131.  
  132.   p     :  Plays DOOM according to a RanDOOM .W file lmpfile.w and a 
  133.            random seed (no .LMPs played or recorded).
  134.  
  135. pwadfile:  If ALFRED discovers a second parameter (or third parameter when
  136.            recording) as pwadfile, it will first check to see if pwadfile.wad 
  137.            exists in the WADS directory. If it could not find pwadfile.wad,
  138.            then ALFRED will ask if it was intended to be a RanDOOM seed.
  139.  
  140.   seed  :  If playing or recording a RanDOOM .LMP, then a seed must be
  141.            provided as the 3rd parameter.
  142.  
  143.  
  144. ============
  145. [5] EXAMPLES
  146. ============
  147.  
  148. The best way to explain how to use ALFRED is by examples. Listed below is
  149. just about all the possible ways of using ALFRED:
  150.  
  151. lmp                     Typing 'lmp' without parameters will get a
  152.                         help screen.
  153.  
  154. lmp list                Displays a list of all .LMPs in any of the seven
  155.                         directories (HALL, LEVELS, MISC, MULTIPLR, NITEMARE,
  156.                         PWAD, RANDOOM)
  157.  
  158. lmp lmpfile             Searches for lmpfile.lmp in the seven directories
  159.                         and plays it. NOTE: For RanDOOM lmps, you must
  160.                         provide a seed as a second parameter.
  161.  
  162. lmp lmpfile pwadfile    Plays lmpfile.lmp with pwadfile.wad. If lmpfile and
  163.                         pwadfile have the same name, then no second parameter
  164.                         need be given.
  165.                         
  166. lmp lmpfile c           Plays lmpfile.lmp from the LMP\RANDOOM directory with
  167.                         seed 'c'. NOTE: you must also have lmpfile.w and 
  168.                         lmpfile.txt in the LMP\RANDOOM directory in order to 
  169.                         view it.
  170.  
  171. lmp r lmpfile           Records a DOOM session under lmpfile.lmp, and
  172.                         will prompt for directory, episode, level and
  173.                         skill.
  174.  
  175. lmp r lmpfile pwadfile  Records lmpfile.lmp using pwadfile.wad as a PWAD
  176.                         file. Since it is a PWAD .LMP, it will be placed in
  177.                         the LMP\PWAD directory automatically.
  178.  
  179. lmp r lmpfile c         Records a DOOM session under lmpfile.lmp as
  180.                         a RanDOOM .LMP, with seed 'c'. Will prompt for 
  181.                         episode, level and skill. NOTE: you must have 
  182.                         created a lmpfile.w weight file beforehand in the 
  183.                         \LMP\RANDOOM directory. 
  184.  
  185. lmp w wfile             Creates a new RanDOOM .w file, using a basic template, 
  186.