home *** CD-ROM | disk | FTP | other *** search
/ WADS of WADS / WadsOfWads.1994.zip / UNSORTED / RDOOM165.ZIP / RANDOOM.MAN < prev    next >
Text File  |  1994-04-11  |  16KB  |  397 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.           RanDOOM (1)           DOOM Operating System           RanDOOM (1)
  8.  
  9.  
  10.  
  11.  
  12.           NAME
  13.                RanDOOM - A smart object placement randomization utility for
  14.                DOOM. 
  15.  
  16.           SYNOPSIS
  17.                RanDOOM [ReferenceWADfile] [-C<seed>] [-M<n>] [-W<filename>]
  18.                [-G] [-LE<j>M<k>] [-I<infile>] [-O<outfile>]
  19.  
  20.           DESCRIPTION
  21.                RanDOOM is a utility which will randomize the placement of
  22.                objects in the DOOM playfield. Additionally, RanDOOM has
  23.                some smarts about the manner in which it will randomize
  24.                things - it's designed to never leave you with a pillar
  25.                blocking the exit, or a keycard on the opposite side of the
  26.                door from where you start, or to erase all the DEATHMATCH
  27.                warp-in spots with other objects (preventing DEATHMATCH
  28.                network play), or to replace the endgame bosses with other
  29.                objects (thus preventing the completion of an episode). In
  30.                short, RanDOOM will always leave you with a playable level.
  31.                RanDOOM is also user configurable - it allows you to specify
  32.                the proportion of total objects a given object will comprise
  33.                via a customizable object weighting scheme. This allows you
  34.                to tailor RanDOOM's randomizing to your personal taste
  35.                (and/or masochism ;-).
  36.  
  37.                RanDOOM does not make any changes to your WAD files;
  38.                instead, it creates a separate Patch WAD file containing the
  39.                information for the modified levels. To run a RanDOOMized
  40.                game, simply invoke DOOM with the -file command line switch,
  41.                e.g. DOOM -file randoom.wad.
  42.  
  43.                At the end of each run, RanDOOM will append to a file called
  44.                RANDOOM.LOG in the current directory information from that
  45.                run. Currently the seed value used for the random number
  46.                generator is saved for future reference.
  47.  
  48.  
  49.           OPTIONS
  50.                Reference_WAD_file_name - Use this path to the REFERENCE WAD
  51.                file. The reference WAD file is that which accompanies your
  52.                registered copy of DOOM, normally DOOM.WAD. If no filename
  53.                is specified, DOOM.WAD in the current directory is used.
  54.  
  55.                -I<filename> - Specifies the name of a file where RanDOOM
  56.                should look for its input THINGS data. If no input file is
  57.                specified, input is taken from the reference WAD file by
  58.                default.
  59.  
  60.                                           1
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.           RanDOOM (1)           DOOM Operating System           RanDOOM (1)
  74.  
  75.  
  76.                -O<filename> - Specifies the name of a file where RanDOOM
  77.                should place its output. If no output file is specified, the
  78.                filename RANDOOM.WAD is used by default.
  79.  
  80.                -C<seed> - Use a single ASCII character as the seed value
  81.                for the pseudorandom number generator. The character is
  82.                case-sensitive, so 'K' and 'k' yield different seed values.
  83.                Alternatively, -C accepts a positive integer number
  84.                [0..65535] as the seed value. If no -C parameter is
  85.                specified, a seed value is taken based on the current system
  86.                time.
  87.  
  88.                -G - Produce a graphic display of the item randomization
  89.                process on the screen (VGA required). This switch was added
  90.                to aid in debugging the selection algorithms. You may find
  91.                it interesting to watch. 
  92.  
  93.                -M<n> - Use randomization mode n, where n is a single digit
  94.                [0-9]. Currently only three randomization modes (0, 1 and 2)
  95.                are supported. If no -M parameter is specified, mode 0 is
  96.                used by default. 
  97.  
  98.                -LE<j>M<k> - Process Episode j, Map k only, where 1 <= j <=
  99.                3, 1 <= k <= 9. Multiple -L switches may be specified on a
  100.                single command line. If no level is specified, all levels
  101.                are processed by default.
  102.  
  103.                All randomization modes attempt to avoid potential problems
  104.                which would arise if a completely random replacement of
  105.                objects were made. Such problems include immovable objects,
  106.                such as a pillar or tree root, blocking a switch or doorway;
  107.                monsters becoming "stuck in the wall" (or tangled up in each
  108.                other!) and unable to move or fight; the replacement of
  109.                player warp-in spots with other objects, preventing one or
  110.                both forms of network play; the movement of keycards or
  111.                skulls to new locations which then become inaccessible; etc.
  112.                To achieve this, RanDOOM maintains lots of data about the
  113.                objects and the DOOM level maps, such as the locations of
  114.                objects, their relative sizes in three dimensions, their
  115.                types, whether the player can move them, kill them, or pick
  116.                them up, the locations of walls, the amount of "headroom" in
  117.                a given area, and so forth. From this information, RanDOOM
  118.                is able, in most cases, to calculate whether or not a given
  119.                object will "fit" into a given location in the map without
  120.                conflicts.  
  121.  
  122.                Randomization mode 0 takes the objects currently placed on
  123.                each level and rearranges them. No objects are added,
  124.                subtracted, or replaced - if a given level contains 2 Barons
  125.  
  126.                                           2
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.           RanDOOM (1)           DOOM Operating System           RanDOOM (1)
  140.  
  141.  
  142.                of Hell, 12 Imps, 32 blue health vials, and a chainsaw, then
  143.                the modified level will also contain 2 Barons of Hell, 12
  144.                Imps, 32 blue health vials, and one chainsaw, rearranged in
  145.                random order.
  146.  
  147.                Randomization mode 1 replaces "nonessential" objects with
  148.                other randomly selected objects from the entire range of
  149.                available objects. This randomization mode may place objects
  150.                into a level which would not normally appear there, e.g. M1
  151.                may place Cacodemons in the Hangar level. Those items which
  152.                are needed to complete the level, such as keycards or level
  153.                bosses, remain in their original locations.
  154.  
  155.                Randomization mode 2 does the same things as mode 1 with the
  156.                addition of weight factors for replaceable objects. These
  157.                weights are user adjustable (via the weight file specified
  158.                using the -W switch) to allow a relative increase or
  159.                decrease in the number of a given item inserted in the game.
  160.                Thus, items with higher weights have a higher probability of
  161.                being selected. NOTE: If the -M2 switch is specified, the -W
  162.                switch (see below) must also be specified. 
  163.  
  164.                Randomization mode 3 improves on mode 2 by using a "best
  165.                fit" algortihm to approximate the item distribution
  166.                requested by the user (via the weight file) as closely as
  167.                possible. The items to be placed are sorted and placed in
  168.                order from largest to smallest. This prevents a fairly large
  169.                space which could potentially hold a larger object from
  170.                having a smaller object placed into it instead and
  171.                consequently allows optimal object placements. Because not
  172.                all items will fit into all areas without sticking or other
  173.                conflicts, the exact distribution requested may not be
  174.                possible. For example, a distribution of 100% Spider demons
  175.                would be utterly impossible to provide. As with mode 2, mode
  176.                3 requires that a valid weight file be specified on the
  177.                command line with the -W switch (described below).
  178.  
  179.                NOTE: With randomization modes 1, 2 and 3 ALL objects will
  180.                appear at ALL FOUR skill levels as well as during network
  181.                play; there will be no variation in the number or types of
  182.                objects between "Hey, Not Too Rough" and "Ultra Violence." 
  183.  
  184.                -W<filename> - Use item weight factors from file <filename>
  185.                in randomization modes 2 and 3. The weight file is a flat
  186.                ASCII text file consisting of a series of <itemname>
  187.                <weight> pairs, one pair per line. <itemname> must be one of
  188.                the predefined names listed in the sample weight file
  189.                (randoom.w), while <weight> must be a floating point value
  190.                greater than or equal to 0.0. In general, the larger the
  191.  
  192.                                           3
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.           RanDOOM (1)           DOOM Operating System           RanDOOM (1)
  206.  
  207.  
  208.                weight value, the more occurrences of that object RanDOOM
  209.                will put into the game. There are some exceptions, most
  210.                notably with the larger objects. Because RanDOOM will only
  211.                place an item if it will "fit," some hard-to-place items
  212.                will have a lower effective weight than that specified in
  213.                the weight file. Take the Spider Demon, for example. This
  214.                sucker is so large it gets stuck just about anywhere. Out of
  215.                the hundreds of available item spots, there may be only one
  216.                or two locations where the Spider would be able to function.
  217.                Thus, even though it's number may come up via the weighted
  218.                selection scheme, its placement may still be prevented. If
  219.                an object is chosen which is too large for the available
  220.                space, another item is chosen until one is found which can
  221.                be safely placed into the current location. 
  222.  
  223.                Some comments about speed: Those of you who have used
  224.                earlier versions of RanDOOM will notice that 1.52 takes
  225.                longer to process the WAD file than did its predecessors.
  226.                This is due to the fact that 1.52 does a lot more work than
  227.                earlier versions, most of it 2-D geometric calculations
  228.                (such as the distances from objects to walls for collision
  229.                detection). After trying several different approaches to the
  230.                "monster stuck in the wall" problem, the method currently
  231.                employed was the best tradeoff in terms of speed and
  232.                accuracy I've found so far. Although RanDOOM makes extensive
  233.                use of integer and fixed-point math and '386-specific
  234.                instructions to speed the many calculations, it still takes
  235.                time to run (several minutes on a 20MHz 386SX test-dog
  236.                system). Of course, any system capable of running DOOM
  237.                adequately will have absolutely no problems with RanDOOM -
  238.                it breezes right along on my 486/33. 
  239.  
  240.           EXAMPLES
  241.                RanDOOM
  242.                     Display a brief usage synopsis.
  243.  
  244.                RanDOOM -Ck -M1 -Omy.wad
  245.                     Rearrange levels using randomization mode 1 and random
  246.                     seed character 'k'. Input comes from DOOM.WAD in the
  247.                     current directory. Output is saved to MY.WAD in the
  248.                     current directory.
  249.  
  250.                RanDOOM -M0 -Inewwad.wad
  251.                     Rearrange items in the PWAD file NEWWAD.WAD using
  252.                     randomization mode 0 and random seed based on the
  253.                     system time. Output goes to RANDOOM.WAD.
  254.  
  255.                RanDOOM -M2 -Wc:\doom\randoom.w -C23456 -Onew.wad
  256.                     Rearrange levels using mode 2 with weights given in the
  257.  
  258.                                           4
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.           RanDOOM (1)           DOOM Operating System           RanDOOM (1)
  272.  
  273.  
  274.                     file "c:\doom\randoom.w" and using the integer 23456 as
  275.                     the random number seed value. Results will be written
  276.                     to file NEW.WAD.
  277.  
  278.                RanDOOM c:\doom\doom.wad -CT -G -LE1M1 -LE2M1
  279.                     Rearrange levels E1M1 and E2M1 in WAD file
  280.                     c:\doom\doom.wad using randomization mode 0, seed
  281.                     character 'T', and display the object placements
  282.                     graphically. Results will be written to file
  283.                     RANDOOM.WAD.
  284.  
  285.           NOTICES
  286.                DOOM is a registered trademark of id software. RanDOOM is
  287.                copyright 1994 ASRE. You are free to use and distribute this
  288.                software provided that no modifications are made to nor
  289.                derivative works produced from it and that no fees are
  290.                charged for its distribution or use. Although RanDOOM has
  291.                been thoroughly tested, it is not guaranteed to be
  292.                completely free of bugs. 
  293.  
  294.           ACKNOWLEDGEMENTS
  295.                The ASRE would like to acknowledge the kind assistance of
  296.                many volunteers who offered their time, effort, and
  297.                suggestions. Your input has allowed RanDOOM to continue to
  298.                improve and become an even greater benefit to DOOM players
  299.                everywhere. Special thanks to: Barry Bloom and Scott Braley
  300.                for their hard work in optimizing the size settings for the
  301.                monsters; Chris Gregg for his kind assistance in coming up
  302.                with additional items to add; and many, many others, whose
  303.                names would easily double the size of this document were I
  304.                to include them all, for suggesting improvements, new
  305.                algorithms, new features, and other enhancements. And, of
  306.                course, id Software for creating the BEST GAME EVER to grace
  307.                the screens of ISA machines.
  308.  
  309.           BUGS
  310.                I welcome your comments, suggestions, and bug reports. id
  311.                software, however, does NOT, so make sure you send your bug
  312.                reports to me, not them! Input from users like you has made
  313.                RanDOOM into the fun and useful utility you see before you
  314.                today, so don't please don't hesitate to let your virtual
  315.                voice be heard. Please email any bug reports and/or comments
  316.                to tmkk@uiuc.edu. For bug reports, please include the
  317.                following information in your message: 
  318.  
  319.                     The version of RanDOOM you're running,
  320.                     The version of DOOM you're running,
  321.                     The command line switches you used,
  322.                     The random number seed value you used,
  323.  
  324.                                           5
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.           RanDOOM (1)           DOOM Operating System           RanDOOM (1)
  338.  
  339.  
  340.                     And a description of the problem.
  341.  
  342.                The object placement algorithm may still occasionally
  343.                misplace objects, allowing them to become stuck either in a
  344.                wall or in each other. Occurrences of such sticking are now
  345.                extremely rare, especially when compared with earlier
  346.                versions of RanDOOM.
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.                                           6
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.