home *** CD-ROM | disk | FTP | other *** search
/ PSION CD 2 / PsionCDVol2.iso / Programs / 432 / README.TXT next >
Text File  |  1998-11-11  |  14KB  |  313 lines

  1. ReadMe.txt for Roller version 1.00 Full Version
  2. ===============================================
  3.  
  4. 0. Introduction
  5. ---------------
  6.  
  7. Roller is a dice rolling program, with a difference, this one is actually useful
  8. and it is the first of it's kind (that I know of) for the Psion, thanks to Jody
  9. Armstrong for pointing out this omission and setting me on the course of writing
  10. what is turning into one of the most complex programs I've written on the Psion.
  11.  
  12. So Roller rolls dice, but it does more than that, it stores upto 40 dice types,
  13. and 40 rolls, all accessable from the main screen, it also allows you to check
  14. against values and either report success or failure, or add extra rolls to those,
  15. it even allows you to check one roll against another.
  16.  
  17. 1. Installation
  18. ---------------
  19.  
  20. Roller comes as a .ZIP file, this can be extracted either using WinZip (or Similar on a PC) or using S5Zip on the Psion, the files should be extracted to \System\Apps\Roller, on either
  21. the Internal drive (C:) or External Compact Flash (D:), you will also need to install Plugin2.zip into the directory C:\System\OPL, this will install the Plugin Module for you.
  22.  
  23. 2. Running
  24. ----------
  25.  
  26. Once installed you will have a new icon on the Extras Bar called Roller, with a nice
  27. picture of a Die, simply click on this to run Roller, after a few seconds you will
  28. be presented with the main Roller Screen, with a Toolbar and one Icon on the desktop.
  29.  
  30. * * * * * QUICK START * * * * * *
  31.  
  32. Press Enter or tap the Icon, you've just rolled an AD&D Stat (complete with extra
  33. percentile if it's 18).
  34.  
  35. Press menu or tap the side menu button, select Plugin|Magic|Start, select how many lives
  36. you want, tap the buttons on the window to add or subtract lives, flip a coin, or exit.
  37.  
  38. Press menu or tap the side menu button, select Plugin|Generic Roll|Roll, select number of dice, dice type and number to add/subtract and tap okay to roll.
  39.  
  40. * * * * END QUICK START * * * * *
  41.  
  42. 3. Using Roller
  43. ---------------
  44.  
  45. Roller uses the standard EPOC32 interface, with a toolbar on the right, with icons
  46. and a clock, menus can be called up using either the side button or the menu key,
  47. the program responds to the correct EPOC32 events and will shutdown properly if 
  48. asked.
  49.  
  50. 3.1 Menus
  51. ---------
  52.  
  53. The menus allow you to access every function of the program the menus are
  54.  
  55.     File
  56.     ----
  57.     Open Data - Will Load a set of Dice and Rolls into
  58.             the program, at present only the default set is available.
  59.     Save Data - Will Save the current data set, creating
  60.             three files, <filename> which can be clicked to reload
  61.             roller and load in the other two files <filename>.die and
  62.             <filename>.rolls
  63.     Save As   - Will Save the current data set as to new
  64.             filename.
  65.     Exit      - Closes Roller, and saves the current data to the correct
  66.             set, when you load next time you will continue using this
  67.             set of files.
  68.  
  69.     Dice
  70.     ----
  71.     Add Die*   - Adds a die definition to the files, see the section on
  72.              Dice for more information.
  73.     Edit Die*  - Not Implemented, Allows you to select a Die and then change
  74.              the information about .
  75.  
  76.     * These only work with the registered version.
  77.  
  78.     Rolls
  79.     -----
  80.     Roll Dice   - Performs the same as tapping an Icon or clicking on Roll Dice
  81.               on the Toolbar.
  82.     Add Roll    - Creates a new roll, see the section on Rolls for more information
  83.               on creating and editing rolls.
  84.     Edit Roll   - Edits the currently selected roll (the inverted one), see the
  85.               section on Rolls for more information.
  86.     Delete Roll - Not Implemented, This will delete the currently selected roll,
  87.               after a comfirmatory dialog.
  88.     View Roll   - Shows the whole Roll string (3D6=18 1D100 for AD&D Stat), since
  89.               the backdrop view will clip this if it's too long.
  90.  
  91.  
  92.     Plugin
  93.     ------
  94.     Magic        - Name of the plugin module pre-installed.
  95.     Generic Roll- Creates a generic roll of nDn + n quickly
  96.     Config        - Allows the adding and removing of plugin modules.
  97.  
  98.     Window        (only available if plugin windows are open)
  99.     ------
  100.     Hide        - Allows the user to hide any of the open windows
  101.     Show        - Brings any windows hidden back into view again
  102.     Close        - Allows the user to close any of the open windows, even if
  103.               they are hidden.
  104.  
  105.     Tools
  106.     -----
  107.     Preferences    - Allows you to set preferences for the program, will allow you to
  108.                  choose which confirmatory messages you will recieve and if the
  109.                  backdrop shows Roll String.
  110.     Register       - Unregistered version only, allows the user to register the program
  111.              removing nag screens and allowing certain features to work.
  112.     Help on Roller - Displays the Roller help file, which will explain in detail about
  113.              the various parts of the program, and the concepts used, essential
  114.              reading.
  115.     About           - Displays the DudleySoft Splashscreen.
  116.  
  117. 3.2 Dice
  118. --------
  119.  
  120.     In the other dice rolling programs i've seen you can enter any number for sides,
  121.     now while this is flexible it's hardly correct, you can't get 23 sided dice (23
  122.     was chosen since it's a prime, and you can't make a regular 23 sided polyhedron.
  123.     You could choose to create a D23 as a new dice in this program, but you have to
  124.     decide to do it. The program starts with a series of Dice already defined, these
  125.     are D4,D6,D8,D10,D12,D20, D100 (Percentile) and D66 (Percentile, well sort of).
  126.     There is also a special Dice called Number which allows you to use constant
  127.     values in your rolls (as modifiers normally), I'm also concidering adding a 
  128.     Variable type that asks for a value at runtime. To create a new Dice simply
  129.     select Add Dice and you will be presented with a dialog box.
  130.     
  131.         Name        - Name for your dice, if you leave it blank it will
  132.                   generate the name as D<n> where n is the number of
  133.                   sides selected.
  134.         Type        - Currently Allows two types Die and Percentile.
  135.         Sides 1        - If your using a Die type this is the sides on the
  136.                   die and you can ignore the other two values, on
  137.                   percentiles, this is the sides on the first die.
  138.         Sides 2        - Ignore if your using a Die type, on a percentile
  139.                   this represents the number of sides on the second
  140.                   die (see you don't get this flexability if you
  141.                   use inferior programs that roll a D100 as 1-100)
  142.         Flags        - Ignore if your using a Die type, on a percentile
  143.                   this controls how values are generated.
  144.                   0     - Values go from 0 to <sides>-1, 00 will
  145.                       become 100 automatically.
  146.                   1    - Values go form 1 to <sides>
  147.                   2    - Values go from 0 to <sides>-1, 00 stays
  148.                       as 0.
  149.  
  150. 3.3 Rolls
  151. ---------
  152.  
  153.     Now comes the complicated part, when we want to roll a die at present we
  154.     need to create a Roll, this is a multi part operation, but you can go
  155.     back and change values at any point, and the dialog shows the current
  156.     roll status as part of it's display. At some point in the future I will
  157.     add a quick roll feature, that will mimic lesser dice rolling programs.
  158.  
  159.     Adding and Editing Rolls use the same routines, and are identical except
  160.     when you edit a roll the program sticks you at the last die entered and
  161.     a new roll starts at the first die.
  162.  
  163. 3.3.1 Roll Editing Dialog
  164. -------------------------
  165.  
  166.     This dialog is the core of the program and provides the amazing flexability
  167.     that you wouldn't get with a simpler program.
  168.  
  169.         Operation    - This is where the power really comes from, anybody
  170.                   can write a program to generate a few random numbers
  171.                   but with this system you can link them together to
  172.                   form complex equations, the operation types are as
  173.                   follows:
  174.                 
  175.             New    - Starts a new roll value, if there is a previous value
  176.                   it will be output, nearly all rolls will start with
  177.                   new, or Add or Subtract.
  178.             Add    - Adds this result to the previous result, speaks for
  179.                   itself so I'll shut up.
  180.             Subtract- Subtracts this result from the last result, see comment
  181.                   for Add.
  182.             Multiply- Multiplies the last result by this one.
  183.             Divide  - Divides the last result by this one.
  184.             Less    - Compares the last result with this one if this result is 
  185.                   less than the last one then one of two things happen, if
  186.                   the Diagnose flag is set then A result is output saying
  187.                   we failed and telling us the result of this value, if not
  188.                   then we stop the roll. if its greater then we either
  189.                   output a success message and continue or just continue.
  190.             Greater - Works the same as Less except the other way around.
  191.             Equals  - Works the same as Less and Greater except it only succeeds
  192.                   if the results are the same (used to great effect in the
  193.                   AD&D Stat roll)
  194.  
  195.         Type        - The type of die that you want to roll, you can select
  196.                   from any of the already selected die types here, a list
  197.                   pops up if you tap on the box when it's selected.
  198.         Number        - For a Die or percentile type this is how many of them
  199.                   you want to roll, for a number type this is the actual
  200.                   number you want to use.
  201.         Roll        - This simply tells you the roll that you've created
  202.                   in a standard format.
  203.         Allow Negative  - If this is checked then the program will allow values
  204.                   to go negative, if not then they will automatically
  205.                   be set to zero should they fall below.
  206.         Diagnose Checks - Doesn't check for Bank account, this flag says that
  207.                   when we use a check function we should inform the
  208.                   user if the check has Succeeded or Failed, if this
  209.                   is set you will see something like this as a result
  210.                   14 Failed (18) the first value is the value rolled,
  211.                   the second value is the value it was checked against
  212.                   since this can be a dice roll, simply telling the
  213.                   user that he has failed without confirming it would
  214.                   seem a little unfair, this can be used for Saving 
  215.                   throws to give a visual indication of the status.
  216.  
  217.         Finish (Button) - This finishes and stores the role, Note that every
  218.                   Die after the current one will be lost if you select this
  219.                   in the wrong place, check before you finish that you are
  220.                   at the last die entry.
  221.         More > (Button) - This allows you to enter more dice, it moves you forward
  222.                   one die in the list, you can go forward upto Die 8.
  223.         Back < (Button) - This takes you back one space, all the values after this
  224.                   are remembered, so you don't have to re-enter them
  225.                   if you've made a mistake further back.
  226.         Cancel (Button) - Cancels the current operation, the roll wont be written
  227.                   back until you actually finish the roll.
  228.  
  229. 4. Forthcoming Features
  230. -----------------------
  231.  
  232. As you can tell this program still has a lot of stuff to be added, below is a brief
  233. list of features that will almost definately make it into Version 1.0
  234.  
  235.     * Dice string convertor, will convert a string as displayed by the
  236.       dice view and icons into the internal format of the program, either
  237.       for quick rolling or for saving to the desktop. (To be a plugin)
  238.  
  239. Features that might creep in at a future date (Possible and BlueSky stuff)
  240.  
  241.     * Character sheets (this would require a massive new module that would
  242.       allow a lot of new features, such as automatic save throws, auto
  243.       character generation (using any selected roll type), automatic hit point,
  244.       Magic point,etc ... update, level up handling, overnight routines (for
  245.       healing/ magic point regeneration, spell learning, prayer learning.
  246.       Plus a full character sheet editor (HTF would that work? Multiple windows?
  247.       Drag and drop? How do you double/right click?)
  248.     * Games Master Plugin - Allow a lot of games master functionality as well
  249.     * Plugin Die Types (possibly using my Generic Plugin Module system), to give
  250.       access to all the features required by the Character sheet.
  251.     * Infrared/Serial linkup will allow Users to send and recieve rolls and
  252.       results, run a game on Psion Palmtops? Where do you get a honda to honda
  253.       serial lead?)
  254.     * PBEM (Play By E-Mail) system to send roll messages across the net and recieve
  255.       them at the other end as attachments and to be able to load them in and
  256.       use the results.
  257.  
  258. 5. Copyright Notice
  259. -------------------
  260.  
  261. (C) 1998 DudleySoft
  262.  
  263. To be finalised, however this product is current Copyright to DudleySoft, and is
  264. Shareware
  265.  
  266. 5.1 Registration Details
  267. ------------------------
  268.  
  269. You may register Roller via the Internet using Reg.Net, see my website at 
  270. http://www.dudleysoft.com/psion.html for more details, registration costs $15.
  271.  
  272. You may also send cheques for ú7.50(Sterling) to the address below made payable to
  273. James Watson, don't forget to tell me your Machine ID otherwise I can't provide you
  274. with a Registration Code. If you send your e-mail address as well I will get back to
  275. you a lot faster.
  276.  
  277. 5.2 Registration code transfer
  278. ------------------------------
  279.  
  280. I know some people get scared when they see a program that uses the machine ID, however
  281. if you need to transfer your code (for replacement machines) simply e-mail me at dudley@dudleysoft.com, stating the reason and if possible your previous Machine ID and Registration code. (You should either keep your e-mail or keep a note somewhere, for safety)
  282. I will concider your request and provided it's reasonable (if you keep trying to transfer your code then it's going to look suspicious and I'll have to refuse).
  283.  
  284. 6. Contact Information
  285. ----------------------
  286.  
  287. The easiest and quickest way to contact me (James Watson) is to use my email
  288. account, dudley@dudleysoft.com, this is currently forwarded to my home account
  289. and is currently checked at least once a day.
  290.  
  291. Snail Mail:
  292.  
  293. James Watson
  294. 89 Riccarton
  295. Westwood
  296. East Kilbride
  297. G75 9BX
  298. Scotland
  299.  
  300. 7. Extra (Esoteric) Information
  301. -------------------------------
  302.  
  303. This program and ReadMe file was written to the Melodic Sounds of The Corrs, and Sleeper
  304. and the not so melodic, but equally good sounds of Green Day. I used the Beta version
  305. of OPLPlus by Andy Clarkson, on the EPOC Emulator (Rel version) emulating the Geofox
  306. screen layout (for extra screen size) and tested on an 8Mb Psion Series 5, with
  307. Compact Flash memory. The icons are spash screen were produced using Paint Shop Pro 4 and 
  308. 5 and converted using bmconv.exe, the PC used is a Pentium 200MMX clocked to 233Mhz with 
  309. 72MBytes of memory and a 4.3 GByte hard drive. The whole package and readme file were 
  310. packed and ZIPped using WinZip 7 Beta.
  311.                 
  312.  
  313.