home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 615a.lha / DungeonMap_v1.0 / DungeonMap.doc.pp / DungeonMap.doc
Text File  |  1992-03-03  |  12KB  |  292 lines
  1.                         DungeonMap
  2.                         ==========
  3.  
  4. A Programmer's Plea
  5. -------------------
  6.  
  7.   SID is shareware.  If you find this program useful, please send $ to:
  8.  
  9.       Bill Elliot
  10.       727 94 Ave SW.,
  11.       Calgary, Alberta
  12.       T2V 0X8
  13.  
  14.   Some suggested amounts are as follows:
  15.  
  16.        $5 - You like the software
  17.       $10 - You like the software, and would like a copy of the next upgrade.
  18.       $25 - You like the software, and would like a copy of the next upgrade
  19.             and a copy of the source.
  20.  
  21.       If outside Canada and the US, and are choosing the $10 or $25 option,
  22.       please add an extra $4 for the extra international postage & handling.
  23.  
  24.   Even if you think that DungeonMap is terrible, I would appreciate a letter 
  25.   giving me CONSTRUCTIVE ideas on how I can improve it.
  26.  
  27.   Please promote the shareware system by making a contribution to the authors
  28.   of the shareware products you commonly use.  There are many advantages to
  29.   the shareware system:
  30.  
  31.       -- You can receive quality programs at a decent price.  Had this been
  32.          a commercial program, you could expect to pay at least $19.95.
  33.  
  34.       -- You can thoroughly examine a shareware program before reimbursing
  35.          the author.  Once you've purchased a commercial program, however,
  36.          you're stuck with it.
  37.  
  38.       -- You promote the creation of a number of exciting and diverse
  39.          programs that would otherwise not reach the public if commercial
  40.          marketing was the only alternative.
  41.  
  42.   Along with your $, please send your name, address, and the version number
  43.   of DungeonMap that you are currently using.  This can be found by displaying
  44.   the Information requester located in the Program menu.
  45.  
  46.  
  47. Disclaimer
  48. ----------
  49.  
  50.   DungeonMap is provided "AS IS" without warranty of any kind, either expressed
  51.   or implied.  By using DungeonMap, you agree to accept the entire risk as to
  52.   the quality and performance of the program.  Bill Elliot will not accept any
  53.   liability for this product.
  54.  
  55.  
  56. Legal Bits...
  57. -------------
  58.  
  59.   Now, for the legal stuff.  You don't need to read this unless you plan on
  60.   uploading, distributing, marketing, or stealing DungeonMap...
  61.  
  62.   DungeonMap is © Copyright 1992 by Bill Elliot
  63.     All Rights are Reserved Worldwide
  64.  
  65.   DungeonMap is freely distributable as long as all of the following 
  66.   conditions are met:
  67.  
  68.       1) All of the files must be included in their original form without
  69.          additions, deletions, or modifications of any kind.  Any such
  70.          modifications must appear in separate files.
  71.  
  72.       2) All copyright notices must remain intact.
  73.  
  74.       3) DungeonMap may not be sold commercially alone or as a component in
  75.          another product.
  76.  
  77.       4) DungeonMap may not appear on shareware or public domain disks for
  78.          which the consumers are charged more than a nominal disk copying fee
  79.          of seven dollars (US $7) per disk.
  80.  
  81.       5) DungeonMap may not appear on any electronic service which charges 
  82.          more than the basic access fee to download DungeonMap.
  83.  
  84.       6) DungeonMap may not appear on any electronic service that claims
  85.          copyrights to uploaded programs, either alone or as part of a
  86.          collection.
  87.  
  88.   If you would like a variance to any of the above conditions, please contact
  89.   me for written permission.
  90.  
  91.   Now, on to DungeonMap (IE. What your really reading this for)...
  92.  
  93.  
  94. Software Requirements
  95. ---------------------
  96.  
  97.   This software was written and tested on AmigaDos versions 1.3 and 2.0. So
  98.   it should run on most machines. It has not been tested with ENFORCER, as I
  99.   don't have an MMU (If any one does test it with ENFORCER and finds a 
  100.   problem, please drop me a note and tell me).
  101.  
  102.   DungeonMap uses the REQ.LIBRARY. Since I hate getting shareware software
  103.   that requires some special library and does not include it, I have included
  104.   the library and a routine to install the library for those that don't have
  105.   REQ.LIBRARY. Future releases may not need this library, as I intend to
  106.   convert over to use the new ASL.LIBRARY of AmigaDos 2.0 (once I get some 
  107.   docs on using the new routines of AmigaDos 2.0).
  108.  
  109.  
  110. Using DungeonMap
  111. ----------------
  112.   DungeonMap is intended to be used as an aid to Dungeon Masters (DM's) for
  113.   creating dungeons (and eventually towns) for use in Dungeons & Dragons
  114.   (D&D).  But, you can use it for what ever you like. The legend says "Door"
  115.   and "Arch".  But, these can be interpreted any way you please (Eg. Door's
  116.   could be locked or secret doors, and Arch's could be open or unlocked
  117.   doors). Just use your imagination.  For the most part the program is self
  118.   explanitory.  I'll just cover some of the more subtle points/features.
  119.  
  120.   Loading Saved Maps...
  121.   
  122.     DungeonMap will first look for a directory (in what ever directory you
  123.     ran DungeonMap from) called DATA.  If DATA is found DungeonMap will 
  124.     display the files in this directory. Otherwise, it will display the files
  125.     in the current directory. NOTE: All files saved by DungeonMap are forced
  126.     to have a suffix of ".DAT". Therefore, only files ending in ".DAT" are 
  127.     displayed.  This helps save some time scrolling through other unrelated
  128.     files.
  129.  
  130.     As the dungeon data is loaded, messages are displayed in the drag bar
  131.     after every 100 nodes are loaded.  This gives you some idea of what is 
  132.     happening during those long loads (Eg. a 1400 node map).
  133.  
  134.   Saving Maps...
  135.  
  136.     The same proceedure as above is used for selecting which directory to
  137.     display files from.  But, this selection process is only for the first
  138.     save or load.  The requester will keep the directory you may change it
  139.     to (at least till you quite the program).
  140.  
  141.   Creating new dungeons...
  142.  
  143.     This is really what you're here for.  You will be presented with a 
  144.     requester which asks how about the size of dungeon to create and how you
  145.     want it created. (IE. What proportion of the exits will be OPEN, WALLS,
  146.     DOORS, and ARCHS).  Just a warning on size.  I would not try anything 
  147.     larger than say 1400 nodes.  Even this will take a very long time.  The
  148.     current method for finding undefined nodes is not the best and will have
  149.     problems once the 2 sides of the display area are all used up.
  150.     
  151.     If you get tired of waiting for the dungeon to be completed, or you have
  152.     enough dungeon created, then the process can be stopped.  Just select the
  153.     NEW option again.  You will notice that the while creating a maze the
  154.     NEW option will read "STOP MAZE".
  155.     
  156.     There are a few of messages you wll see displayed in the drag bar, while
  157.     the maze is being created. They, and their meanings are as follows:
  158.     
  159.       "Creating maze of xxx nodes. yyy nodes created."
  160.       
  161.       This is just a progress report saying that xxx nodes of the requested
  162.       yyy nodes have been created. You will also see the maze being drawn as
  163.       it is created.
  164.       
  165.       "Searching maze for UNDEFINED exit..."
  166.       
  167.       As the maze is created, the computer is wandering around the maze 
  168.       looking for undefined exits from defined nodes. If no undefined exits
  169.       are found randomly, it will simply stop, display this message, and then
  170.       do a sequential search of all defined nodes looking for an undefined
  171.       exit.  Then it will continue with the maze creation.
  172.       
  173.       "Choosing a new start point for maze generation..."
  174.       
  175.       If the above search for an undefined exit finds that there are none,
  176.       a new one is created at random on one of the two sides. Then the
  177.       dungeon creation will continue from there.
  178.  
  179.   Editing the maze...
  180.   
  181.     Just click the mouse close to a wall, door, arch, or opening to change it
  182.     to the item selected under menu item "Change to". The selection process
  183.     looks at each node like it had a diagonal cross through it, and selects
  184.     the exit from the node that it is in. This is easier to visualize with a
  185.     picture. So....
  186.     
  187.                   Exit
  188.                +--------+
  189.                |\      /|
  190.                | \    / | <------- Entire square is a node on the map.
  191.                |  \  /  |
  192.          Exit  |   \/   |  Exit
  193.                |   /\   |
  194.                |  /  \  |
  195.                | /    \ |
  196.                |/      \|
  197.                +--------+
  198.                   Exit
  199.  
  200.     If you try to create an exit on an undefined node, the node will be made
  201.     defined (IE, turned grey).  If this was an accident and you want the node
  202.     to be undefined (IE. white), then just select "Change to - Undefined" and
  203.     click the mouse anywhere on the node.
  204.  
  205.   Printing the maze...
  206.   
  207.     While the dungeon map is being printed, you sometimes want to cancel the
  208.     printout.  This could be because you chose the option by accident or
  209.     because it is taking too long (due to the print density chosen).  Well,
  210.     this is no problem.  While a dungeon is printing the print option will
  211.     read "STOP PRINT".  Just select this option again and the print will be
  212.     stopped.  This should happen immediately.  The only output that should 
  213.     still be printed is just what is already in the printers internal buffer.
  214.     
  215.     The printing controls for DungeonMap are all controlled via your 
  216.     preferences (set through Workbench). Note: that B/W gives a much better
  217.     print out over grey scale, and that density 2 is usually good enough.
  218.     
  219.   Choosing a maze type...
  220.  
  221.     This is a dummy menu option for now.  It is going to be active in a 
  222.     future release.  See future plans below.
  223.  
  224.   Exiting from DungeonMap...
  225.   
  226.     If you are printing, creating a new maze, or haven't saved your most
  227.     recent creation/change, them you will be told this, and asked what you
  228.     wish to do about it.  I believe in graceful exits.
  229.  
  230.  
  231. Future Plans for DungeonMap
  232. ---------------------------
  233.  
  234.   I have a lot I would like to do with DungeonMap.  The following are a few
  235.   of my ideas and a rough grouping of them into releases.  This is only
  236.   tentative.  So if you would like to see an option sooner, or have any
  237.   other ideas, just drop me a note and I'll see what I can do.
  238.   
  239.   V1.0
  240.     - This release.
  241.  
  242.   V1.1
  243.     - Creation of town type mazes with streets, buildings, and town squares.
  244.     - Allow background printing of one maze while the next is being created.
  245.     - Improve the speed and quality of the creation method.
  246.  
  247.   V1.2
  248.     - Allow the random creation and editing of encounters in dungeons & towns.
  249.          These encounter decriptions will be able to be specified by the user
  250.          & the user will be able to specify a maximum number of occurances in
  251.          the map.
  252.     - Create Icons for data files, and allow starting of DungeonMap from the
  253.          Icon.
  254.     - Save the configuration options in the program Icon.
  255.  
  256.   V2.0
  257.     - Convert to ADos 2.0 ASL.LIBRARY from REQ.LIBRARY.
  258.     - Allow for mazes which are larger than a single screen. This will 
  259.          require the ability to scroll the maze on the screen.
  260.     - Convert appearance to conform to 2.0 look and feel. Some of this will
  261.          be done throughout the prior releases. But, this will be a complete
  262.          review to ensure it conforms to the Amiga Style Guide.
  263.    
  264.  
  265. Another Way to Contact Me + An Ad
  266. ---------------------------------
  267.  
  268.   I am also on the Amiga Users of Calgary (AMUC) bulletin board on a fairly
  269.   regular basis. This is the first BBS to use the full power of the Amiga's
  270.   ability to multitask.  Some of it's features are:
  271.   
  272.       - It has a mouse and pull-down menu driven interface.
  273.       - A 2.0 look and feel.
  274.       - Can download, upload, read your messages, take part in an on-line
  275.         conference ALL AT THE SAME TIME.
  276.       - While a file is downloading, and you see another file you want, you
  277.         can just add it to the list to be downloaded.
  278.       - There are already 2 offline readers available for it, with the
  279.         ability to do offline responding.
  280.  
  281.   You can use a regular ASCI terminal package to access the BBS initially to
  282.   get a copy of the special required terminal package. This term package is
  283.   what gives all the above features. Just look for a file called "TERMnn.LZH".
  284.   The most current version, as of this writing, is TERM81.LZH.
  285.   
  286.   The phone numbers to call are:
  287.   
  288.       (403)284-5624
  289.       (403)284-5625
  290.       (403)282-5137
  291.  
  292.