<?xml version="1.0"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
  <!ENTITY legal SYSTEM "legal.xml">
  <!ENTITY appversion "2.10">
  <!ENTITY manrevision "2.8">
  <!ENTITY date "September 2004">
  <!ENTITY app "<application>Nibbles</application>">
  <!ENTITY appname "Nibbles">
  <!ENTITY VERSION "2.8">
]>

<!-- 
      (Do not remove this comment block.)
  Maintained by the GNOME Documentation Project
  http://developer.gnome.org/projects/gdp
  Template version: 2.0 beta
  Template last modified Feb 12, 2002
-->

<!-- =============Document Header ============================= -->

<article id="index" lang="en">
<!-- please do not change the id; for translations, change lang to -->
<!-- appropriate code -->
 <articleinfo>
  <title>&app; Manual V&manrevision;</title>
  <copyright>
   <year>2000</year>
   <holder>Kevin Breit</holder>
  </copyright>

  <!-- translators: uncomment this:

  <copyright>
   <year>2000</year>
   <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
  </copyright>

   -->

<!-- An address can be added to the publisher information.  If a role is 
     not specified, the publisher/author is the same for all versions of the 
     document.  -->
    <publisher> 
      <publishername> GNOME Documentation Project </publishername> 
    </publisher> 

   &legal;
   <!-- This file  contains link to license for the documentation (GNU FDL), and 
        other legal stuff such as "NO WARRANTY" statement. Please do not change 
	any of this. -->

    <authorgroup> 
      <author> 
	<firstname>Kevin</firstname> 
	<surname>Breit</surname> 
	<affiliation> 
	  <orgname>GNOME Documentation Project</orgname> 
	  <address> <email>battery841@mypad.com</email> </address> 
	</affiliation> 
      </author> 
<!-- This is appropriate place for other contributors: translators,
      maintainers,  etc. Commented out by default.
       <othercredit role="translator">
	<firstname>Latin</firstname> 
	<surname>Translator 1</surname> 
	<affiliation> 
	  <orgname>Latin Translation Team</orgname> 
	  <address> <email>translator@gnome.org</email> </address> 
	</affiliation>
	<contrib>Latin translation</contrib>
      </othercredit>
-->
    </authorgroup>
    
    <revhistory>
      <revision> 
	<revnumber>&appname; Manual V&manrevision;</revnumber> 
	<date>&date;</date> 
	<revdescription> 
	  <para role="author">Kevin Breit
	    <email>battery841@mypad.com</email>
	  </para>
	  <para role="publisher">GNOME Documentation Project</para>
	</revdescription> 
      </revision> 
    </revhistory> 

    <releaseinfo>This manual describes version &appversion; of &appname;.
    </releaseinfo>
    <!-- The following feedback information only applies to appliactions
    listed in bugzilla.gnome.org and bugzilla.ximian.com. For other
    applications, please provide your own feedback info or remove thsi
    section altogether -->
    <legalnotice> 
      <title>Feedback</title> 
      <para>To report a bug or make a suggestion regarding the &app; application or
	this manual, follow the directions in the 
	<ulink url="ghelp:gnome-feedback"
	  type="help">GNOME Feedback Page</ulink>. 
      </para>
<!-- Translators may also add here feedback address for translations -->
    </legalnotice>
 </articleinfo>

  <indexterm zone="index"> 
    <primary>Nibbles</primary> 
  </indexterm> 

 <!-- ============= Document Body ============================= -->

 <!-- ============= Introduction ============================== -->
 <sect1 id="intro">
  <title>Introduction</title>

  <para>
   <application>Nibbles</application> is a game where the user controls a snake   .  The snake moves around the board, eating diamonds while avoiding the walls   placed around it. 
  </para>

  <para>
   To run <application>Nibbles</application>, select
   <menuchoice>
    <guisubmenu>games</guisubmenu>
    <guimenuitem>Nibbles</guimenuitem>
   </menuchoice>
   from the <guimenu>Main Menu</guimenu>, or type
   <command>Nibbles</command> on the command line. 
  </para>

  <para>
   <application>Nibbles</application> is included in the
   <filename>gnome-games</filename> package, which is part of the
   GNOME desktop environment. This document describes version
   &VERSION; of <application>Nibbles</application>.
  </para>
 </sect1>

 <sect1 id="objective">
 <title>Nibbles Objective</title>
  <para>
    The objective of Nibbles is quite simple.  You control the snake and
    if the snake runs into a wall or runs into itself, you die.  You get three
    lives before your game is over.  You win by either beating your own high
    score (or a friends) or by completing all the levels.
  </para>
 </sect1>

 <!-- ================ Usage ================================ -->
 <!-- This section should describe basic usage of the application. -->

 <sect1 id="usage">
  <title>Using Nibbles</title>
  <para>
   <application>Nibbles</application> is a simple game to play.  The only keys
   that are needed are the arrow keys.
  </para>

  <!-- ========= Basic Usage =========================== -->
<sect2 id="mainwin">
<title>Basic usage</title>
<para>
Starting <application>Nibbles</application> opens 
the <interface>main window</interface> shown below.
<figure id="intro-fig">
<title>Nibbles Introduction Window</title>
<screenshot>
 <mediaobject> 
    <imageobject>
<imagedata fileref="figures/intro.png" format="PNG" srccredit="Kevin Breit"/>
    </imageobject>
    <textobject> 
      <phrase>Nibbles Introduction Window.</phrase> 
    </textobject> 
  </mediaobject>
</screenshot>
</figure>
</para>
<para>
To start the game, select <menuchoice><guimenu>Game</guimenu>
<guimenuitem>New Game</guimenuitem></menuchoice>.
</para>
<para>
When the game starts, the snake will come out of the left side of the
screen.  You use the up arrow to make the direction of the snake go up.
Use the right arrow to turn the snake right, left arrow to turn the snake
left, and down arrow to turn the snake down.
<figure id="gameplay">
<title>Nibbles During Gameplay</title>
<screenshot>
  <mediaobject> 
    <imageobject>
  <imagedata fileref="figures/playing.png" format="PNG" srccredit="Kevin Breit"/>
    </imageobject>
    <textobject> 
      <phrase>Nibbles During Gameplay.</phrase> 
    </textobject> 
  </mediaobject>
</screenshot>
</figure>
</para>
</sect2>

<!-- This section should also describe main elements of graphic user
interface, such as menus and buttons, unless this description
is too long - in that case, it should be moved to a separate
section. For example -->


<!-- ========= Menus =========================== -->
<sect2 id="menubar">
   <title>Menus</title>
   <para>
    The menu bar, located at the top of the <interface>Main
    Window</interface>, contains the following menus:
   </para>

   <variablelist>
    <varlistentry>
     <term><guimenu>Game</guimenu></term>
     <listitem>
      <para>
       This menu contains:
       <itemizedlist>
        <listitem>
         <para>
          <menuchoice>
           <shortcut>
            <keysym>Ctrl+N</keysym>
           </shortcut>
           <guimenuitem>New Game</guimenuitem>
          </menuchoice>
          &mdash; This starts a new game of <application>Nibbles</application>
         </para>
        </listitem>
        <listitem>
         <para>
          <menuchoice>
           <guimenuitem>Pause game</guimenuitem>
          </menuchoice>
          &mdash; This will pause your game.  Click on the <quote>Pause Game
          </quote> menu option to resume game.
         </para>
        </listitem>
        <listitem>
         <para>
          <menuchoice>
           <guimenuitem>Scores</guimenuitem>
          </menuchoice>
          &mdash; This shows the high scores.
         </para>
        </listitem>
        <listitem>
         <para>
          <menuchoice>
           <guimenuitem>End Game</guimenuitem>
          </menuchoice>
          &mdash; End the current game and return to the title screen.
         </para>
        </listitem>
        <listitem>
         <para>
          <menuchoice>
           <shortcut>
            <keysym>Ctrl-Q</keysym>
           </shortcut>
           <guimenuitem>Exit</guimenuitem>
          </menuchoice>
          &mdash; This quits the application.
         </para>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><guimenu>Settings</guimenu></term>
     <listitem>
      <para>
       This menu contains:
       <itemizedlist>
        <listitem>
         <para>
          <menuchoice>
           <guimenuitem>Preferences</guimenuitem>
          </menuchoice>
           &mdash; This opens your window to edit <link linkend="prefs">
           preferences.</link>
         </para>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>   

    <varlistentry>
     <term><guimenu>Help</guimenu></term>
     <listitem>
      <para>
       This menu contains:
       <itemizedlist>
        <listitem>
          <para>
          <menuchoice>
           <shortcut>
            <keysym>F1</keysym>
           </shortcut>
           <guimenuitem>Contents</guimenuitem>
          </menuchoice>
          &mdash; Display this manual.
         </para>
         <para>
          <guimenuitem>About</guimenuitem> &mdash; This opens the
          <interface>About</interface> dialog which shows
          basic information about
          <application>Nibbles</application>, such as
          the author's name, the version number of the game.
         </para>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </sect2>
  <sect2 id="diamonds">
  <title>Diamonds</title>
   <para>
    <application>Nibbles</application> has numerous different
    diamonds to eat.  They are each a different color and serve
    a different function. Only the pale purple diamond is guaranteed
    to be around long enough for you to eat it (in fact, you have to
    eat them to finish the level). The other diamonds are all bonuses,
    but they only stick around for a short time. We'll leave it up to
    you to discover just what the bonus each colour gives, but they
    all affect either the score, the length of the worm, or both. Be careful
    when going for these bonus diamonds, don't cut yourself off from
    the ordinary diamonds that you need to finish the level.
  </para>
  </sect2>   
 </sect1>


 <!-- ============= Customization ============================= -->
 <sect1 id="prefs">
  <title>Customization</title>
  <para>
   To change the application settings, select
   <menuchoice>
    <guimenu>Settings</guimenu>
    <guimenuitem>Preferences</guimenuitem>
   </menuchoice>.  This opens the
   <interface>Preferences</interface> dialog. All preferences are
    automatically saved and applied as you change them.
  </para>

  <figure id="game-prefs">
    <title>Game Preferences Tab</title>
    <screenshot>
       <mediaobject> 
    <imageobject>
      <imagedata fileref="figures/game.png" format="PNG" srccredit="Kevin Breit"/>
          </imageobject>
    <textobject> 
      <phrase>Game Preferences Tab.</phrase> 
    </textobject> 
  </mediaobject>
    </screenshot>
  </figure>

  <para>
   The properties in the <guilabel>Game</guilabel> tab are:
   <variablelist>
    <varlistentry>
    <term>Speed</term>
    <listitem>
     <para>
      This controls the speed of the snake.
     </para>
    </listitem>
    </varlistentry>
    <varlistentry>
     <term>Play levels in random order</term>
    <listitem>
     <para>
      Selecting this causes the level
      advancement to happen in random order.
     </para>
    </listitem>
    </varlistentry>
    <varlistentry>
     <term>Enable fake bonuses</term>
    <listitem>
     <para>
      When enabled, this allows for two blue diamonds on
      the screen at a time.  One diamond makes you shrink instead of grow when
      eaten.
     </para>
    </listitem>
    </varlistentry>
    <varlistentry>
    <term>Enable sounds</term>
     <listitem>
      <para>
       Controls the use of sound in the game. 
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
    <term>Starting level</term>
     <listitem>
      <para>
       Which level to start with. Use this if you want to jump
       immediately to a challenging level.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
    <term>Number of players</term>
     <listitem>
      <para>
       There is room for up to four players.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
  <para>

  <figure id="worm-prefs">
    <title>Worm Preferences Tab</title>
    <screenshot>
       <mediaobject> 
    <imageobject>
  <imagedata fileref="figures/worm_op.png" format="PNG" srccredit="Kevin Breit"/>
         </imageobject>
    <textobject> 
      <phrase>Worm Preferences Tab.</phrase> 
    </textobject> 
  </mediaobject>
    </screenshot>
  </figure>

   The properties in the <guilabel>Worm 1 </guilabel>through <guilabel> Worm 
4</guilabel> tabs let you set individual preferences for the different worms. 

   <variablelist>
    <varlistentry>
    <term>Keyboard controls</term>
    <listitem>
     <para>
      This list let you change the keyboard controls for the given
      worm. To change a control, double click on the appropriate entry and
      then press the key you want to use for that control.
     </para>
    </listitem>
    </varlistentry>
    <varlistentry>
     <term>Use relative motion</term>
    <listitem>
     <para>
      Rather than left sending your worm toward the left of the screen,
      right toward the right and so on, the left and right keys make
      the worm perform a left or right turn. For example, if the worm
      is moving to the left and you press the left control it turns to
      head toward the bottom of the screen.
     </para>
    </listitem>
    </varlistentry>
    <varlistentry>
     <term>Worm color</term>
    <listitem>
     <para>
      Customize the color of your worm so you can tell it from your
      opponent's worm in multi-player mode.
     </para>
    </listitem>
    </varlistentry>
   </variablelist>

  </para>

 </sect1>

 <sect1 id="bugs">
  <title>Known Bugs and Limitations</title>
  <para>
   This application has no known bugs.
  </para>
 </sect1>


<!-- ============= Authors ================================ -->

 <sect1 id="authors">
  <title>Authors</title>
  <para>
   <application>Nibbles</application> was written by Sean MacIsaac 
   (<email>sjm@acm.org</email>) and Ian Peters (<email>itp@gnu.org</email>). 
   Please send all comments, suggestions, and bug reports to
   the authors. (Instructions for submitting bug reports can be found <ulink 
   url="http://bugs.gnome.org/Reporting.html" type="http"> on-line</ulink>.)
  </para> 

  <para>
   This manual was written by Kevin Breit 
   (<email>battery841@mypad.com</email>). Please send all comments and
   suggestions regarding this manual to the <ulink type="http"
   url="http://developer.gnome.org/projects/gdp">GNOME 
   Documentation Project</ulink> 
   by sending an email to <email>docs@gnome.org</email>. You can also
   add your comments online by using the <ulink type="http"
   url="http://www.gnome.org/gdp/doctable/">GNOME Documentation Status
   Table</ulink>.
  </para>

  <!-- For translations: uncomment this:

  <para>
   Latin translation was done by ME
   (<email>MYNAME@MYADDRESS</email>). Please send all  comments  and
   suggestions regarding this translation to SOMEWHERE.
  </para>

  -->

 </sect1>


 <!-- ============= Application License ============================= -->

 <sect1 id="license">
  <title>License</title>
  <para>
   This program is free software; you can redistribute it and/or
   modify it under the terms of the <ulink type="help" url="gnome-help:gpl">
   <citetitle>GNU General Public
   License</citetitle></ulink> as published by the Free Software Foundation;
   either version 2 of the License, or (at your option) any later
   version.
  </para>
  <para>
   This program is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   <citetitle>GNU General Public License</citetitle> for more details.
  </para>
  <para>
   A copy of the <citetitle>GNU General Public License</citetitle> is
   included as an appendix to the <citetitle>GNOME Users
   Guide</citetitle>.  You may also obtain a copy of the
   <citetitle>GNU General Public License</citetitle> from the Free
   Software Foundation by visiting <ulink type="http"
   url="http://www.fsf.org">their Web site</ulink> or by writing to
   <address>
    Free Software Foundation, Inc.
    <street>59 Temple Place</street> - Suite 330
    <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>
    <country>USA</country>
   </address>
  </para>
 </sect1>
</article>

