home *** CD-ROM | disk | FTP | other *** search
/ Doom 2 Explosion / Doom2Explosion.bin / doom2exp / programs / wsort100 / wsort.doc < prev    next >
Text File  |  1994-08-22  |  8KB  |  192 lines
  1. ───────────────────────────────────────────────────────────────────────────
  2. ───── WadSort v1.00
  3. ───────── 
  4. ───── Pwad Files Co-ordinating System for DOOM
  5. ───────────────────────────────────────────────────────────────────────────
  6.  
  7.  * Notice *
  8.  
  9.         Wadsort has been tested on my system for some time and is still 
  10.  working fine.  There are no obvious problems with Modem/Serial Play but 
  11.  I have never tested it on a network.  If anyone can kindly test it on a 
  12.  network for me or report bug(s), I will be much appreciated :-)
  13.  
  14.  
  15.  * Installation *
  16.  
  17.         Unpack the archive into any directory where you want Wsort to 
  18.  locate.  Then edit the configuration file to suit your personal needs
  19.  followed by the creation of a batch file to execute wsort recursively.  
  20.  A sample is included in the archive.
  21.  
  22.  
  23.  * Execution *
  24.  
  25.         At the command prompt, execute the batch file created earlier, 
  26.  a window will pop out replacing whatever was on the screen originally. 
  27.  This is the main window of WadSort and almost everything is gonna to 
  28.  happen here.  Select Pwad files by moving the selection bar along, in 
  29.  order to inform Wadsort which pwad file to add , press space bar to 
  30.  tag the entry.  Wadsort supports up to 27 tag entries which means that 
  31.  you can overlay the entire game of doom provided no Pwad overlaps each 
  32.  other. Searching with scroll bars will exhaust you pretty quickly when 
  33.  the number of Pwads is becoming large therefore I have equipped Wadsort 
  34.  with a searching routine and once you start working with alphabetical
  35.  keys, you will soon figure out how it works.  If you think you need 
  36.  to check the pwad up, press enter and a window will pop-up showing what 
  37.  you practically need to know, slightly more perhaps.  Once you are 
  38.  finished with your selection, proceed to the next window by pressing 
  39.  the 'F10' where you will find numerous switches for you to toggle.  
  40.  Suit yourself and press F10 again to start the game.
  41.         It will be DOOM which is communicating to you if you prefer a 
  42.  normal single-player game, otherwise it will be another pop-up window 
  43.  about serial/network stuffs.  To drop back to the previous window, 
  44.  press ESC.
  45.  
  46.  
  47.  * Handling Pwad's Archives *
  48.  
  49.         Having a lots of Pwads on a harddisk wastes precious space. A 
  50.  solution to this problem is to compress those Pwads as they can be 
  51.  compressed readily by file compressors like PKZIP, ARJ ... etc.
  52.         Wsort now supports the decompression of Pwad archives compressed
  53.  by PKZIP and ARJ only.  Wsort is not an unarchiver so you must get one
  54.  for wsort to use e.g. PKUNZIP or ARJ.  The unarchiver should be placed 
  55.  at the same directory as wsort or at any directory specified by the 
  56.  statement "PATH =" in your autoexec.bat. Once you got everything ready, 
  57.  you can proceed to the next step - Compressing Pwad files.  The file 
  58.  WSARCWAD.EXE does this for you, it'll help you to compress every Pwad 
  59.  files at the current working directory with either PKZIP or ARJ, and 
  60.  rename the file to suits Wsort's needs.  Normally you should let 
  61.  WSARCWAD.EXE does compression job for you, but there's still a chance
  62.  that you what to do it on your own.  To conquer this yourself, simply
  63.  compressed those pwad files, delete the original wad and renamed the
  64.  archive with the method demonstrated below :
  65.  
  66.      Original Wad  ->   Compressed Wad   ->   Archive for Wadsort   
  67.                                                
  68.      TOASTER.WAD   ->   TOASTER.ZIP/ARJ  ->   TOASTER.ZID/ARD
  69.                                                         ^   ^
  70.  Note that the name of the archive must be the same as the original wad
  71.  while the extension must be changed to .ZID or .ARD depending on which
  72.  archiver you are using.  In order to keep track of which Pwad containing
  73.  archive is being uncompressed, wsort creates a file called WSORT.REC
  74.  which contains a list of files to be expunged when wadsort starts again.
  75.  Finally, each archive may only contain 1 Pwad file.  That's it, a new 
  76.  feature of Wadsort.
  77.  
  78.  
  79.  * Key Summary *
  80.  
  81.    ESC      - Go back to previous window or exit to DOS.    
  82.    DEL      - Delete all tagged Pwad entries, take care.
  83.    END      - Place option bar at the last Pwad entry.
  84.    HOME     - Place option bar at the first Pwad entry.
  85.    PGUP     - Self-Explanatory.
  86.    PGDN     - Self-Explanatory.
  87.    SPACE    - Tag Pwad entries.
  88.    ENTER    - Display Information on Pwads or Tag options.
  89.    ALT-U    - Untag all tagged entries.
  90.    ALT-X    - Exit to DOS.
  91.    ALT-Q    - Exit to DOS.
  92.    ASCII (33 - 126) -
  93.         These keys are used by the searching routine mentioned earlier.
  94.  
  95.  
  96.  * Limitations *
  97.  
  98.    1, A Maximum of 1024 Pwad files.
  99.    2, A Maximum of 27 ( 9 * 3 ) tag entries.
  100.    3, A Maximum of 5 Default Pwad files.
  101.    4, Support only Comport 1 - 4 and non-standard IRQ (set in config).
  102.    5, Only the first 15 characters of DOOM Savegame's description are
  103.       displayed for selection.
  104.  
  105.  
  106.  * Tips and Hints *
  107.  
  108.    1, Turning off options like Respawn, NoMonsters ... will free up some 
  109.       spaces in the command line buffer (Max. 127).
  110.    2, Make sure that option SERPARM and IPXPARM should end with an ENTER
  111.       (strictly speaking, a CR and a LF character) .
  112.    3, With DOOM version 1.5+ , the problem of insufficient space in the 
  113.       command line buffer is eliminated.
  114.    4, It is ambiguous to tag DOOM's original Iwad so leave it alone !
  115.    5, Archives are unpacked to the directory where wads are placed.
  116.       Unpacked wad(s) will be deleted as soon as Wsort starts up again.
  117.    6, Compressed archive can only end with .ZID or .ARD otherwise it'll 
  118.       be ignored.
  119.    7, Archive may only contain 1 Pwad file, better let WSARCWAD does
  120.       everything for you.
  121.    8, Wsort will check if there's enough space for decompression.
  122.  
  123.  
  124.  * Content of Archive *
  125.  
  126.  Files included in the archive :
  127.  
  128.         Name           Description                    CRC32
  129.       ------------------------------------------------------------            
  130.         WSORT.EXE      The program body               EE3E9A2F
  131.         WSARCWAD.EXE   Compresses Pwads for wsort     BEF8547F
  132.         WSORT.CFG      Sample configuration file      --------
  133.         WSORT.DOC      You're reading it right now    --------
  134.         WADSORT.BAT    Sample batch file for Wsort    --------
  135.         FILE_ID.DIZ    File Description               --------
  136.       ------------------------------------------------------------
  137.         
  138.  
  139.  * To Contact the Author *
  140.  
  141.         If you find any bugs or have suggestions on improving the program, 
  142.  feel free to send me a message :-)
  143.      
  144.      InterNet : asp@iohk.com
  145.       FidoNet : Alexander Pau - 6:700/450
  146.        YO!Net : Alexander Pau - 7:1010/150, 7:1010/151
  147.  BBS/Data/Fax : +852 768 8990 (V.FC)
  148.         
  149.  
  150.  * Disclaimer of Warranty *      
  151.  
  152.       WadSort and all accompanying files are protected by the copyright 
  153.  law.  Modification to either the program body or accompanying files are 
  154.  forbidded without the consent of the author .  WadSort and accompanying 
  155.  files are provided as is without warranty of any kind, either expressed 
  156.  or implied, are explicitly disclaimed below. The author do not warrant, 
  157.  guarantee or make any representations regarding the use, or the results 
  158.  of the use of the program or any accompanying files.  The entire risk 
  159.  as to the results and performance of the program is assumed by the end 
  160.  user only.
  161.  
  162.  
  163.  * License *
  164.  
  165.         You may distribute this program freely only when accompanied by
  166.  all the files included in the original archive.  An adequate charge for
  167.  copying may be requested, but you must not gain a profit in the process.
  168.  
  169.  
  170.  * Bug Report/Version Information *
  171.  
  172.         ! New Feature
  173.         + Bug Fixed
  174.         - Removed Feature
  175.         * Information
  176.  
  177.  
  178.  - Version 1.00 -
  179.    
  180.    + Incorrect option pointer after removal of a Pwad file
  181.    + Wrong selection of default Pwads
  182.    + False information being displayed when processing an invalid 
  183.      wad file
  184.    ! Wsort accept extra parameters specified in the configuration
  185.      file
  186.    ! Wsort can handle compressed Wad files
  187.  
  188.  
  189.  - Version 0.99 beta -
  190.    
  191.    * Public Wide-Beta (Pre-release)
  192.