Commit c6a5d98b authored by Andre Klapper's avatar Andre Klapper 💬
Browse files

help: Update docs to 3.38 UI

* Preferences (except for sound) moved to Start Game screens
* Removed options to change worm colors and level order

See #49
parent e12e4c48
Pipeline #305707 failed with stages
in 45 seconds
......@@ -8,6 +8,7 @@
<revision pkgversion="3.8" version="0.1" date="2013-03-07" status="review"/>
<revision pkgversion="3.34" version="0.2" date="2020-01-05" status="review"/>
<revision pkgversion="3.38" version="0.2" date="2021-08-08" status="review"/>
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
......
......@@ -10,6 +10,7 @@
<revision pkgversion="3.8" version="0.1" date="2012-03-05" status="candidate"/>
<revision pkgversion="3.34" version="0.2" date="2020-01-05" status="candidate"/>
<revision pkgversion="3.38" version="0.3" date="2021-08-08" status="candidate"/>
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
......@@ -21,6 +22,10 @@
<name>Ekaterina Gerasimova</name>
<email its:translate="no">kittykat3756@gmail.com</email>
</credit>
<credit type="editor">
<name>Andre Klapper</name>
<email its:translate="no">ak-47@gmx.net</email>
</credit>
<desc>Set custom control keys.</desc>
</info>
......@@ -34,11 +39,12 @@
<steps>
<item>
<p>Press the menu button in the top-right corner of the window and select
<gui style="menuitem">Preferences</gui>.</p>
<p>Start a new game.</p>
</item>
<item>
<p>Select the tab for the player whose controls you want to change.</p>
<p>On the <gui>Controls</gui> screen, press the
<media its:translate="no" type="image" src="figures/emblem-system-symbolic.svg"><span its:translate="yes">settings</span></media>
button for the player whose controls you want to change.</p>
<note style="info">
<p>Player 1 controls <gui>Worm 1</gui>, player 2 controls
<gui>Worm 2</gui>, player 3 controls <gui>Worm 3</gui> and so on.</p>
......@@ -46,13 +52,17 @@
</item>
<item>
<p>In the <gui style="group">Controls</gui> list, select the
line, then click on the control. This highlights the line and the words
line of the <gui>Action</gui>. This highlights the line.</p>
</item>
<item>
<p>Select the <gui>Key</gui> on the control. The words
<gui>New accelerator…</gui> are now present in place of the old
control.</p>
</item>
<item>
<p>Press the key you want to use instead of the default key.</p>
<note style="tip">
<!-- TODO: Broken in 3.38; see https://gitlab.gnome.org/GNOME/gnome-nibbles/-/issues/54 -->
<p>To keep the old setting click <gui>New accelerator…</gui> again,
right click on <gui>New accelerator…</gui>, press <key>Esc</key> or
click anywhere else inside the <gui>Nibbles Preferences</gui> box.</p>
......@@ -65,8 +75,8 @@
</item>
</steps>
<p>For example, to use <key>A</key> to <gui>Move Left</gui>, select the
<gui>Left</gui> control line and click it, then press <key>A</key> on your
<p>For example, to use <key>A</key> to move left, select the <gui>Action</gui>
<gui>Move left</gui>, then select its <gui>Key</gui>, then press <key>A</key> on your
keyboard when you see <gui>New accelerator…</gui> on the line.</p>
</page>
......@@ -8,6 +8,7 @@
<revision pkgversion="3.8" version="0.1" date="2013-03-05" status="candidate"/>
<revision pkgversion="3.24" version="0.2" date="2019-01-21" status="candidate"/>
<revision pkgversion="3.38.2" version="0.2" date="2021-08-08" status="candidate"/>
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
......
......@@ -8,6 +8,7 @@
<revision pkgversion="3.8" version="0.1" date="2013-03-05" status="review"/>
<revision pkgversion="3.34" version="0.2" date="2020-01-05" status="candidate"/>
<revision pkgversion="3.38" version="0.2" date="2020-08-08" status="candidate"/>
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
......@@ -19,6 +20,10 @@
<name>Ekaterina Gerasimova</name>
<email its:translate="no">kittykat3756@gmail.com</email>
</credit>
<credit type="editor">
<name>Andre Klapper</name>
<email its:translate="no">ak-47@gmx.net</email>
</credit>
<desc>Use fake bonuses in a <app>Nibbles</app> game to make it more
challenging.</desc>
......@@ -33,18 +38,16 @@
<p>To enable fake bonuses:</p>
<steps>
<item>
<p>Press the menu button in the top-right corner of the window and select
<gui style="menuitem">Preferences</gui>.</p>
<p>Start a new game.</p>
</item>
<item>
<p>Check the <gui style="checkbox">Enable fake bonuses</gui> checkbox if
it is unchecked.</p>
<p>On the <gui>Preferences</gui> screen, check the
<gui style="checkbox">Enable fake bonuses</gui> checkbox if it is unchecked.</p>
</item>
</steps>
<note style="tip">
<p>Set all preferences before starting a new game. Preferences cannot be
changed in the middle of a game.</p>
<p>Preferences cannot be changed in the middle of a game.</p>
</note>
</page>
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16">
<path d="M8 1c-.22 0-.44.011-.656.031l-.406 2.094a5.012 5.012 0 0 0-.969.312L4.438 1.97c-.389.23-.727.514-1.063.812l.906 1.906a5.057 5.057 0 0 0-.593.813l-2.094-.281A6.91 6.91 0 0 0 1.188 6.5l1.843 1a4.826 4.826 0 0 0-.03.5c0 .173.013.332.03.5l-1.843 1c.097.445.228.872.406 1.281l2.094-.281c.17.29.371.563.593.812l-.906 1.907c.336.298.674.582 1.063.812l1.531-1.469c.306.137.634.24.969.313l.406 2.094a7.118 7.118 0 0 0 1.312 0l.407-2.094c.334-.073.663-.176.968-.313l1.532 1.47c.388-.23.727-.515 1.062-.813l-.906-1.907c.222-.249.424-.522.594-.812l2.093.281a6.91 6.91 0 0 0 .407-1.281l-1.844-1c.017-.168.031-.327.031-.5s-.014-.332-.031-.5l1.844-1a6.908 6.908 0 0 0-.407-1.281l-2.093.281a5.057 5.057 0 0 0-.594-.813l.906-1.906c-.335-.298-.674-.582-1.062-.812L10.03 3.437a5.015 5.015 0 0 0-.968-.312l-.407-2.094A7.118 7.118 0 0 0 8 1zm0 4a3 3 0 1 1 0 6 3 3 0 0 1 0-6z" style="marker:none" color="#000" overflow="visible" fill="#474747"/>
</svg>
......@@ -7,6 +7,7 @@
<link type="guide" xref="index#play"/>
<revision pkgversion="3.8" version="0.1" date="2013-03-05" status="review"/>
<revision pkgversion="3.38" version="0.2" date="2021-08-08" status="review"/>
<link type="seealso" xref="controls-change"/>
......@@ -20,6 +21,10 @@
<name>Ekaterina Gerasimova</name>
<email its:translate="no">kittykat3756@gmail.com</email>
</credit>
<credit type="editor">
<name>Andre Klapper</name>
<email its:translate="no">ak-47@gmx.net</email>
</credit>
<desc>Play <app>Nibbles</app> with additional players.</desc>
</info>
......@@ -36,30 +41,22 @@
<section id="number-of-players">
<title>Choose the number of players</title>
<p><app>Nibbles</app> can be played by up to six players. To set the number
of players:</p>
<p><app>Nibbles</app> can be played by up to six players. Up to four of them
can be humans. To set the number of players:</p>
<steps>
<item>
<p>Press the menu button in the top-right corner of the window and select
<gui style="menuitem">Preferences</gui>.</p>
<p>Start a new game.</p>
</item>
<item>
<p>Set the <gui style="input">Number of human players</gui> to the
required number, a maximum of 6. You can do this by using the
<gui style="button">+</gui> or <gui style="button">-</gui> buttons or by
entering the number of players from the keyboard in the space
provided.</p>
<p>On the <gui>Number of players</gui> screen, set the number of human
players to the required number, a maximum of 4.</p>
</item>
<item>
<p>Set the number of computer players.</p>
</item>
</steps>
<note style="info">
<p>You can watch a <app>Nibbles</app> game without participating. To
observe a game, set the <gui style="input">Number of human players</gui>
to 0 and set the <gui style="input">Number of AI players</gui> to any
number between 1 and 6.</p>
</note>
</section>
</page>
<page xmlns="http://projectmallard.org/1.0/"
xmlns:its="http://www.w3.org/2005/11/its"
type="topic" style="task"
id="preferences">
<info>
<link type="guide" xref="index#preferences"/>
<revision pkgversion="3.8" version="0.1" date="2013-03-05" status="review"/>
<revision pkgversion="3.34" version="0.2" date="2020-01-05" status="review"/>
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
<credit type="author">
<name>Aruna Sankaranarayanan</name>
<email its:translate="no">aruna.evam@gmail.com</email>
</credit>
<credit type="editor">
<name>Ekaterina Gerasimova</name>
<email its:translate="no">kittykat3756@gmail.com</email>
</credit>
<desc>Change default speed, worm color, level order and sound settings.</desc>
</info>
<title>Edit general preferences</title>
<p>The general preferences for <app>Nibbles</app> can be changed by
pressing the menu button in the top-right corner of the window and selecting
<gui style="menuitem">Preferences</gui>.</p>
<section id="speed">
<title>Speed</title>
<p>To change the speed:</p>
<steps>
<item>
<p>Press the menu button in the top-right corner of the window and select
<gui style="menuitem">Preferences</gui>.</p>
</item>
<item>
<p>Select one of the four speed choices given on the left hand side.</p>
</item>
</steps>
</section>
<section id="colours">
<title>Change worm colors</title>
<p>There are seven available worm colors:</p>
<list>
<item>
<p><media type="image" its:translate="no" src="figures/snake-red.svg" height="20"
width="20"/> Red</p>
</item>
<item>
<p><media type="image" its:translate="no" src="figures/snake-green.svg" height="20"
width="20"/> Green</p>
</item>
<item>
<p><media type="image" its:translate="no" src="figures/snake-blue.svg" height="20"
width="20"/> Blue</p>
</item>
<item>
<p><media type="image" its:translate="no" src="figures/snake-yellow.svg" height="20"
width="20"/> Yellow</p>
</item>
<item>
<p><media type="image" its:translate="no" src="figures/snake-cyan.svg" height="20"
width="20"/> Cyan</p>
</item>
<item>
<p><media type="image" its:translate="no" src="figures/snake-magenta.svg" height="20"
width="20"/> Purple</p>
</item>
<item>
<p><media type="image" its:translate="no" src="figures/snake-grey.svg" height="20"
width="20"/> Gray</p>
</item>
</list>
<p>To change worm colors:</p>
<steps>
<item>
<p>Press the menu button in the top-right corner of the window and select
<gui style="menuitem">Preferences</gui>.</p>
</item>
<item>
<p>Select any of the <gui style="tab">Worm</gui> tabs to choose the worm
that you wish to edit.</p>
</item>
<item>
<p>Under <gui>Worm color</gui>, pick a color out of the available
colors in the drop-down menu to change the appearance of the worm.</p>
</item>
</steps>
</section>
<section id="sound">
<title>Sounds</title>
<p>To enable or disable sounds:</p>
<steps>
<item>
<p>Press the menu button in the top-right corner of the window and select
<gui style="menuitem">Preferences</gui>.</p>
</item>
<item>
<p>Check or uncheck <gui style="checkbox">Enable sounds</gui>.</p>
</item>
</steps>
</section>
</page>
<page xmlns="http://projectmallard.org/1.0/"
xmlns:its="http://www.w3.org/2005/11/its"
type="topic" style="task"
id="sound-change">
<info>
<link type="guide" xref="index#preferences"/>
<revision pkgversion="3.8" version="0.1" date="2013-03-05" status="review"/>
<revision pkgversion="3.34" version="0.2" date="2020-01-05" status="review"/>
<revision pkgversion="3.38" version="0.3" date="2021-08-08" status="review"/>
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
<credit type="author">
<name>Aruna Sankaranarayanan</name>
<email its:translate="no">aruna.evam@gmail.com</email>
</credit>
<credit type="editor">
<name>Ekaterina Gerasimova</name>
<email its:translate="no">kittykat3756@gmail.com</email>
</credit>
<credit type="author">
<name>Andre Klapper</name>
<email its:translate="no">ak-47@gmx.net</email>
</credit>
<desc>Change sound settings.</desc>
</info>
<title>Enable or disable sound</title>
<p>To enable or disable sounds:</p>
<steps>
<item>
<p>Press the menu button in the top-right corner of the window.</p>
</item>
<item>
<p>Check or uncheck <gui style="checkbox">Sound</gui>.</p>
</item>
</steps>
</page>
<page xmlns="http://projectmallard.org/1.0/"
xmlns:its="http://www.w3.org/2005/11/its"
type="topic" style="task"
id="speed-change">
<info>
<link type="guide" xref="index#preferences"/>
<revision pkgversion="3.8" version="0.1" date="2013-03-05" status="review"/>
<revision pkgversion="3.34" version="0.2" date="2020-01-05" status="review"/>
<revision pkgversion="3.38" version="0.3" date="2021-08-08" status="review"/>
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
<credit type="author">
<name>Aruna Sankaranarayanan</name>
<email its:translate="no">aruna.evam@gmail.com</email>
</credit>
<credit type="editor">
<name>Ekaterina Gerasimova</name>
<email its:translate="no">kittykat3756@gmail.com</email>
</credit>
<credit type="editor">
<name>Andre Klapper</name>
<email its:translate="no">ak-47@gmx.net</email>
</credit>
<desc>Change how fast the worms move.</desc>
</info>
<title>Change the default speed</title>
<p>To change the speed:</p>
<steps>
<item>
<p>Start a new game.</p>
</item>
<item>
<p>On the <gui>Preferences</gui> screen, select one of the four speed choices.</p>
</item>
</steps>
<note style="tip">
<p>Preferences cannot be changed in the middle of a game.</p>
</note>
</page>
......@@ -5,8 +5,9 @@ gnome_nibbles_help_pages = [
'fake-bonus.page',
'index.page',
'multi-player.page',
'preferences.page',
'scores.page',
'sound-change.page',
'speed-change.page',
'legal.xml',
]
......@@ -15,15 +16,9 @@ gnome_nibbles_help_media = [
'figures/banana.svg',
'figures/cherry.svg',
'figures/diamond.svg',
'figures/emblem-system-symbolic.svg',
'figures/life.svg',
'figures/nibbles.svg',
'figures/snake-blue.svg',
'figures/snake-cyan.svg',
'figures/snake-green.svg',
'figures/snake-grey.svg',
'figures/snake-magenta.svg',
'figures/snake-red.svg',
'figures/snake-yellow.svg',
]
gnome.yelp(meson.project_name(),
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment