home *** CD-ROM | disk | FTP | other *** search
/ The Final Frontier 7 / FinalFrontier7disk1Of4.adf / LCARS / TextFile / LCARS_Guide.pp / LCARS_Guide
Encoding:
Text File  |  1994-05-13  |  20.6 KB  |  440 lines

  1. TF01
  2. 4,LCARS GUIDE
  3. 2,LCARS Release 2 User's Guide
  4.  
  5. a · BUG REPORTS / CONTACTING THE AUTHOR
  6.  
  7. 01      I was going to put this bit at the end of this guide, but the
  8.         thought occured to me that  you  might  find it so boring you
  9.         don't get to the end! Anyway, I can be contacted at the usual
  10.         INFINITE FRONTIERS address, or my home address is as follows:
  11.  
  12.                 Luke Elliott
  13.                 7 Hathaway Close
  14.                 Eaton Socon
  15.                 St. Neots
  16.                 Cambridgeshire
  17.                 PE19 3HQ.
  18.  
  19.         Bear in mind I might be at  university at the time, so it may
  20.         take a while for anything  to  reach me... Alternatively (and
  21.         preferably) if you have access to EMAIL then my address is:
  22.  
  23.                 ae3084@bris.ac.uk               (Internet)
  24.  
  25. 02      If you do find a bug in  the LCARS software (which I hope not
  26.         as it has been  extensively  tested),  then  please could you
  27.         send me the following details:
  28.  
  29.         i.      What the bug does.
  30.         ii.     How to make the bug occur (as precisely as possible).
  31.         iii.    Your system configuration -
  32.                                 Machine type
  33.                                 Amount of mem (chip and fast)
  34.                                 Kickstart version
  35.                                 Any peripherals attached
  36.  
  37.         As well as  bug  reports,  any  suggestions  for  how I could
  38.         improve the LCARS software are always welcome!
  39.  
  40.  
  41. A · INTRODUCTION
  42.  
  43. 01      What is LCARS?  LCARS  (or  Library  Computer  Access and Re-
  44.         trieval System) is the  interface  between  the main computer
  45.         and the user  on  all  new  and  recently  refitted StarFleet
  46.         vessels. Older vessels are  currently undergoing modification
  47.         in their computer cores to  incorporate  and make best use of
  48.         the new software, which  is  intended  to  be the mainstay of
  49.         StarFleet computers for years to come. It is designed in such
  50.         a way that upgrades can be  incorporated with ease due to its
  51.         modular design -  for  example,  if  the  Environment control
  52.         program is improved  upon,  the  existing  software  for that
  53.         particular sub-system may  be  removed  and  replaced without
  54.         touching other areas of LCARS.
  55.  
  56. 02      LCARS is a completely new type of interface for starships. In
  57.         23rd century vessels, the emphasis  in software design was on
  58.         functionality and not  user-friendliness.  This  led  to many
  59.         problems  since  different   sub-systems   could  be  totally
  60.         different in design, with  no  common  thread running through
  61.         them.  Indeed,  the  design  of  computer  software  had  not
  62.         advanced a great deal since  the  late 20th century, although
  63.         the technology involved had.  With  the  commissioning of the
  64.         Galaxy class project in July  of  2343, the Advanced Starship
  65.         Design Bureau  (ASDB)  decided  that  major  improvements  in
  66.         software functionality and  user-friendliness  were required,
  67.         and for this reason computer  systems  were  one of the areas
  68.         given priority to the design centres.
  69.  
  70. 03      LCARS provides both keyboard and verbal interface capability,
  71.         incorporating highly  sophisticated  artificial  intelligence
  72.         routines and graphic displays for  maximum  crew ease of use.
  73.         (Unfortunately, due  to  problems  in  storage  of  the LCARS
  74.         software, the version currently running  does not contain any
  75.         verbal recognition routines,  although  you  can  talk to the
  76.         console if you wish.)
  77.  
  78.  
  79. B · USING LCARS
  80.  
  81. 01      LCARS was designed to  be  as  easy  and  intuitive to use as
  82.         possible. However, you may  be experiencing some difficulties
  83.         so a short description of  its  main  features follows in the
  84.         next section.
  85.  
  86. 02      The  standard  LCARS  display  is   split into  two  distinct
  87.         sections.  The  upper  section  contains   a main "title" for
  88.         the current operation. Below the  main  title  is  a  further
  89.         line of text which may  contain additional details. The lower
  90.         section  is where  the  real  action  takes  place.  This may
  91.         contain gadgets to control  the   menuing  system, or text to
  92.         read  (such   as  now),  graphics  to  view,  preferences  to
  93.         adjust  or questions  to answer.  A  brief description of all
  94.         these modes follows  in a while.
  95.  
  96. 03      There are usually gadgets  in  both  sections of the display.
  97.         The upper section will generally always contain two gadgets -
  98.         the INFO gadget  in  the  top-left  corner  and a screen-flip
  99.         gadget. The INFO gadget will  display information relative to
  100.         the current mode of operation.  The screen-flip gadget can be
  101.         used to place the LCARS screen at  the back of the display in
  102.         the multi-tasking Amiga environment. In  the lower of the two
  103.         bars which separate the two LCARS sections, you should see an
  104.         thin block about 3 cm long and  a couple of mm high. Click on
  105.         this to swap screens.
  106.  
  107. 04      This standard LCARS  display  layout  is  used  for all modes
  108.         EXCEPT the viewing of graphics files - see section E for more
  109.         information.
  110.  
  111.  
  112. C · MENU MODE
  113.  
  114. 01      Menu mode uses  a  series  of  MenuFiles  which  contain data
  115.         describing the layout of the current display. These MenuFiles
  116.         also contain the information  which  tells  LCARS  what to do
  117.         when a gadget is clicked -  either  display a new MenuFile or
  118.         perhaps a TextFile (see  section  D),  as  well as performing
  119.         many other varied and exciting functions.
  120.  
  121. 02      During Menu mode, the  lower  LCARS  display contains 28 user
  122.         definable gadgets which  can  be  clicked  on  with the LCARS
  123.         pointer. This will perform one of the functions listed below:
  124.  
  125.         i.      Display a new MenuFile with new options.
  126.         ii.     Display a TextFile for the user to read.
  127.         iii.    Play a music module (various formats supported).
  128.         iv.     Play a sound sample.
  129.         v.      Display a `slideshow' of pictures.
  130.         vi.     Play quiz game.
  131.         vii.    Execute an external program.
  132.  
  133.         When you click on a gadget which  has a function hooked on to
  134.         it, the gadget will highlight.  However,  some gadgets do not
  135.         have a function, so do not highlight.  There are some general
  136.         conventions which apply in MenuMode, as follows:
  137.  
  138.         i.      A gadget which contains  lower  case  text  is only a
  139.                 subtitle which  describes  the  gadgets  below.  This
  140.                 gadget does not change the current display or mode.
  141.         ii.     A gadget with upper  case  text  and three dots (...)
  142.                 following the text will show a new menu on the screen
  143.                 (by loading a new MenuFile).
  144.  
  145.         iii.    A  gadget  with  upper  case   text  and  no  tailing
  146.                 characters will execute one  of  the functions listed
  147.                 above.
  148.  
  149. 03      During Menu mode,  the  gadgets  around  the  screen have the
  150.         following functions:
  151.  
  152.         INFO    Brings up  an  info  requester  showing  the  current
  153.                 version  of  the  LCARS  software  and  the  software
  154.                 engineers involved in  its  development.  It  is also
  155.                 possible to quit the LCARS environment from here.
  156.  
  157.         MAIN    Will reload and redisplay the initial MenuFile.
  158.  
  159.         PREV    Will reload and redisplay the most previous MenuFile.
  160.                 In future this may  have  a  history, so it remembers
  161.                 your menu selections over a period of time.
  162.  
  163.         PREFS   This will bring up a screen from which you can change
  164.                 various aspects of LCARS operation  - more on this in
  165.                 section H.
  166.  
  167. 04      MenuMode also has many keyboard shortcuts  built in if you do
  168.         not wish to use the mouse. On  gadgets such as MAIN, PREV and
  169.         PREFS you will notice that one  of  the letters on the gadget
  170.         is underlined. Pressing this  key  on  the keyboard will have
  171.         the  same  affect  as  clicking  that  gadget.  Many  gadgets
  172.         throughout the whole LCARS environment  use this feature - so
  173.         look out for it.
  174.  
  175. 05      The selection of actual MenuGadgets  is also possible via the
  176.         keyboard. Pressing the UP or  DOWN  cursor key will display a
  177.         small cursor next to  a  MenuGadget.  Pressing  the UP, DOWN,
  178.         LEFT or RIGHT cursor keys  will  now  move this cursor around
  179.         the Menu. Pressing RETURN will  select the highlighted gadget
  180.         in a similar way  to  clicking  it.  Any  other keypress will
  181.         clear the cursor.
  182.  
  183.  
  184. D · TEXT MODE
  185.  
  186. 01      Text mode uses TextFiles  which  contain  data describing the
  187.         main and sub titles for  the  screen,  as  well as the actual
  188.         text and colours to display.
  189.  
  190. 02      When you first load a TextFile,  you will enter TextMode. The
  191.         screen display will change  and  you  will  see the TextFile,
  192.         along will seven gadgets on the  left side of the screen. You
  193.         may be thinking, "Phew. What a lot of gadgets!" But there are
  194.         more,  just  wait!  However,  the   first  set  will  be  the
  195.         following:
  196.  
  197.         INFO      Display information about the  features of TextMode
  198.                   and keyboard shortcuts.
  199.  
  200.         RETURN    Return to MenuMode with most recent MenuFile
  201.  
  202.         NEXT      Scroll the file down by one page
  203.  
  204.         PREV      Scroll the file up by one page
  205.  
  206.         NEXTLINE  Scroll the file down by one line
  207.  
  208.         PREVLINE  Scroll the file up by one line
  209.  
  210.         2nd MENU  Display the second set of gadgets
  211.  
  212.         If you click on  the  "2nd   MENU"  gadget,  the five gadgets
  213.         bottommost in the display  will  be  replaced  by  a new set,
  214.         detailed below (the INFO and RETURN gadgets remain the same):
  215.  
  216.         PRINT     If you have a printer  attached, use this gadget to
  217.                   dump the  TextFile  to  paper.  Printer preferences
  218.                   will be set up  to  the  EPSONX printer driver. You
  219.                   could replace  the  Devs/System-Configuration  file
  220.                   with your own  (1.2/1.3  users  only)  and copy the
  221.                   required  printer  driver  to  Devs/Printers/.  For
  222.                   2.0/3.0 users, it  may  be  more  trouble than it's
  223.                   worth to set up a  printer,  unless you have a copy
  224.                   of 1.3 Preferences at hand. The setting of printers
  225.                   may be a future addition to LCARS Prefs.
  226.  
  227.         TOP       Click this  gadget  to  move  to  the  top  of  the
  228.                   TextFile.
  229.  
  230.         GOTO      Not currently implemented (soon, I promise!)
  231.  
  232.         BOTTOM    Move to the bottom of the TextFile.
  233.  
  234.         1st MENU  Display the first set of gadgets, detailed above.
  235.  
  236. 03      In the top left-hand corner of the screen you should see some
  237.         text. This is information about  the  current position in the
  238.         TextFile:
  239.  
  240.                 xxx% How far into the file, in percent
  241.                 aaa/bbb Current page of Total pages
  242.  
  243.         This is mainly included for use  with the GOTO function, when
  244.         it is implemented.
  245.  
  246. 04      The design of TextMode is based around the famous `PPMore' so
  247.         if you are used to using  that  program, most of the commands
  248.         are the same.
  249.  
  250. 05      Clicking in the top half of the main text display will scroll
  251.         up one page (if  possible)  and  clicking  in the bottom half
  252.         will scroll down one page. For all you devpac users, pressing
  253.         CTRL-Up/Down arrow will move to the top or bottom of the file
  254.         respectively (along with T  and  B).  For more information on
  255.         keyboard shortcuts in  TextMode,  click  on  the  INFO gadget
  256.         while in TextMode - now, if you like!
  257.  
  258.  
  259. E · GFXMODE
  260.  
  261. 01      GfxMode is much simpler than  MenuMode or TextMode. It simply
  262.         displays a series  of  `IFF  ILBM'  picture  files, which you
  263.         advance through by clicking  the  left  mouse button. You can
  264.         terminate the slideshow  be  clicking  with  the  right mouse
  265.         button - a requester appears to confirm your decision.
  266.  
  267. 02      GfxMode uses a file known  as  a "GfxList" which simply lists
  268.         all the files required to be  displayed. While the picture is
  269.         loading, you can admire the United Federation of Planets logo
  270.         and the special animated LCARS wait pointer!
  271.  
  272. 03      Alternatively, a single picture  may  be  displayed - you can
  273.         terminate the viewing by pressing either mouse button.
  274.  
  275. 04      A future  enhancement  to  GfxMode  will  be  the  ability to
  276.         explicitly select which picture  of  a  slideshow you wish to
  277.         view, or all as  previously,  or  beginning from a particular
  278.         slide...
  279.  
  280.  
  281. F · QUIZMODE
  282.  
  283. 01      This is a game mode, where you can be asked various questions
  284.         about  ...  anything.  QuizMode   uses   a  custom  file-type
  285.         (QuizFiles) which  contain  data  describing  the  questions,
  286.         answers and comments upon answering a question.
  287.  
  288. 02      Once in QuizMode, the screen will show the first question (up
  289.         to a maximum of four  lines  of  text)  and a maximum of four
  290.         possible answers. Once you have read the question and thought
  291.         of your answer, you should click  on  the answer you think is
  292.         correct with the mouse pointer.  If  you are correct, you may
  293.         receive a comment about some little facet of life or possibly
  294.         an  extra  credit  (one  given  every  10  correct  answers).
  295.         However, if you are wrong you will loose a credit and be sent
  296.         to the Captain!
  297.  
  298. 03      Once you have answered, you can  press the RIGHT MOUSE BUTTON
  299.         to advance to the next question  (a message on screen reminds
  300.         you of this). At this point  your statistics will be updated.
  301.         If you look  to  the  right  of  the  portion  of the display
  302.         containing the answers, you will see:
  303.  
  304.         QUESTION ...... The number of questions asked.
  305.         CORRECT ....... Number you have answered correctly.
  306.         CREDITS ....... The number of credits remaining.
  307.  
  308. 04      At the of  the  game  you  will  have  3  credits, which will
  309.         decrease by one each time  you  get  an  answer wrong. If the
  310.         number of credits you have  reaches  zero,  the game will end
  311.         and display the status screen (see  below). If you answer ten
  312.         questions correctly, you will receive an extra credit.
  313.  
  314. 05      Once you have either answered  all  questions, or perhaps run
  315.         out of credits, the status screen  will appear. From here you
  316.         can either play again, or  return  to  MenuMode. Or you could
  317.         read the really interesting facts  and laugh at your acquired
  318.         StarFleet rank (with pips). Hah! You should try again.
  319.  
  320. 06      While in QuizMode, there are two main gadgets on the screen -
  321.         QUIT and RESET. Quit  will  display  the  status screen, with
  322.         options as  described  in  paragraph  05  above.  Reset  will
  323.         reshuffle the  questions,  give  you  three  credits  again -
  324.         basically, start the game again. Or, as they say, reset. If a
  325.         module is playing,  the  ubiquitous  STOP  gadget  will be on
  326.         screen. The LEAVE gadget is not implemented but when it is it
  327.         will allow you to leave  QuizMode  and return later with your
  328.         status intact.
  329.  
  330.  
  331. G · SOUNDMODE
  332.  
  333. 01      There are currently  two  modes  of  operation for SoundMode.
  334.         These are the ability to  play  sound samples and the ability
  335.         to play various types of music modules.
  336.  
  337. 02      Only raw samples are supported  (the  frequency to play at is
  338.         determined by data  in  the  MenuFile)  in  the  sample mode,
  339.         although various module type are supported for playing music:
  340.                 MED
  341.                 ProTracker v3
  342.                 StarTrekker v1.3
  343.                 SoundTracker v2.6
  344.  
  345. 03      When a module has loaded, a  gadget will appear in the bottom
  346.         left of the  LCARS  display  labelled  STOP.  Guess what this
  347.         does! It is not possible  to  load  other music modules while
  348.         one is  already  playing  without  first  selecting  the STOP
  349.         gadget. (A module may  also  be  stopped  by  loading a sound
  350.         sample.) If you have a module you  would like us to use, send
  351.         it in - but it must  be  in  one of the formats listed above.
  352.         Alternatively, if you  have  the  source  code  for  a module
  353.         player, send that in (as well). And that's it!
  354.  
  355. 04      In future, the STOP gadget  is  likely  to be replaced with a
  356.         CONTROL gadget. Current ideas are for volume, speed and track
  357.         position control from here. Also, a list of available modules
  358.         (by way of a  file  containing  that  list)  will be present,
  359.         allowing easy selection of any  module. This may also include
  360.         the selection of CD tracks if a CDROM drive is attached.
  361.  
  362.  
  363. H · PREFSMODE
  364.  
  365. 01      PrefsMode is where you  alter  your personal configuration of
  366.         LCARS. This is currently  only  the  color  palette, but will
  367.         expand in the future.
  368.  
  369. 02      PrefsMode currently  has  one  major  drawback  -  you  can't
  370.         actually save your Preferences!  Well,  this  is not strictly
  371.         true, but I can't tell you  how  to  do  it! It would seem as
  372.         though the whole of Infinite  Frontiers except me thinks this
  373.         is a bad idea! What do you think? If you want to see the save
  374.         function reactivated, TELL SIMON PLEASE!!!
  375.  
  376. 03      When you click on the PREFS  gadget from within MenuMode, you
  377.         will enter  PrefsMode.  The  screen  will  change, displaying
  378.         various gadgets with which you  make your configurations. The
  379.         screen gadgets will also have changed to the following:
  380.  
  381.         INFO    Interesting information about PrefsMode.
  382.         USE     Use the current settings, leave PrefsMode.
  383.         CANCEL  Leave PrefsMode, restoring old settings.
  384.         RESET   Restore settings to those before entering PrefsMode
  385.         DEFAULT Change settings to those used by LCARS in its default
  386.                 state.
  387.         (STOP)  Stop a currently playing module.
  388.  
  389. 04      With the Palette facilities it  is  possible  to change the 8
  390.         colors used  by  LCARS  to  your  personal  requirements. You
  391.         should see a large box with 3 smaller boxes inside. Along the
  392.         bottom of the larger box should be 8 gadgets - these are used
  393.         to select the color you  wish  to  edit.  By default, this is
  394.         white when you enter  PrefsMode.  To  edit a different color,
  395.         simply click on the  color  gadget  which corresponds to that
  396.         color. To the left of the  main  box  there  is a tall box of
  397.         which  the  internal  color  will  change  to  represent  the
  398.         currently  selected  color.  Try  clicking  on  a  few  color
  399.         selections to see what I mean.
  400.  
  401. 05      To the right of the  tall  box  are  three little boxes which
  402.         should contain letters/numbers. This is  the HEX value of the
  403.         red, green or blue component of the currently selected color.
  404.         (Red at the top, green in the  middle and blue at the bottom,
  405.         as shown by the three boxes to  the right of the main palette
  406.         display.)
  407.  
  408. 06      To edit the current color,  use  the  gadgets inside the main
  409.         box. These are sliders which move  from  one end to the other
  410.         and change the value of the corresponding component between 0
  411.         and $f (15). You can click and  hold the button and then drag
  412.         the mouse to see  the  effect  of  changing the color values,
  413.         since the color will change as you move the mouse. You should
  414.         not experience any problems since the operation is similar to
  415.         all palette programs.
  416.  
  417.  
  418. I · LCARS IN THE FUTURE
  419.  
  420. 01      LCARS  is  a  continually  expanding  project.  Some  of  the
  421.         features I wish to include in  the  future are the ability to
  422.         have multiple features running off  of  one MenuMode gadget -
  423.         ie. play a sample, load a  textfile  and then show a picture.
  424.         This is provisionally called  ScriptMode. Secondly, one other
  425.         major new feature I hope to include  is the mixing of gfx and
  426.         text on screen  -  PageMode.  I  would  also  like to include
  427.         support for standard IFF animations.
  428.  
  429. 02      Other minor  projected  improvements  should  be  -  the GOTO
  430.         feature in TextMode, the LEAVE  function  in QuizMode and all
  431.         the other suggestions scattered throughout this file.
  432.  
  433. 03      If you have any ideas which  you  think is feasible and would
  434.         add to the LCARS environment, please  send  them in. I can be
  435.         contacted via the usual INFINITE  FRONTIERS address or at the
  436.         address at the top of this file.
  437.  
  438.  
  439. Luke Elliott, 16/04/1994.
  440.