home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 3 / PDCD_3.iso / pocketbk / games / yam11src / README.TXT < prev    next >
Text File  |  1995-07-27  |  8KB  |  185 lines
  1. YAM, Version 1.10, July 27, 1995
  2. Copyright (c) 1995 Bermuda Software Publishing
  3. Written by Bruno Essmann (bessmann@iiic.ethz.ch)
  4.  
  5. New in Release 1.10
  6. ===================
  7.  
  8. There are only some minor changes, but I think it's worth releasing a new
  9. version even if the last release was only a fortnight ago.
  10.  
  11. - the most important change is the removal of recursion in the procedure
  12.   which does the field check, this drastically reduces the memory required
  13.   to run YAM (and the error "out of system memory" should not appear 
  14.   anymore unless you're really short of memory)
  15. - the size of the executable and the memory needed to run YAM has been
  16.   reduced by about 1KB by a utility called 'aka' by David Palmer (thanks)
  17.   in addition the help file is slightly smaller (about 1KB) so the total
  18.   size reduction of the files on disk is about 2KB
  19. - online help works in the dialogs "Set preferences", "Setup sounds" and
  20.   "Custom game" (the help key is captured in most cases, just press the
  21.   help key long enough and the online help will appear)
  22. - the "Set preferences" dialog has been split up into two dialogs "Set
  23.   preferences" and "Setup sounds".
  24.  
  25. Introduction
  26. ============
  27.  
  28. YAM is Yet Another Minesweeper for the Psion Series 3a. It will not run
  29. on a Series 3 but feel free to port it.
  30.  
  31. There have been two reasons for me to write yet another minesweeper.
  32. Firstly I didn't like the various other minesweepers available (no offence
  33. meant to the authors of those programs, I just didn't like them) and
  34. secondly I wanted to find out if OPL is suited to write 'real' applications
  35. or if it's a mere tool to enhance the built-in calculator. The conclusion
  36. is that I don't like OPL as an programming language. Of course it's better
  37. than nothing, but it lacks all the enhancements of modern programming
  38. languages like Modula-2 or Oberon-2. Fortunately there exist preprocessors
  39. ('s3atrans' for MS-DOS computers and 'opl_pp' for the Psion Series 3a) else
  40. I wouldn't have had the nerve to finish this minesweeper.
  41.  
  42. Hardware Requirements
  43. =====================
  44.  
  45. 1) Psion Series 3a
  46. 2) at least 50 KB of free memory
  47.  
  48. Software Requirements
  49. =====================
  50.  
  51. 1) one of the following OPL preprocessors which should both be available
  52.    from where you obtained the YAM source code
  53.    - For MS-DOS computers:    S3ATRANS
  54.    - For Psion S3a computers: OPL_PP
  55. 2) the helpkit written by Jezar at Psion (jezar@cix.compulink.co.uk),
  56.    look out for HELPKIT1.ZIP.
  57. 3) if you want to create an optimized version (is a bit faster and uses
  58.    about 1KB less memory) you'll also need AKA by David Palmer (MS-DOS
  59.    computers only).
  60.  
  61. Installation
  62. ============
  63.  
  64. The installation kit consists of the following files:
  65.  
  66. name         contents
  67.  
  68. README.TXT   this text
  69. INSTALL.TXT  installation script for use with MCLINK
  70. YAM.OPH      yam headerfile (required)
  71. YAM.OPL      yam application module (compile this to get yam.opa) (required)
  72. MAIN.OPL     main event handling functions (required)
  73. GAME.OPL     minesweeper game routines (required)
  74. DISP.OPL     display functions (required)
  75. UTIL.OPL     auxiliary routines (required)
  76. ICON.PIC     the application icon (required)
  77. HELP.HLP     the help source (for use with the helpkit) (optional)
  78. YAM.PIC      the game images (used by yam.opa) (required)
  79.  
  80. to load
  81.  
  82. 1) make shure the computer can connect to the Series 3a
  83. 2) execute MCLINK.EXE @INSTALL.TXT
  84.  
  85. remarks:
  86. 1) to copy the yam source code to a drive other than M: edit INSTALL.TXT
  87.    accordingly.
  88. 2) if you're short of free ram remove the line containing HELP.HLP from
  89.    INSTALL.TXT, the help file is not required but recommended.
  90. 3) if you are using RCom modify the INSTALL.TXT accordingly and save
  91.    it as INSTALL.BAT or execute the commands manually.
  92.  
  93. Files and Folders
  94. =================
  95.  
  96. When using the INSTALL.TXT script to install the source code the files will
  97. be copied to the following locations. Of course you can edit INSTALL.TXT to
  98. copy the source code wherever you want...
  99.  
  100. name         location
  101.  
  102. YAM.OPH      \APP\YAM\SOURCE\ (on any drive)
  103. YAM.OPL      \APP\YAM\SOURCE\ (on any drive)
  104. MAIN.OPL     \APP\YAM\SOURCE\ (on any drive)
  105. GAME.OPL     \APP\YAM\SOURCE\ (on any drive)
  106. DISP.OPL     \APP\YAM\SOURCE\ (on any drive)
  107. UTIL.OPL     \APP\YAM\SOURCE\ (on any drive)
  108. ICON.PIC     \APP\YAM\SOURCE\ (on any drive)
  109. HELP.HLP     \APP\YAM\SOURCE\ (on any drive)
  110. YAM.PIC      \APP\YAM\ (on any drive)
  111. YAM.HLP      \APP\YAM\ (on any drive, after creation with the HELPKIT)
  112. YAM.INI      M:\APP\YAM\ (will be created automagically, see below)
  113.  
  114. After successful compilation, when YAM is started the first time it will
  115. create a file called YAM.INI which holds the configuration data. Since this
  116. file will be modified whenever you change the settings or if a new highscore
  117. is achieved this file will be stored on the internal drive in the folder
  118. \APP\YAM\. If you deinstall YAM don't forget to delete this file as well.
  119.  
  120. Compilation Notes
  121. =================
  122.  
  123. The following things have to be respected when compiling YAM:
  124.  
  125. - To create YAM.OPA you'll have to compile YAM.OPL since this is the
  126.   application module. YAM.OPL contains the global variables, some
  127.   initialisation code and imports all the other source files.
  128. - Before compiling YAM.OPL make shure the ICON statement in line 7 points to
  129.   the correct path if you copied the source files to another location.
  130. - If you compile the help file HELP.HLP with the helpkit the generated
  131.   resource file will be created as \OPD\HELP.RSC. Copy this file to
  132.   \APP\YAM\YAM.HLP else YAM will not be able to access it.
  133. - If you encounter any problems or have some suggestions feel free to contact
  134.   me (use the e-mail address given below if possible).
  135.  
  136. New in release 1.10:
  137.  
  138. - The recursive function version of 'Game_CheckField' has been replaced by a
  139.   nonrecursive version. There is a definition called 'CHECK_RECURSIVE' which
  140.   (if defined, see the file YAM.OPH for details) enables you to compile YAM
  141.   with the recursive version.
  142.  
  143. Contact Address
  144. ===============
  145.  
  146. YAM, Yet Another Minesweeper
  147. Bermuda Software Publishing
  148. Attn Bruno Essmann
  149. Duebendorfstrasse 184/02
  150. CH-8051 Zuerich
  151.  
  152. E-mail: bessmann@iiic.ethz.ch
  153.  
  154. Freeware
  155. ========
  156.  
  157. YAM and its source code are freeware.
  158.  
  159. I decided to release YAM as freeware because there is a nasty trend that
  160. everybody who writes even a small application thinks that he'll get money
  161. for it. The result is that there are a lot of crippleware applications.
  162. I've spent about 15 hours writing YAM and I did it because programming is
  163. one of my hobbies. I don't have spare time either, I take the time for
  164. programming since it's fun (at least sometimes) and as a basic rule I
  165. release all applications that took less than, say 100 hours to write as
  166. freeware.
  167.  
  168. Disclaimer
  169. ==========
  170.  
  171. Permission to use, copy, modify or distribute this software and its
  172. documentation for any purpose is hereby granted without fee, provided that
  173. the above copyright notice appear in all copies and that both that copyright
  174. notice and this permission notice appear in supporting documentation, and 
  175. that the name of Bermuda Software Publishing not be used in advertising or
  176. publicity pertaining to distribution of the software without specific,
  177. written prior permission.
  178.  
  179. Bermuda Software Publishing disclaims all warranties with regard to this
  180. software, including all implied special, indirect or consequential damages
  181. or any damages whatsoever resulting from loss of use, data or profits,
  182. whether in an action of contract, negligence or other tortious action,
  183. arising out of or in connection with the use or performance of this software.
  184.  
  185.