Warning, /games/ksnakeduel/doc/index.docbook is written in an unsupported language. File is not indexed.

0001 <?xml version="1.0" ?>
0002 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
0003   <!ENTITY ksnakeduel "<application>KSnakeDuel</application>">
0004   <!ENTITY % addindex "IGNORE">
0005   <!ENTITY % English "INCLUDE">
0006 ]>
0007 
0008 <book id="ksnakeduel" lang="&language;">
0009 <bookinfo>
0010 <title>The &ksnakeduel; Handbook</title>
0011 
0012 <authorgroup>
0013 <author>
0014 <firstname>Fabian</firstname>
0015 <surname>Dal Santo</surname>
0016 <affiliation>
0017 <address>&Fabian.DalSanto.mail;</address>
0018 </affiliation>
0019 </author>
0020 
0021 <author>
0022 <firstname>Stas</firstname>
0023 <surname>Verberkt</surname>
0024 <affiliation>
0025 <address>&Stas.Verberkt.mail;</address>
0026 </affiliation>
0027 </author>
0028 
0029 <othercredit role="reviewer">
0030 <firstname>Lauri</firstname>
0031 <surname>Watts</surname>
0032 <affiliation>
0033 <address>&Lauri.Watts.mail;</address>
0034 </affiliation>
0035 <contrib>Reviewer</contrib>
0036 </othercredit>
0037 <!-- TRANS:ROLES_OF_TRANSLATORS-->
0038 </authorgroup>
0039 
0040 <copyright>
0041 <year>1999</year>
0042 <year>2000</year>
0043 <holder>&Matthias.Kiefer;</holder>
0044 </copyright>
0045 
0046 <copyright>
0047 <year>2001</year>
0048 <holder>&Fabian.Dal.Santo;</holder>
0049 </copyright>
0050 
0051 <copyright>
0052 <year>2009</year>
0053 <holder>&Stas.Verberkt;</holder>
0054 </copyright>
0055 
0056 <legalnotice>&FDLNotice;</legalnotice>
0057 
0058 <date>2021-08-17</date>
0059 <releaseinfo>2.1 (KDE Gear 21.08)</releaseinfo>
0060 
0061 <abstract>
0062 <para>
0063 &ksnakeduel; is a simple snake duel game, which you can play alone or against a friend.
0064 </para>
0065 </abstract>
0066 
0067 <keywordset>
0068 <keyword>KDE</keyword>
0069 <keyword>kdegames</keyword>
0070 <keyword>KTron</keyword>
0071 <keyword>KSnakeDuel</keyword>
0072 <keyword>game</keyword>
0073 <keyword>tron</keyword>
0074 <keyword>snakeduel</keyword>
0075 <keyword>KSnake</keyword>
0076 <keyword>snake</keyword>
0077 <keyword>duel</keyword>
0078 </keywordset>
0079 </bookinfo>
0080 
0081 <chapter id="introduction">
0082 <title>Introduction</title>
0083 
0084 <para>
0085 &ksnakeduel; is a simple snake duel game. You can play against the computer
0086 or a friend. The aim of the game is to live longer than your opponent. To do
0087 that, avoid running into a wall, your own tail and that of your opponent.
0088 </para>
0089 
0090 <para>
0091 &ksnakeduel; is a simple Snake-like game. The aim is to survive as long as
0092 possible and eat as many fruits as you can.
0093 </para>
0094 
0095 <para>
0096 You can switch between these games using the game type selector in the configuration dialog.
0097 </para>
0098 
0099 </chapter>
0100 
0101 <chapter id="playing-ktron">
0102 <title>Playing &ksnakeduel;</title>
0103 
0104 <sect1 id="playing-ktron-rules">
0105 <title>Rules</title>
0106 
0107 <para>
0108 Once a round is started, the players do not stop moving forward (unless the game
0109 is paused).  All you have to do is avoid crashing by changing your players
0110 direction. Additionally you can try to hinder your opponent.  For this it is
0111 possible to increase the velocity by pressing your accelerator key.
0112 </para>
0113 
0114 <para>
0115 A round starts when all human players press a direction key. The initial moving
0116 direction is then in this direction.
0117 </para>
0118 
0119 <para>
0120 If you want to interrupt playing, select the <menuchoice> <shortcut><keycombo
0121 action="simul"><keycap>P</keycap></keycombo></shortcut> <guimenu>Game</guimenu>
0122 <guimenuitem>Pause</guimenuitem></menuchoice> menu item.  Additionally the game
0123 is paused when the game loses the keyboard focus, &eg; when switching to an other window.
0124 </para>
0125 
0126 <para>
0127 To continue the game, select again this menu item or hit the keyboard shortcut.
0128 The game will also continue if you press one of the direction keys. But be
0129 careful, your player switches to this direction immediately.
0130 </para>
0131 
0132 
0133 <para>A game consists of several rounds, and ends if a player has at least
0134 nine points, and additionally two more points than the opponent. The current
0135 score is always displayed in the status bar.
0136 </para>
0137 
0138 <para>
0139 You can change the difficulty level of the game using the
0140 <menuchoice><guimenu>Settings</guimenu> <guisubmenu>Difficulty</guisubmenu></menuchoice>
0141 submenu or the drop-down box on the status bar. The difficulty influences
0142 the speed of the game and the computer player.
0143 </para>
0144 </sect1>
0145 
0146 <sect1 id="computerplayer">
0147 <title>The Computer Player</title>
0148 
0149 <para>
0150 You can play against a computer. The difficulty level of the game influences the
0151 intelligence of the computer player.
0152 </para>
0153 <para>
0154 At low levels the computer doesn't care about the opponent and just moves
0155 around. At higher skill levels the computer tries to hinder the opponent when he
0156 comes near.
0157 </para>
0158 </sect1>
0159 
0160 <sect1 id="using-keyboard">
0161 <title>Using the Keyboard</title>
0162 
0163 <para>
0164 Each player has five keys. Four keys for changing the direction and one to
0165 accelerate.
0166 </para>
0167 
0168 <para>
0169 The direction keys do not have to be held down. Simply press them once to
0170 change
0171 the direction of your player.
0172 </para>
0173 
0174 <para>
0175 Acceleration only occurs while the acceleration key remains depressed.  When you
0176 release the acceleration key, velocity returns to normal.
0177 </para>
0178 
0179 <note><para>
0180 You can <ulink url="help:/fundamentals/shortcuts.html">alter the keys</ulink> using the
0181 <menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice>
0182 menu item.
0183 </para></note>
0184 </sect1>
0185 </chapter>
0186 
0187 <chapter id="playing-snake">
0188 <title>Playing KSnake mode</title>
0189 
0190 <sect1 id="playing-snake-rules">
0191 <title>Rules</title>
0192 
0193 <para>
0194 Once the game is started, the player does not stop moving forward (unless the
0195 game is paused). All you have to do is avoid crashing by changing your
0196 direction. A game starts when you press a direction key. The initial moving
0197 direction is then in this direction.
0198 </para>
0199 
0200 <para>
0201 If you want to pause playing, select the <menuchoice> <shortcut><keycombo
0202 action="simul"><keycap>P</keycap></keycombo></shortcut> <guimenu>Game</guimenu>
0203 <guimenuitem>Pause</guimenuitem></menuchoice> menu item or hit the keyboard
0204 shortcut. Additionally the game is paused when the game loses the keyboard
0205 focus, &eg; when switching to an other window.
0206 </para>
0207 
0208 <para>
0209 To continue the game, select again this menu item or hit the keyboard shortcut.
0210 The game will also continue if you press one of the direction keys. But be
0211 careful, your player switches to this direction immediately.
0212 </para>
0213 
0214 <para>
0215 In the game there will always be a piece of fruit on the map. If you collect it
0216 your score will increase with 5 points. The current score is always displayed in
0217 the status bar.
0218 </para>
0219 
0220 <para>
0221 When you are moving through the map there will also appear obstacles. Hitting them
0222 will also result in a crash. However, every time an obstacle appears and you
0223 survive you'll be rewarded 2 points
0224 </para>
0225 
0226 <para>
0227 You can change the difficulty level of the game using the
0228 <menuchoice><guimenu>Settings</guimenu> <guisubmenu>Difficulty</guisubmenu></menuchoice>
0229 submenu or the drop-down box on the status bar. The difficulty influences
0230 the speed of the game and the computer player.
0231 </para>
0232 
0233 </sect1>
0234 
0235 <sect1 id="using-keyboard-snake">
0236 <title>Using the keyboard</title>
0237 
0238 <para>
0239 Each player has four keys. These are used for changing the direction.
0240 The direction keys do not have to be held down. Simply press them once to change
0241 the direction of your player.
0242 </para>
0243 
0244 <note><para>
0245 You can <ulink url="help:/fundamentals/shortcuts.html">alter the keys</ulink> using the
0246 <menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice>
0247 menu item.
0248 </para></note>
0249 </sect1>
0250 
0251 </chapter>
0252 
0253 <chapter id="interface-overview">
0254 <title>Interface Overview</title>
0255 
0256 <sect1 id="menu-items">
0257 <title>Menu Items</title>
0258 
0259 <para>The following list briefly describes each menubar option.</para>
0260 
0261 <variablelist>
0262 <varlistentry>
0263 <term><menuchoice>
0264 <shortcut>
0265 <keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
0266 </shortcut>
0267 <guimenu>Game</guimenu>
0268 <guimenuitem>New</guimenuitem>
0269 </menuchoice></term>
0270 <listitem><para><action>Starts a new game.</action></para></listitem>
0271 </varlistentry>
0272 
0273 <varlistentry>
0274 <term><menuchoice>
0275 <shortcut>
0276 <keycap>P</keycap>
0277 </shortcut>
0278 <guimenu>Game</guimenu>
0279 <guimenuitem>Pause</guimenuitem>
0280 </menuchoice></term>
0281 <listitem><para><action>Toggles whether the game is paused.</action></para></listitem>
0282 </varlistentry>
0283 
0284 <varlistentry>
0285 <term><menuchoice>
0286 <shortcut>
0287 <keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo>
0288 </shortcut>
0289 <guimenu>Game</guimenu>
0290 <guimenuitem>Show High Scores</guimenuitem>
0291 </menuchoice></term>
0292 <listitem><para><action>Displays the high score table.</action></para></listitem>
0293 </varlistentry>
0294 
0295 <varlistentry>
0296 <term><menuchoice>
0297 <shortcut>
0298 <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
0299 </shortcut>
0300 <guimenu>Game</guimenu>
0301 <guimenuitem>Quit</guimenuitem>
0302 </menuchoice></term>
0303 <listitem><para><action>Quit &ksnakeduel;.</action></para></listitem>
0304 </varlistentry>
0305 
0306 <varlistentry>
0307 <term><menuchoice>
0308 <guimenu>Settings</guimenu>
0309 <guimenuitem>Difficulty</guimenuitem>
0310 </menuchoice></term>
0311 <listitem><para><action>A submenu that allows you to change the difficulty
0312 level of the game.</action></para></listitem>
0313 </varlistentry>
0314 
0315 <varlistentry>
0316 <term><menuchoice>
0317 <guimenu>Settings</guimenu>
0318 <guimenuitem>Configure &ksnakeduel;...</guimenuitem>
0319 </menuchoice></term>
0320 <listitem><para><action>Opens a <link linkend="configuration">comprehensive dialog</link>
0321 to configure various options.</action></para></listitem>
0322 </varlistentry>
0323 </variablelist>
0324 
0325 <para>
0326 Additionally &ksnakeduel; has the common &kde; <guimenu>Settings</guimenu> and <guimenu>Help</guimenu>
0327 menu items, for more information read the sections about the
0328 <ulink url="help:/fundamentals/menus.html#menus-settings">Settings Menu</ulink> and
0329 <ulink url="help:/fundamentals/menus.html#menus-help">Help Menu</ulink> of the &kde; Fundamentals.
0330 </para>
0331 
0332 </sect1>
0333 
0334 <sect1 id="keys">
0335 <title>Default Shortcuts</title>
0336 
0337 <para>The following tables show you the default shortcuts.</para>
0338 
0339 
0340 <table>
0341 <title>Player 1 Shortcuts</title>
0342 <tgroup cols="2">
0343 <thead>
0344 <row>
0345 <entry>Key Combo</entry>
0346 <entry>Action</entry>
0347 </row>
0348 </thead>
0349 <tbody>
0350 <row>
0351 <entry>&Up; arrow</entry>
0352 <entry>Move up</entry>
0353 </row>
0354 <row>
0355 <entry>&Down; arrow</entry>
0356 <entry>Move down</entry>
0357 </row>
0358 <row>
0359 <entry>&Right; arrow</entry>
0360 <entry>Move on the right</entry>
0361 </row>
0362 <row>
0363 <entry>&Left; arrow</entry>
0364 <entry>Move on the left</entry>
0365 </row>
0366 <row>
0367 <entry><keycap>0</keycap></entry>
0368 <entry>Accelerate</entry>
0369 </row>
0370 </tbody>
0371 </tgroup>
0372 </table>
0373 
0374 <table>
0375 <title>Player 2 Shortcuts</title>
0376 <tgroup cols="2">
0377 <thead>
0378 <row>
0379 <entry>Key Combo</entry>
0380 <entry>Action</entry></row></thead>
0381 <tbody>
0382 <row>
0383 <entry><keycap>R</keycap></entry>
0384 <entry>Move up</entry>
0385 </row>
0386 <row>
0387 <entry><keycap>F</keycap></entry>
0388 <entry>Move down</entry>
0389 </row>
0390 <row>
0391 <entry><keycap>G</keycap></entry>
0392 <entry>Move on the right</entry>
0393 </row>
0394 <row>
0395 <entry><keycap>D</keycap></entry>
0396 <entry>Move on the left</entry>
0397 </row>
0398 <row>
0399 <entry><keycap>A</keycap></entry>
0400 <entry>Accelerate</entry>
0401 </row>
0402 </tbody>
0403 </tgroup>
0404 </table>
0405 
0406 <table>
0407 <title>General Shortcuts</title>
0408 <tgroup cols="2">
0409 <thead>
0410 <row>
0411 <entry>Key Combo</entry>
0412 <entry>Action</entry>
0413 </row>
0414 </thead>
0415 <tbody>
0416 <row>
0417 <entry><keycap>P</keycap></entry>
0418 <entry>Pause/Resume the Game</entry>
0419 </row>
0420 <row>
0421 <entry><keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo></entry>
0422 <entry>High Scores</entry>
0423 </row>
0424 <row>
0425 <entry><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></entry>
0426 <entry>New Game</entry>
0427 </row>
0428 <row>
0429 <entry><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></entry>
0430 <entry>Quit &ksnakeduel;</entry>
0431 </row>
0432 <row>
0433 <entry><keycap>F1</keycap></entry>
0434 <entry>This Manual</entry>
0435 </row>
0436 <row>
0437 <entry><keycombo
0438 action="simul">&Shift;<keycap>F1</keycap></keycombo></entry>
0439 <entry>What's This help</entry>
0440 </row>
0441 </tbody>
0442 </tgroup>
0443 </table>
0444 
0445 <para>
0446 These shortcuts <ulink url="help:/fundamentals/shortcuts.html">can be changed</ulink> by selecting the
0447 <menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice>
0448 menu item.
0449 </para>
0450 
0451 </sect1>
0452 
0453 </chapter>
0454 
0455 <chapter id="configuration">
0456 
0457 <title>The Configuration Dialog</title>
0458 
0459 <para>Selecting the <menuchoice><guimenu>Settings</guimenu>
0460 <guimenuitem>Configure &ksnakeduel;...</guimenuitem></menuchoice> menu item will open a further dialog
0461 which lets you tweak &ksnakeduel;'s behavior.</para>
0462 
0463 <para>This dialog is divided into two pages.</para>
0464 
0465 <sect1 id="configuration-general">
0466 <title>General Configuration</title>
0467 
0468 <screenshot>
0469 <screeninfo>Configure &ksnakeduel; - General</screeninfo>
0470         <mediaobject>
0471           <imageobject>
0472             <imagedata fileref="settings-general.png" format="PNG"/>
0473           </imageobject>
0474             <textobject>
0475             <phrase>General Configuration</phrase>
0476           </textobject>
0477         </mediaobject>
0478 </screenshot>
0479 
0480 <variablelist>
0481 <varlistentry>
0482 <term><guilabel>Game type</guilabel></term>
0483 <listitem><para>This will let you change the game type. There are three options:
0484 
0485 <variablelist>
0486   <varlistentry>
0487     <term><guimenuitem>&ksnakeduel;: Player vs Player</guimenuitem></term>
0488     <listitem><para>A &ksnakeduel; game between two human players.</para></listitem>
0489   </varlistentry>
0490 
0491   <varlistentry>
0492     <term><guimenuitem>&ksnakeduel;: Player vs Computer</guimenuitem></term>
0493     <listitem><para>A &ksnakeduel; game between a human player and the computer.</para></listitem>
0494   </varlistentry>
0495 
0496   <varlistentry>
0497     <term><guimenuitem>KSnake mode: Single player</guimenuitem></term>
0498     <listitem><para>A single player &ksnakeduel; game.</para></listitem>
0499   </varlistentry>
0500 </variablelist>
0501 
0502 </para></listitem>
0503 </varlistentry>
0504 
0505 <varlistentry>
0506 <term><guilabel>Disable acceleration</guilabel></term>
0507 <listitem><para>Checking this box will disable the acceleration feature -
0508 pressing the acceleration key will have no effect, both vehicles will always
0509 travel with constant velocity.</para></listitem>
0510 </varlistentry>
0511 
0512 <varlistentry>
0513 <term><guilabel>Player Names</guilabel></term>
0514 <listitem><para>Specify custom names to use for the players to override the
0515 use of default ones.</para>
0516 <para>
0517 The default name for player one is the name of the current logged in
0518 user.
0519 </para></listitem>
0520 </varlistentry>
0521 
0522 <varlistentry>
0523 <term><guilabel>Game Options</guilabel></term>
0524 <listitem><para>Specify the <guilabel>Rounds to win:</guilabel> to define how many
0525 rounds are required before a winner is declared.</para></listitem>
0526 </varlistentry>
0527 
0528 </variablelist>
0529 </sect1>
0530 
0531 <sect1 id="configuration-theme">
0532 <title>Theme Configuration</title>
0533 
0534 <screenshot>
0535 <screeninfo>Configure &ksnakeduel; - Theme</screeninfo>
0536         <mediaobject>
0537           <imageobject>
0538             <imagedata fileref="settings-theme.png" format="PNG"/>
0539           </imageobject>
0540             <textobject>
0541             <phrase>Theme Configuration</phrase>
0542           </textobject>
0543         </mediaobject>
0544 </screenshot>
0545 
0546 <para>
0547 This page will allow you to change the theme &ksnakeduel; uses.
0548 </para>
0549 </sect1>
0550 </chapter>
0551 
0552 <!-- credits chapter done -->
0553 <chapter id="credits">
0554 <title>Credits and License</title>
0555 
0556 <para>
0557 &ksnakeduel;
0558 </para>
0559 
0560 <para>Program Copyright 1998-2000 &Matthias.Kiefer;
0561 &Matthias.Kiefer.mail;
0562 </para>
0563 
0564 <para>Program Copyright 2008-2009 &Stas.Verberkt;
0565 &Stas.Verberkt.mail;
0566 </para>
0567 
0568 <para>
0569 Parts of the code are from xtron-1.1 by Rhett D. Jacobs
0570 <email>rhett@hotel.canberra.edu.au&gt;</email>
0571 </para>
0572 
0573 <para>
0574 Documentation Copyright 1999 &Matthias.Kiefer;
0575 &Matthias.Kiefer.mail;
0576 </para>
0577 
0578 <para>Documentation updated for &kde; 2.0 by &Fabian.Dal.Santo;
0579 &Fabian.DalSanto.mail;</para>
0580 
0581 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
0582 &underFDL;
0583 &underGPL;
0584 </chapter>
0585 
0586 </book>
0587 <!--
0588 Local Variables:
0589 mode: sgml
0590 sgml-omittag: nil
0591 sgml-shorttag: t
0592 End:
0593 -->
0594