home *** CD-ROM | disk | FTP | other *** search
/ linuxmafia.com 2016 / linuxmafia.com.tar / linuxmafia.com / pub / palmos / pilot-frotz-src-1.00r4.tar.gz / pilot-frotz-src-1.00r4.tar / pilot-frotz-1.00r4 / Pilot-Frotz.txt < prev    next >
Text File  |  1998-10-27  |  13KB  |  315 lines
  1.  
  2.  
  3.     Pilot-Frotz:
  4.     ============
  5.  
  6.     Written by Paul Margrave 1998.
  7.     Based on the Frotz 2.32 code base by Stefan Jokisch 1995-1997.
  8.  
  9.     Pilot-Frotz may be used in any way, for any purpose, at no cost.
  10.     It may be distributed by any means, provided that the original
  11.     files as supplied by the author remain intact and that no charge is
  12.     made other than for reasonable distribution costs.
  13.  
  14.  
  15.     DISCLAIMER OF WARRANTY:
  16.     -----------------------
  17.     THIS SOFTWARE AND DOCUMENTATION ARE PROVIDED "AS IS" AND WITHOUT
  18.     WARRANTIES AS TO PERFORMANCE OF MERCHANTABILITY OR ANY OTHER WARRANTIES
  19.     WHETHER EXPRESSED OR IMPLIED. BECAUSE OF THE VARIOUS HARDWARE AND
  20.     SOFTWARE ENVIRONMENTS INTO WHICH THIS PROGRAM MAY BE PUT, NO WARRANTY
  21.     OF FITNESS FOR PARTICULAR PURPOSE IS OFFERED. THE USER MUST ASSUME THE
  22.     ENTIRE RISK OF USING THE PROGRAM.
  23.  
  24.     Any product or brand names mentioned in this document are trademarks or
  25.     registered trademarks of their respective owners.
  26.  
  27.     Whats New?
  28.     ==========
  29.  
  30.       V 1.00 R1
  31.         First release.
  32.  
  33.       V 1.00 R2
  34.         * After getting some emails about supporting Pilot-Zip format game files
  35.           I have now added this to Frotz. Because of this change, the type ID has
  36.           been changed from 'GAME' to 'ZCOD' this is more inline with ZIP format
  37.           game files which have a type ID of 'Zcod'. This does mean that you will
  38.           have to reconvert your game files with the new 'Z2PDB' program. Sorry
  39.           about this little bit of hassle.
  40.         * Fixed the bug in the compass rose popup that caused 'Climb' and 'Again' to
  41.           be printed instead of 'Enter' and 'Exit'.  
  42.         * Fixed the 'Terpetude' game file not working.
  43.  
  44.       V 1.00 R3
  45.         * Added menu to the interpreter to force a quit while running a game.
  46.         * Now allow more graffiti characters to be entered. Has the full range of ascii
  47.           characters from 32 to 127.
  48.         * Due to popular request I have added a scroll back buffer. Enable it in the
  49.           'Preferences' dialog and then you can use the page up/page down hard buttons
  50.           on the Pilot to scroll back and obviously words can be tapped during scroll
  51.           back.
  52.         * Hit the 32K code limit with optomisations O2 so have now gone for O3 and
  53.           greater than 32K, may have beter performance?
  54.         * Adjusted the 'Z2PDB' source for GNU compatability and a Linux version of
  55.           'Z2PDB' is included in the archive.
  56.         * When '<MORE>' appears, tapping on the screen continues instead of bringing
  57.           up the popup lists. 
  58.  
  59.       V 1.00 R4
  60.         * Added field editing for the interpreters text line input. It now allows you
  61.           to cursor left/right and tap to set the insertion point.
  62.         * Added a new option which allows a proper field to be displayed for text
  63.           line input. This means text editing 'hacks', popup keyboards and the graffiti
  64.           state indicator will work with it.
  65.         * Added an endian define in the 'Z2PDB' source. If you are recompiling 'Z2PDB'
  66.           make sure that the endian is correctly defined.
  67.  
  68.  
  69.     What is it?
  70.     ===========
  71.  
  72.     Pilot-Frotz is a freeware version of Frotz, the most popular Infocom/Inform text
  73.     adventure interpreter for the Z-Machine. It plays games of version Z1 to Z8,
  74.     such as the old Infocom adventures 'Hitchhikers', 'Zork' and the new Inform
  75.     games, but not version Z6, as this version contains graphics.
  76.  
  77.     To obtain games to run on Frotz check out 'FTP.GMD.DE:IF-ARCHIVE' or another
  78.     mirror of the Interactive Fiction Archive. Infocom games are still under
  79.     copyright and should not be available for download. Don't as me for them either.
  80.     You need to own a copy of the original game to legally be allowed to play it on
  81.     the Pilot.
  82.  
  83.     Please, dont email me on getting game files, just do an internet search for
  84.     'Interactive Fiction' and lots of info will be spewed forth.
  85.  
  86.  
  87.     Features:
  88.     =========
  89.  
  90.     * Compatible with the Z-Spec version 1.0. But no graphics/sound. Runs
  91.       'Terpetude' accurately for testing. 'Terpetude' is provided in this archive.
  92.  
  93.     * Reads game files created for Pilot-ZIP.
  94.  
  95.     * Correct font display of normal, bold, reverse, underlined/italic, proportional
  96.       and a 40 column fixed width micro font of my own design.
  97.  
  98.     * Text input through the interpreters text line input, which works in different
  99.       fonts, or a proper field that works with 'hacks' and keyboards.
  100.  
  101.     * Scroll back buffer to see pages that have scrolled past.
  102.  
  103.     * Single key timed input works for games that use it.
  104.  
  105.     * Line timed input works for games that use it.
  106.  
  107.     * Undo is supported for those games that can use it.
  108.  
  109.     * Compressed game saves with complete game listings.
  110.  
  111.     * Virtual memory for small memory Pilots.
  112.  
  113.  
  114.     Limitations:
  115.     ============
  116.  
  117.     Because of some emails I have recieved saying that 'so and so' game does not work
  118.     I have added this little section to explain why.
  119.  
  120.     * Some games are not 'small screen' friendly. Frotz uses a 40x14 fixed width
  121.       character display. Some games check the screen dimensions and if it is too small
  122.       they error out. 'Theatre' for example does this.
  123.  
  124.     * Some games can be confused by a 40 character width status line. They do not
  125.       check the width and reduce the status information accordingly. They just try to
  126.       print directly off the edge of the screen.
  127.  
  128.     * Some games with inbuilt menu systems assume that they have more than 14 lines on the
  129.       screen and then print menu items off the bottom of the screen.
  130.  
  131.     * Most 'abuses of the z-machine' will probably not work. 'Rogue' for example. These
  132.       games usually expect larger displays and more varied font displays.
  133.  
  134.     These problems are not really Frotz's. They lie in the actual game file. If you are
  135.     writing an Inform program try and make it 'small screen' friendly, even if you just
  136.     check the dimensions and error out if too small. Other points:
  137.  
  138.     * Auto load/save basically operate in the same way that you would save/load from in
  139.       the game.
  140.  
  141.     * Status line detection will only work on a 1 character high status line.
  142.  
  143.     * Text input through the interpreter does not usually use a proper field, this enables
  144.       it to work with different font properties. You can now enable a proper field at the
  145.       expense of a line of display.
  146.  
  147.  
  148.     Requirements:
  149.     =============
  150.  
  151.     * Palm III or Pilot running OS 2.0 or greater.
  152.  
  153.     * Enough memory to load the game PDB and Virtual memory file, if being used.
  154.  
  155.     * A Z-Code game file converted to PDB format using 'Z2PDB'. Which is supplied in
  156.       this package as a Win95 command line executable and as a source file for those
  157.       with different operating systems.
  158.  
  159.     * Lots of time to play...
  160.  
  161.  
  162.     Installing:
  163.     ===========
  164.  
  165.     The Pilot-Frotz.prc file and any game files converted to PDB format should be
  166.     loaded onto your device.
  167.     To convert Z-Code files into PDB's you must use 'Z2PDB' as follows:
  168.  
  169.         Z2PDB <DESTGAME.PDB> <SOURCEGAME.Z?> "TITLE TO CALL IT"
  170.  
  171.     You just supply the output PDB filename the input Z-Code filename and the title
  172.     to call it. The title must be in quotes if it contains spaces. If you have an old
  173.     Infocom game then it is the '.dat' file you are interested in converting.
  174.  
  175.     If you have a different OS from Windows 95/98 then the source is present for
  176.     'Z2PDB' to be recompiled. Check the endian format and change the #define for your
  177.     OS.
  178.  
  179.  
  180.     Running:
  181.     ========
  182.  
  183.     Once the desired files are on your device run Frotz from your App launcher. The
  184.     opening screen should list all Z-Code games loaded with their size and version
  185.     marked with a little icon. To play a game, just tap on one and then tap 'Play'.
  186.     To delete a game file from your device, tap on one and then tap on 'Delete',
  187.     answer 'Yes' to the 'Are you sure?' alert box and its gone. The drop down list
  188.     allows you to view the dynamic ram requirements of a game instead of its file
  189.     size.
  190.  
  191.     There are three menu items available, 'About', 'Delete Save Games' and
  192.     'Preferences'.
  193.  
  194.  
  195.     About:
  196.     ------
  197.  
  198.     This just tells you the current version and gives information on contacting me.
  199.  
  200.  
  201.     Delete Game Saves:
  202.     ------------------
  203.  
  204.     This will bring up a list of all the game saves on your device for all the
  205.     different games. They are listed with the save name, the game they are for and
  206.     the size in bytes they take up. They are deleted in the same way games are.
  207.  
  208.  
  209.     Preferences:
  210.     ------------
  211.  
  212.     This page allows you to set options on how Frotz runs a game, the options are as
  213.     follows:
  214.  
  215.  
  216.     Text output speed:
  217.     ------------------
  218.  
  219.     This effects to speed that text is written to the screen. 'Normal' is as fast as
  220.     possible.
  221.  
  222.  
  223.     Auto MORE:
  224.     ----------
  225.  
  226.     When checked the '<MORE>' prompts will not appear.
  227.  
  228.  
  229.     Enable UNDO:
  230.     ------------
  231.  
  232.     When checked, games that can use the 'UNDO' command will have one undo position
  233.     available. Note: If undo is enabled when Virtual memory is being used then the
  234.     game will run very slowly.
  235.  
  236.  
  237.     Status line detection:
  238.     ----------------------
  239.  
  240.     When checked then the status line will attempt to be printed in the larger
  241.     proportional font instead of the micro fixed width font. Try it and see which
  242.     you prefer, some games may not display their status lines correctly with this
  243.     on.
  244.  
  245.  
  246.     Enable scrollback:
  247.     ------------------
  248.  
  249.     When checked this will allow the page up/page down hard buttons on the Pilot to
  250.     scroll back over text that has gone off the top of the screen. You can do this
  251.     to find words to tap on to speed up entry. Just set the number of pages you
  252.     require from 1 to 9, 9 pages being around 100 lines.
  253.  
  254.  
  255.     Enable full field editing:
  256.     --------------------------
  257.  
  258.     With this enabled you will get a proper field for entering lines of text.
  259.     Hackmaster 'hacks' for text editing will work with this field and you can use
  260.     the popup keyboard as well.
  261.  
  262.  
  263.     Virtual memory:
  264.     ---------------
  265.  
  266.     This is a complicated option as I will have to describe how Frotz uses memory
  267.     for a game.
  268.  
  269.     Normally a game is divided into three areas, the stack, the dynamic area and the
  270.     static area. The stack and dynamic areas are allocated from the Pilots free
  271.     memory when a game is run, the static area is paged in as and when Frotz needs
  272.     it.
  273.  
  274.     If Frotz complains that 'There is not enough free memory' then you can enable
  275.     Virtual memory which will change the way the dynamic area is created. It will
  276.     now be paged in as needed, reducing the memory overhead of required free memory.
  277.     Games running under Virtual memory will run slower than normal.
  278.  
  279.     The numbers at the bottom of the window show how much memory is free for a game
  280.     to run in, normally you would require 2kB for the stack and anywhere from 2kB to
  281.     64kB for the dynamic area, depending on the game and Z-Code version. Scroll back
  282.     pages also add to this total.
  283.  
  284.  
  285.     Interacting with a game:
  286.     ========================
  287.  
  288.     I am presuming that if you know what Frotz is for then you have a basic
  289.     understanding of how to interact with the game being played. There are a couple
  290.     of differences, as the Pilot has no keyboard.
  291.  
  292.     * You can write words using Graffiti input as normal. The characters in the range
  293.       of ascii 32 to 127 can be input.
  294.  
  295.     * Enable 'Full field editing' and use the popup keyboard and Hackmaster 'hacks'.
  296.  
  297.     * You can tap on a displayed word and it will type itself in. You can scroll back
  298.       over text and tap on a word also if the scroll back buffer is enabled.
  299.  
  300.     * You can tap on an empty part of the screen and a popup will appear containing
  301.       the most common actions in text adventures. Tap on the left of centre and a
  302.       compass rose will appear, tap on the right of centre and a word list will
  303.       appear.
  304.  
  305.     * To force a quit from the current game bring up the menu which contains a 'Force
  306.       Quit' entry. Selecting this will exit back to the game list.
  307.  
  308.     To save and restore use 'SAVE' and 'RESTORE'. To quit the game and return to the
  309.     game list use 'QUIT'. If you tap the App launcher button or switch to another
  310.     application your position will be saved in an auto save position, which will
  311.     automatically load next time Frotz is run. If you save this way, some games can
  312.     have corrupt status lines on reloading. Using the 'Status line detection' option
  313.     should prevent this.
  314.  
  315.