index.docbook 14.4 KB
Newer Older
1
<?xml version="1.0" ?>
Eugene Trounev's avatar
Eugene Trounev committed
2
<!--IMPORTANT: please note that'do not change this!' notice does not apply to translators -->
Laurent Montel's avatar
Laurent Montel committed
3
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
Eugene Trounev's avatar
Eugene Trounev committed
4
  <!ENTITY kappname "&ksquares;">
5
  <!ENTITY kappversion "0.4"><!--Applicaion version. Use this variable everywhere it's needed.-->
Eugene Trounev's avatar
Eugene Trounev committed
6
7
8
  <!ENTITY package "kdegames">  <!-- do not change this! -->
  <!ENTITY % English "INCLUDE" > <!-- change language only here -->
  <!ENTITY % addindex "IGNORE"> <!-- do not change this! -->
Matt Williams's avatar
Matt Williams committed
9
]>
Eugene Trounev's avatar
Eugene Trounev committed
10
 
Luigi Toscano's avatar
Luigi Toscano committed
11
<book id="ksquares" lang="&language;"> <!-- do not change this! -->
Matt Williams's avatar
Matt Williams committed
12
<bookinfo>
13
	<title>The &ksquares; Handbook</title> <!-- This is the title of the docbook. Leave as is unless change is necessary.-->
Eugene Trounev's avatar
Eugene Trounev committed
14
15
16
<!-- List of immidiate authors begins here. -->
<!--INPORTANT! - All other contributors: [to be determined] -->
<authorgroup>
Matt Williams's avatar
Matt Williams committed
17
    <author>
Eugene Trounev's avatar
Eugene Trounev committed
18

Matt Williams's avatar
Matt Williams committed
19
20
21
22
23
24
      <personname>
        <firstname>Matt</firstname>
        <surname>Williams</surname>
      </personname>
      <email>matt@milliams.com</email>
    </author>
Eugene Trounev's avatar
Eugene Trounev committed
25
26
27
28
29
<othercredit role="reviewer">
<firstname>Eugene</firstname><surname>Trounev</surname>
<contrib>Reviewer</contrib>
<affiliation><address>eugene.trounev@gmail.com</address></affiliation>
</othercredit>
30
    <!-- TRANS:ROLES_OF_TRANSLATORS -->
Matt Williams's avatar
Matt Williams committed
31
32
33
34
35
36
  </authorgroup>

  <copyright>
    <year>2006</year>
    <holder>Matt Williams</holder>
  </copyright>
37
<legalnotice>&FDLNotice;</legalnotice> 
38
<date>2013-05-05</date><!-- Date of (re)writing, or update.-->
39
<releaseinfo>&kappversion;</releaseinfo><!-- Application version number. Use the variable definitions within header to change this value.-->
Eugene Trounev's avatar
Eugene Trounev committed
40
41
42
 
<!--Short description of this document. Do not change unless necessary!-->
<abstract>
43
	<para>This documentation describes the game of &ksquares; version &kappversion;</para>
Eugene Trounev's avatar
Eugene Trounev committed
44
45
46
47
48
49
50
51
</abstract>
 
<!--List of relevan keywords-->
<keywordset>
	<keyword>KDE</keyword> <!-- do not change this! -->
	<keyword>kdegames</keyword> <!-- do not change this! -->
	<keyword>game</keyword> <!-- do not change this! -->
	<keyword>Ksquares</keyword><!--Application name goes here-->
Frederik Schwarzer's avatar
Frederik Schwarzer committed
52
<!-- Game genre. Use as many as necessary. Available game types are: Arcade, Board, Card, Dice, Toys, Logic, Strategy.-->
Eugene Trounev's avatar
Eugene Trounev committed
53
54
55
56
57
58
59
60
61
62
63
64
	<keyword>board</keyword>
	<keyword>Dots and Boxes</keyword>
	<keyword>Boxes</keyword>
	<keyword>Squares</keyword>
<!--Number of possible players. It can be: One, Two,..., Multiplayer-->
	<keyword>four players</keyword>
<!--All other relevant keywords-->
	<keyword>Paddocks</keyword>
	<keyword>Square-it</keyword>
	<keyword>Dots and Dashes</keyword>
	<keyword>Dot Game</keyword>
</keywordset>
Matt Williams's avatar
Matt Williams committed
65
</bookinfo>
Eugene Trounev's avatar
Eugene Trounev committed
66
67
<!--Content begins here: -->
<chapter id="introduction"><title>Introduction</title> <!-- do not change this! -->
Frederik Schwarzer's avatar
Frederik Schwarzer committed
68
	<note><title>Gametype:</title><para>Board</para></note><!-- Game genre. Use as many as necessary. Available game types are: Arcade, Board, Card, Dice, Toys, Logic, Strategy.-->
Eugene Trounev's avatar
Eugene Trounev committed
69
	<note><title>Number of possible players:</title><para>Four</para></note>
70
71
	<para>&ksquares; is a fun and exciting game for &kde; desktop environment. &ksquares; is modeled after the well known pen and paper based game of Dots and Boxes.</para>
<para>The idea behind &ksquares; is to construct squares by interconnecting the dots on the grid. Up to four players can play this game together, taking turns. The trick is – regardless of who has constructed most of the square, it is the player who completes the square that gets the point for it.</para>
Eugene Trounev's avatar
Eugene Trounev committed
72
<para>To win the game round player has to collect the most points by covering the most area with the squares of player's own color.</para>
Matt Williams's avatar
Matt Williams committed
73
</chapter>
Eugene Trounev's avatar
Eugene Trounev committed
74
 
Burkhard Lück's avatar
Burkhard Lück committed
75
<chapter id="howto"><title>How to Play</title> <!-- do not change this! -->
Eugene Trounev's avatar
Eugene Trounev committed
76
77
78
79
<!--IMPORTANT: If the game has no defined objective, please remove the below line.-->
	<note><title>Objective:</title><para>Complete more squares than any of your opponents.</para></note><!--Describe the objective of the game.-->
<!--How to play description. Don't be to specific on rules as they have a separate section in this document-->
	<para>
80
  At the start of the game, the game board is empty. There is simply a grid of dots showing where lines can be drawn.
Eugene Trounev's avatar
Eugene Trounev committed
81
82
83
84
</para>
<note><title>Note:</title><para>Depending on the game difficulty chosen, the game field may already contain lines at the beginning of the game round.</para></note>
  <para>Each player takes it in turns to draw a line between two adjacent dots on the board. By hovering the mouse over the game board, a yellow indicator line will show you where your line will be placed when you click.
  Once you have decided where you want to draw your line, click - and the line will be drawn.
85
86
  If by drawing a line, you completed a square then this square now belongs to you and earns you a point. Each time you complete a square, you must draw another line. If your line did not complete a square then the next player(s) take their turn.
  The game will continue until every square on the board is owned by one of the players.
Matt Williams's avatar
Matt Williams committed
87
  </para>
88
  <para>
Burkhard Lück's avatar
Burkhard Lück committed
89
  To start a new game with custom settings (number of players, player names, board size) click on the <guibutton>New</guibutton> toolbar button or go to <menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></shortcut><guimenu>Game</guimenu><guimenuitem>New</guimenuitem></menuchoice>. To start a new game with the same settings as the current game, click on <guibutton>Restart Game</guibutton> on the toolbar.
90
  </para>
Matt Williams's avatar
Matt Williams committed
91
</chapter>
Eugene Trounev's avatar
Eugene Trounev committed
92
93
94
95
96
 
<chapter id="rules_and_tips"><title>Game Rules, Strategies and Tips</title> <!-- do not change this! -->
	<!--This section has to do with game rules. Please give a detailed description of those using lists or paragraphs.-->
<sect1 id="rules">
  <title>Game Rules</title>
97
    <para>There is very little to be said when it come to the rules, as the game concept in itself is rather a simple one. Nevertheless, here are the game regulations you, as a player will defiantly face while playing &ksquares;:</para>
Eugene Trounev's avatar
Eugene Trounev committed
98
    <itemizedlist>
99
100
101
	<listitem><para>You may only connect the dots on the grid if they are not previously connected by you, your opponent, or the computer.</para></listitem>
	<listitem><para>To gain the points you have to connect the dots to form a square.</para></listitem>
	<listitem><para>The square can be no larger than the four adjacent dots on the grid allow for.</para></listitem>
Eugene Trounev's avatar
Eugene Trounev committed
102
	<listitem><para>Once a square is complete the player who draws the last line of that square is granted the right of possession over it. The square then is colored and the player is given a point.</para></listitem>
Burkhard Lück's avatar
Burkhard Lück committed
103
	<listitem><para>The player who completes the square is given an extra turn which the player cannot forfeit.</para></listitem>
Eugene Trounev's avatar
Eugene Trounev committed
104
105
106
107
108
109
110
    </itemizedlist>
</sect1>
<sect1 id="strategies">
  <title>Strategies and Tips</title>
  <itemizedlist>
	<listitem><para>Try not to play at random. Such game practice will most certainly result in loss.</para></listitem>
	<listitem><para>Construct long chains of lines over the gameboard. Once one such chain is complete start to build another one going parallel to the first.</para></listitem>
Yuri Chornoivan's avatar
Yuri Chornoivan committed
111
	<listitem><para>Try not to build contraptions where only one line remains undone. Your opponent will almost certainly take an advantage of it.</para></listitem>
Eugene Trounev's avatar
Eugene Trounev committed
112
	<listitem><para>If you are to let the opponent get a square or more, try to select the combination resulting in the least damage.</para></listitem>
113
114
	<listitem><para>Try to push your opponent into the situation where he/she(it) will have no choice but to let you get the square.</para></listitem>
	<listitem><para>If you are to get a chance to start completing a whole chain of squares, remember that by leaving two squares at the end of such chain incomplete you are pushing your opponent into completing them, thus giving you the opportunity to continue onto yet another chain. Such a situation is called the double-cross.</para></listitem>
Eugene Trounev's avatar
Eugene Trounev committed
115
116
117
    </itemizedlist>
</sect1>
</chapter>
118
  
119
120
121
<chapter id="menu-items">
  <title>Menu Items</title>
  <para>
Matt Williams's avatar
Matt Williams committed
122
    <variablelist>
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
      <varlistentry>
	<term>
	  <menuchoice>
	    <shortcut>
	      <keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
	    </shortcut>
	    <guimenu>Game</guimenu>
	    <guimenuitem>New</guimenuitem>
	  </menuchoice>
	</term>
	<listitem><para><action>Start a new game</action></para></listitem>
      </varlistentry>
      <varlistentry>
	<term><menuchoice><shortcut><keycap>F5</keycap></shortcut>
	    <guimenu>Game</guimenu><guimenuitem>Restart Game</guimenuitem></menuchoice></term>
	<listitem><para>Starts a new game with the same settings as the current game.</para></listitem>
      </varlistentry>
      <varlistentry>
	<term>
	  <menuchoice>
	    <shortcut>
	      <keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo>
	    </shortcut>
	    <guimenu>Game</guimenu>
	    <guimenuitem>Show High Scores</guimenuitem>
	  </menuchoice>
	</term>
	<listitem><para><action>Displays</action> the high score table</para></listitem>
      </varlistentry>
      <varlistentry>
	<term>
	  <menuchoice>
	    <shortcut>
	      <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
	    </shortcut>
	    <guimenu>Game</guimenu>
	    <guimenuitem>Quit</guimenuitem>
	  </menuchoice>
	</term>
	<listitem><para><action>Quits</action> &ksquares;</para></listitem>
      </varlistentry>
      <varlistentry id="settings-menu-settings">
	<term><menuchoice>
	    <guimenu>Settings</guimenu>
	    <guimenuitem>Configure &ksquares;...</guimenuitem>
	    </menuchoice></term>
	<listitem><para><action>Opens a dialog to configure &ksquares;.</action> See <link linkend="configuration">Game Configuration</link> section for details.</para></listitem>
      </varlistentry>
Eugene Trounev's avatar
Eugene Trounev committed
171
    </variablelist>
172
173
174
175
176
177
178
179
180
  </para>
  <para>
    Additionally &ksquares; has the common &kde; <guimenu>Settings</guimenu> and <guimenu>Help</guimenu>
    menu items, for more information read the sections about the
    <ulink url="help:/fundamentals/ui.html#menus-settings">Settings Menu</ulink> and
    <ulink url="help:/fundamentals/ui.html#menus-help">Help Menu</ulink>
    of the &kde; Fundamentals.
  </para>
  
Matt Williams's avatar
Matt Williams committed
181
</chapter>
182
  
Eugene Trounev's avatar
Eugene Trounev committed
183
184
185
186
187
188
<chapter id="faq"><title>Frequently asked questions</title> <!-- do not change this! -->
<!--This chapter is for frequently asked questions. Please use <qandaset> <qandaentry> only!-->
<qandaset>
<!--Following is a standard list of FAQ questions.-->
<qandaentry>
 <question><para>I want to change the way this game looks. Can I? </para></question>
189
 <answer><para>Currently the only thing you can change about the game look is the color of the lines. To do so use <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &ksquares;...</guimenuitem></menuchoice> on the menubar. See <link linkend="configuration">Game Configuration</link> section for details.</para></answer>
Eugene Trounev's avatar
Eugene Trounev committed
190
191
192
</qandaentry>
<qandaentry>
 <question><para>I have made a mistake. Can I undo? </para></question>
193
 <answer><para>No. &ksquares; doesn't currently have an <quote>Undo</quote> feature.</para></answer>
Eugene Trounev's avatar
Eugene Trounev committed
194
195
</qandaentry>
<qandaentry>
Frederik Schwarzer's avatar
Frederik Schwarzer committed
196
 <question><para>Can I use the keyboard to play the game? </para></question>
197
 <answer><para>No. &ksquares; cannot be played using keyboard.</para></answer>
Eugene Trounev's avatar
Eugene Trounev committed
198
199
</qandaentry>
<qandaentry>
Burkhard Lück's avatar
Burkhard Lück committed
200
 <question><para>I cannot figure out what to do here! Are there hints? </para></question>
Frederik Schwarzer's avatar
Frederik Schwarzer committed
201
 <answer><para>No. There is no <quote>Hint</quote> feature implemented yet.</para></answer>
Eugene Trounev's avatar
Eugene Trounev committed
202
203
</qandaentry>
<qandaentry>
Burkhard Lück's avatar
Burkhard Lück committed
204
 <question><para>I have to quit the game now, but I am not finished yet. Can I save my progress?</para></question>
205
  <answer><para>&ksquares; does not have a saving feature.</para></answer>
Eugene Trounev's avatar
Eugene Trounev committed
206
207
208
209
</qandaentry>
<!--Please add more Q&As if needed-->
 
</qandaset>
Matt Williams's avatar
Matt Williams committed
210
</chapter>
Eugene Trounev's avatar
Eugene Trounev committed
211
212
213
214
 
<chapter id="configuration"><title>Game Configuration</title> <!-- do not change this! -->
<sect1 id="newgame-dialog">
<title>New Game Dialog</title>
Burkhard Lück's avatar
Burkhard Lück committed
215
<para>The <guilabel>New Game</guilabel> dialog consistes of the following groupboxes:</para>
Eugene Trounev's avatar
Eugene Trounev committed
216
217
218
<variablelist>
  <varlistentry>
    <term><guilabel>Players</guilabel></term>
Yuri Chornoivan's avatar
Yuri Chornoivan committed
219
    <listitem><para>Here you can change the number of participating players, as well as determine who will be played by human and who by the artificial intelligence. Use the <guilabel>Number of players</guilabel> selection box to specify the number of participants. Then type a name for each participant and use the check box to specify the player type.</para></listitem>
Eugene Trounev's avatar
Eugene Trounev committed
220
221
222
223
224
225
226
  </varlistentry>
  <varlistentry>
    <term><guilabel>Game Board</guilabel></term>
    <listitem><para>Here you can regulate the size of the game board. Use the <guilabel>Width</guilabel> and <guilabel>Height</guilabel> selection boxes to change the width and height of the game board.</para></listitem>
  </varlistentry>
  <varlistentry>
    <term><guilabel>Game Settings</guilabel></term>
Burkhard Lück's avatar
Burkhard Lück committed
227
    <listitem><para>This part of the configuration dialog regulates the difficulty of the game. If you leave the <guilabel>Quick start</guilabel> check box unchecked - the game will begin with the empty grid. Otherwise the game will start with the game board partially filled.</para></listitem>
Eugene Trounev's avatar
Eugene Trounev committed
228
229
230
231
232
  </varlistentry>
</variablelist>
</sect1>
<sect1 id="configuration-dialog">
<title>Configuration Dialog</title>
233
<para>The <guilabel>Configure - &ksquares;</guilabel> dialog consists of the following tabs:</para>
Eugene Trounev's avatar
Eugene Trounev committed
234
235
236
<variablelist>
  <varlistentry>
    <term><guilabel>Display</guilabel></term>
237
    <listitem><para>Here you can change the &ksquares; color settings.</para></listitem>
Eugene Trounev's avatar
Eugene Trounev committed
238
239
240
241
242
243
244
245
246
247
248
249
250
  </varlistentry>
  <varlistentry>
    <term><guilabel>Computer Player</guilabel></term>
    <listitem><para>Use this tab to regulate the game difficulty.</para></listitem>
  </varlistentry>
</variablelist>
</sect1>
</chapter>
 
<chapter id="credits"><title>Credits and License</title> <!-- do not change this! -->
<!--This chapter is for credits and licenses.-->
 
<para>
251
&ksquares;  <!-- do not change this! -->
Eugene Trounev's avatar
Eugene Trounev committed
252
</para>
Matt Williams's avatar
Matt Williams committed
253

Eugene Trounev's avatar
Eugene Trounev committed
254
<para>
Matt Williams's avatar
Matt Williams committed
255
256
  Program copyright 2006 Matt Williams <email>matt@milliams.com</email>
  </para>
Eugene Trounev's avatar
Eugene Trounev committed
257
 
Matt Williams's avatar
Matt Williams committed
258
259
  <para>Documentation Copyright &copy; 2006 Matt Williams <email>matt@milliams.com</email></para>

Eugene Trounev's avatar
Eugene Trounev committed
260
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
Matt Williams's avatar
Matt Williams committed
261
262


Eugene Trounev's avatar
Eugene Trounev committed
263
264
265
&underFDL;
&underGPL;
 
Matt Williams's avatar
Matt Williams committed
266
</chapter>
267
  
Matt Williams's avatar
Matt Williams committed
268
269
<appendix id="installation">
<title>Installation</title>
Eugene Trounev's avatar
Eugene Trounev committed
270
271
272
273
274
275
276
277
278
 
&install.intro.documentation;
 
 
<sect1 id="Compilation">
<title>Compilation and Installation</title>
 
&install.compile.documentation;
 
Matt Williams's avatar
Matt Williams committed
279
280
</sect1>
</appendix>
Eugene Trounev's avatar
Eugene Trounev committed
281
282
 
&documentation.index; 
Matt Williams's avatar
Matt Williams committed
283
284
285
</book>
<!--
Local Variables:
Eugene Trounev's avatar
Eugene Trounev committed
286
mode: sgml
Matt Williams's avatar
Matt Williams committed
287
288
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
Eugene Trounev's avatar
Eugene Trounev committed
289
290
291
292
sgml-omittag:t
sgml-shorttag:t
sgml-namecase-general:t
sgml-always-quote-attributes:t
Matt Williams's avatar
Matt Williams committed
293
294
sgml-indent-step:0
sgml-indent-data:nil
Eugene Trounev's avatar
Eugene Trounev committed
295
296
297
298
sgml-parent-document:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
Matt Williams's avatar
Matt Williams committed
299
End:
300
-->