~ubuntu-branches/ubuntu/intrepid/gnome-games/intrepid-updates

« back to all changes in this revision

Viewing changes to gnibbles/help/C/gnibbles.sgml

  • Committer: Package Import Robot
  • Author(s): Jose Carlos Garcia Sogo
  • Date: 2002-02-15 20:12:21 UTC
  • Revision ID: package-import@ubuntu.com-20020215201221-pntf81dxhsatz4qy
Tags: upstream-1.4.0.3
ImportĀ upstreamĀ versionĀ 1.4.0.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
 
2
        <!-- if not using PNG graphic, replace reference above with
 
3
             .....PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[
 
4
         -->
 
5
<!ENTITY VERSION "1.2.0">
 
6
]>
 
7
 
 
8
 
 
9
<!-- =============Document Header ============================= -->
 
10
 
 
11
<article id="index"> <!-- please do not change the id -->
 
12
 
 
13
 <artheader>
 
14
  <title>Gnibbles Manual</title>
 
15
  <copyright>
 
16
   <year>2000</year>
 
17
   <holder>Kevin Breit</holder>
 
18
  </copyright>
 
19
 
 
20
  <!-- translators: uncomment this:
 
21
 
 
22
  <copyright>
 
23
   <year>2000</year>
 
24
   <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
 
25
  </copyright>
 
26
 
 
27
   -->
 
28
 
 
29
  <!-- do not put authorname in the header except in copyright - use
 
30
  section "authors" below -->
 
31
 
 
32
<legalnotice id="legalnotice">
 
33
      <para>
 
34
        Permission is granted to copy, distribute and/or modify this document
 
35
        under the terms of the <ulink type="help" url="gnome-help:fdl">
 
36
        <citetitle>GNU Free Documentation License</citetitle></ulink>, Version 
 
37
        1.1 or any later version published by the
 
38
        Free Software Foundation with no Invariant Sections, no Front-Cover
 
39
        Texts, and no Back-Cover Texts. You may obtain a copy of the
 
40
        <citetitle>GNU Free Documentation License</citetitle> from the Free
 
41
        Software Foundation by visiting <ulink type="http"
 
42
                                               url="http://www.fsf.org">their
 
43
        Web site</ulink> or by writing to: Free Software Foundation, Inc., 59
 
44
        Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
45
      </para>
 
46
      <para>
 
47
        Many of the names used by companies to distinguish their products and
 
48
        services are claimed as trademarks. Where those names appear in any
 
49
        GNOME documentation, and those trademarks are made aware to the members
 
50
        of the GNOME Documentation Project, the names have been printed in caps
 
51
        or initial caps.
 
52
      </para>
 
53
    </legalnotice>
 
54
 
 
55
  <!-- this is the version of manual, not application --> 
 
56
  <releaseinfo>
 
57
   This is version 1.0 of Gnibbles manual.
 
58
  </releaseinfo>
 
59
 
 
60
 </artheader>
 
61
 
 
62
 <!-- ============= Document Body ============================= -->
 
63
 
 
64
 <!-- ============= Introduction ============================== -->
 
65
 <sect1 id="intro">
 
66
  <title>Introduction</title>
 
67
 
 
68
  <para>
 
69
   <application>Gnibbles</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. 
 
70
  </para>
 
71
 
 
72
  <para>
 
73
   To run <application>Gnibbles</application>, select
 
74
   <menuchoice>
 
75
    <guisubmenu>games</guisubmenu>
 
76
    <guimenuitem>Gnibbles</guimenuitem>
 
77
   </menuchoice>
 
78
   from the <guimenu>Main Menu</guimenu>, or type
 
79
   <command>Gnibbles</command> on the command line. 
 
80
  </para>
 
81
 
 
82
  <para>
 
83
   <application>Gnibbles</application> is included in the
 
84
   <filename>gnome-games</filename> package, which is part of the
 
85
   GNOME desktop environment. This document describes version
 
86
   &VERSION; of <application>Gnibbles</application>.
 
87
  </para>
 
88
 </sect1>
 
89
 
 
90
 <sect1 id="objective">
 
91
 <title>Gnibbles Objective</title>
 
92
  <para>
 
93
    The objective of Gnibbles is quite simple.  You control the snake and
 
94
    if the snake runs into a wall or runs into itself, you die.  You get three
 
95
    lives before your game is over.  You win by either beating your own high
 
96
    score (or a friends) or by completing all the levels.
 
97
  </para>
 
98
 </sect1>
 
99
 
 
100
 <!-- ================ Usage ================================ -->
 
101
 <!-- This section should describe basic usage of the application. -->
 
102
 
 
103
 <sect1 id="usage">
 
104
  <title>Using Gnibbles</title>
 
105
  <para>
 
106
   <application>Gnibbles</application> is a simple game to play.  The only keys
 
107
   that are needed are the arrow keys.
 
108
  </para>
 
109
 
 
110
  <!-- ========= Basic Usage =========================== -->
 
111
<sect2 id="mainwin">
 
112
<title>Basic usage</title>
 
113
<para>
 
114
Starting <application>Gnibbles</application> opens 
 
115
the <interface>main window</interface> shown below.
 
116
<figure id="intro-fig">
 
117
<title>Gnibbles Introduction Window</title>
 
118
<screenshot>
 
119
<screeninfo>Gnibbles Introduction Window</screeninfo>
 
120
<graphic fileref="figures/intro" format="png"
 
121
srccredit="Kevin Breit">
 
122
</graphic>
 
123
</screenshot>
 
124
</figure>
 
125
</para>
 
126
<para>
 
127
To start the game, click on the intro screen, shown above.  The game
 
128
will automatically start.
 
129
</para>
 
130
<para>
 
131
When the game starts, the snake will come out of the left side of the
 
132
screen.  You use the up arrow to make the direction of the snake go up.
 
133
Use the right arrow to turn the snake right, left arrow to turn the snake
 
134
left, and down arrow to turn the snake down.
 
135
<figure id="gameplay">
 
136
<title>Gnibbles During Gameplay</title>
 
137
<screenshot>
 
138
 <screeninfo>Gnibbles During Gameplay</screeninfo>
 
139
 <graphic fileref="figures/playing" format="png"
 
140
   srccredit="Kevin Breit">
 
141
 </graphic>
 
142
</screenshot>
 
143
</figure>
 
144
</para>
 
145
</sect2>
 
146
 
 
147
<!-- This section should also describe main elements of graphic user
 
148
interface, such as menus and buttons, unless this description
 
149
is too long - in that case, it should be moved to a separate
 
150
section. For example -->
 
151
 
 
152
 
 
153
<!-- ========= Menus =========================== -->
 
154
<sect2 id="menubar">
 
155
   <title>Menus</title>
 
156
   <para>
 
157
    The menu bar, located at the top of the <interface>Main
 
158
    Window</interface>, contains the following menus:
 
159
   </para>
 
160
 
 
161
   <variablelist>
 
162
    <varlistentry>
 
163
     <term><guimenu>Game</guimenu></term>
 
164
     <listitem>
 
165
      <para>
 
166
       This menu contains:
 
167
       <itemizedlist>
 
168
        <listitem>
 
169
         <para>
 
170
          <menuchoice>
 
171
           <shortcut>
 
172
            <keysym>Ctrl+N</keysym>
 
173
           </shortcut>
 
174
           <guimenuitem>New Game</guimenuitem>
 
175
          </menuchoice>
 
176
          &mdash; This starts a new game of <application>Gnibbles</application>
 
177
         </para>
 
178
        </listitem>
 
179
        <listitem>
 
180
         <para>
 
181
          <menuchoice>
 
182
           <guimenuitem>Pause game</guimenuitem>
 
183
          </menuchoice>
 
184
          &mdash; This will pause your game.  Click on the <quote>Pause Game
 
185
          </quote> menu option to resume game.
 
186
         </para>
 
187
        </listitem>
 
188
        <listitem>
 
189
         <para>
 
190
          <menuchoice>
 
191
           <guimenuitem>Scores</guimenuitem>
 
192
          </menuchoice>
 
193
          &mdash; This shows the high scores.
 
194
         </para>
 
195
        </listitem>
 
196
        <listitem>
 
197
         <para>
 
198
          <menuchoice>
 
199
           <shortcut>
 
200
            <keysym>Ctrl-Q</keysym>
 
201
           </shortcut>
 
202
           <guimenuitem>Exit</guimenuitem>
 
203
          </menuchoice>
 
204
          &mdash; This quits the application.
 
205
         </para>
 
206
        </listitem>
 
207
       </itemizedlist>
 
208
      </para>
 
209
     </listitem>
 
210
    </varlistentry>
 
211
 
 
212
    <varlistentry>
 
213
     <term><guimenu>Settings</guimenu></term>
 
214
     <listitem>
 
215
      <para>
 
216
       This menu contains:
 
217
       <itemizedlist>
 
218
        <listitem>
 
219
         <para>
 
220
          <menuchoice>
 
221
           <guimenuitem>Preferences</guimenuitem>
 
222
          </menuchoice>
 
223
           &mdash; This opens your window to edit <link linkend="prefs">
 
224
           preferences.</link>
 
225
         </para>
 
226
        </listitem>
 
227
       </itemizedlist>
 
228
      </para>
 
229
     </listitem>
 
230
    </varlistentry>   
 
231
 
 
232
    <varlistentry>
 
233
     <term><guimenu>About</guimenu></term>
 
234
     <listitem>
 
235
      <para>
 
236
       This menu contains:
 
237
       <itemizedlist>
 
238
        <listitem>
 
239
         <para>
 
240
          <guimenuitem>About</guimenuitem> &mdash; This opens the
 
241
          <interface>About</interface> dialog which shows
 
242
          basic information about
 
243
          <application>Gnibbles</application>, such as
 
244
          the author's name, the application version number, and the
 
245
          URL for the application's Web page if one exists.
 
246
         </para>
 
247
        </listitem>
 
248
       </itemizedlist>
 
249
      </para>
 
250
     </listitem>
 
251
    </varlistentry>
 
252
   </variablelist>
 
253
  </sect2>
 
254
  <sect2 id="diamonds">
 
255
  <title>Diamonds</title>
 
256
   <para>
 
257
    <application>Gnibbles</application> has numerous different diamonds
 
258
    which to eat.  They each are a different color and serve a different
 
259
    function.
 
260
    <variablelist>
 
261
     <varlistentry>
 
262
      <term>Purple Diamond</term>
 
263
      <listitem>
 
264
       <para>
 
265
        Gives you one diamond credit and adds length to your snake.
 
266
       </para>
 
267
      </listitem>
 
268
     </varlistentry>
 
269
     <varlistentry>
 
270
      <term>Yellow Diamond</term>
 
271
      <listitem>
 
272
       <para>
 
273
        Gives 12 points, adds length to the snake and gives you one
 
274
        diamond credit.
 
275
      </para>
 
276
     </listitem>
 
277
    </varlistentry>
 
278
    <varlistentry>
 
279
     <term>Red Diamond</term>
 
280
     <listitem>
 
281
      <para>
 
282
       Gives 11 points, makes your snake shorter, and gives you one 
 
283
       diamond credit.
 
284
      </para>
 
285
     </listitem>
 
286
    </varlistentry>
 
287
   </variablelist>
 
288
  </para>
 
289
  </sect2>   
 
290
 </sect1>
 
291
 
 
292
 
 
293
 <!-- ============= Customization ============================= -->
 
294
 <sect1 id="prefs">
 
295
  <title>Customization</title>
 
296
  <para>
 
297
   To change the application settings, select
 
298
   <menuchoice>
 
299
    <guimenu>Settings</guimenu>
 
300
    <guimenuitem>Preferences...</guimenuitem>
 
301
   </menuchoice>.  This opens the
 
302
   <interface>Preferences</interface> dialog.
 
303
  </para>
 
304
 
 
305
  <figure id="game-prefs">
 
306
    <title>Game Preferences Tab</title>
 
307
    <screenshot>
 
308
      <screeninfo>Game Preferences Tab</screeninfo>
 
309
      <graphic fileref="figures/game" format="png" srccredit="Kevin Breit">
 
310
      </graphic>
 
311
    </screenshot>
 
312
  </figure>
 
313
 
 
314
  <para>
 
315
   The properties in the <guilabel>Game</guilabel> tab are:
 
316
   <variablelist>
 
317
    <varlistentry>
 
318
    <term>Speed</term>
 
319
    <listitem>
 
320
     <para>
 
321
      This controls the speed of the snake.
 
322
     </para>
 
323
    </listitem>
 
324
    </varlistentry>
 
325
    <varlistentry>
 
326
     <term>Levels in random order</term>
 
327
    <listitem>
 
328
     <para>
 
329
      Selecting this causes the level
 
330
      advancement to happen in random order.
 
331
     </para>
 
332
    </listitem>
 
333
    </varlistentry>
 
334
    <varlistentry>
 
335
     <term>Fake bonuses</term>
 
336
    <listitem>
 
337
     <para>
 
338
      When enabled, this allows for two blue diamonds on
 
339
      the screen at a time.  One diamond makes you shrink instead of grow when
 
340
      eaten.
 
341
     </para>
 
342
    </listitem>
 
343
    </varlistentry>
 
344
    <varlistentry>
 
345
    <term>Sounds</term>
 
346
     <listitem>
 
347
      <para>
 
348
       Enables sounds. 
 
349
      </para>
 
350
     </listitem>
 
351
    </varlistentry>
 
352
   </variablelist>
 
353
  </para>
 
354
  <para>
 
355
  <figure id="graphics-prefs">
 
356
    <title>Graphics Preferences Tab</title>
 
357
    <screenshot>
 
358
      <screeninfo>Graphics Preferences Tab</screeninfo>
 
359
      <graphic fileref="figures/graphics" format="png" srccredit="Kevin Breit">
 
360
      </graphic>
 
361
    </screenshot>
 
362
  </figure>
 
363
 
 
364
   The properties in the <guilabel>Graphics</guilabel> tab are:
 
365
   <itemizedlist>
 
366
 
 
367
    <listitem>
 
368
     <para>
 
369
      (Tiny) &mdash; This button makes your board tiny (184x132). 
 
370
     </para>
 
371
    </listitem>
 
372
 
 
373
    <listitem>
 
374
     <para>
 
375
      (Small) &mdash; This button makes your board small (368x264).
 
376
     </para>
 
377
    </listitem>
 
378
 
 
379
    <listitem>
 
380
     <para>
 
381
      (Medium) &mdash; This button makes your board medium (460x330). 
 
382
     </para>
 
383
    </listitem>
 
384
 
 
385
    <listitem>
 
386
     <para>
 
387
      (Large) &mdash; This button makes your board large(736x528).
 
388
     </para>
 
389
    </listitem>
 
390
 
 
391
    <listitem>
 
392
     <para>
 
393
      (Extra Large) &mdash; This button makes your board extra large (920x660)
 
394
      &hellip;(description).
 
395
     </para>
 
396
    </listitem>
 
397
 
 
398
    <listitem>
 
399
     <para>
 
400
      (Huge) &mdash; This button makes your huge (1840x1320)
 
401
      &hellip;(description).
 
402
     </para>
 
403
    </listitem>
 
404
   </itemizedlist>
 
405
  </para>
 
406
  <para>
 
407
 
 
408
  <figure id="worm-prefs">
 
409
    <title>Worm Preferences Tab</title>
 
410
    <screenshot>
 
411
      <screeninfo>Worm Preferences Tab</screeninfo>
 
412
      <graphic fileref="figures/worm_op" format="png" srccredit="Kevin Breit">
 
413
      </graphic>
 
414
    </screenshot>
 
415
  </figure>
 
416
 
 
417
   The properties in the <guilabel>Worm 1 </guilabel>through <guilabel> Worm 
 
418
4</guilabel> tabs let you set controls for your different worms. 
 
419
  </para>
 
420
  <para>
 
421
    After you have made all the changes you want, click on
 
422
    <guibutton>OK</guibutton> to apply the changes and close the
 
423
    <interface>Preferences</interface> dialog. To cancel the changes
 
424
    and return to previous values, click the
 
425
    <guibutton>Close</guibutton> button.
 
426
  </para>
 
427
 
 
428
 </sect1>
 
429
 
 
430
 <sect1 id="bugs">
 
431
  <title>Known Bugs and Limitations</title>
 
432
  <para>
 
433
   This application has no known bugs.
 
434
  </para>
 
435
 </sect1>
 
436
 
 
437
 
 
438
<!-- ============= Authors ================================ -->
 
439
 
 
440
 <sect1 id="authors">
 
441
  <title>Authors</title>
 
442
  <para>
 
443
   <application>Gnibbles</application> was written by Sean MacIsaac 
 
444
   (<email>sjm@acm.org</email>) and Ian Peters (<email>itp@gnu.org</email>). 
 
445
   Please send all comments, suggestions, and bug reports to
 
446
   the authors. (Instructions for submitting bug reports can be found <ulink 
 
447
   url="http://bugs.gnome.org/Reporting.html" type="http"> on-line</ulink>.)
 
448
  </para> 
 
449
 
 
450
  <para>
 
451
   This manual was written by Kevin Breit 
 
452
   (<email>battery841@mypad.com</email>). Please send all comments and
 
453
   suggestions regarding this manual to the <ulink type="http"
 
454
   url="http://developer.gnome.org/projects/gdp">GNOME 
 
455
   Documentation Project</ulink> 
 
456
   by sending an email to <email>docs@gnome.org</email>. You can also
 
457
   add your comments online by using the <ulink type="http"
 
458
   url="http://www.gnome.org/gdp/doctable/">GNOME Documentation Status
 
459
   Table</ulink>.
 
460
  </para>
 
461
 
 
462
  <!-- For translations: uncomment this:
 
463
 
 
464
  <para>
 
465
   Latin translation was done by ME
 
466
   (<email>MYNAME@MYADDRESS</email>). Please send all  comments  and
 
467
   suggestions regarding this translation to SOMEWHERE.
 
468
  </para>
 
469
 
 
470
  -->
 
471
 
 
472
 </sect1>
 
473
 
 
474
 
 
475
 <!-- ============= Application License ============================= -->
 
476
 
 
477
 <sect1 id="license">
 
478
  <title>License</title>
 
479
  <para>
 
480
   This program is free software; you can redistribute it and/or
 
481
   modify it under the terms of the <ulink type="help" url="gnome-help:gpl">
 
482
   <citetitle>GNU General Public
 
483
   License</citetitle></ulink> as published by the Free Software Foundation;
 
484
   either version 2 of the License, or (at your option) any later
 
485
   version.
 
486
  </para>
 
487
  <para>
 
488
   This program is distributed in the hope that it will be useful, but
 
489
   WITHOUT ANY WARRANTY; without even the implied warranty of
 
490
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
491
   <citetitle>GNU General Public License</citetitle> for more details.
 
492
  </para>
 
493
  <para>
 
494
   A copy of the <citetitle>GNU General Public License</citetitle> is
 
495
   included as an appendix to the <citetitle>GNOME Users
 
496
   Guide</citetitle>.  You may also obtain a copy of the
 
497
   <citetitle>GNU General Public License</citetitle> from the Free
 
498
   Software Foundation by visiting <ulink type="http"
 
499
   url="http://www.fsf.org">their Web site</ulink> or by writing to
 
500
   <address>
 
501
    Free Software Foundation, Inc.
 
502
    <street>59 Temple Place</street> - Suite 330
 
503
    <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>
 
504
    <country>USA</country>
 
505
   </address>
 
506
  </para>
 
507
 </sect1>
 
508
</article>
 
509