KDE Games/Documentation Progress

Purpose

This is the page for the kdegames docs audit.

The list of KDEGames Docbook sections:

1. Introduction
2. How to play
3. Game Rules, Strategies and Tips
4. Frequently asked questions
5. Interface Overview
6. Credits and License

Detailed description of sections

Introduction

Sample

Game type: Logic, Arcade

Game description:

Katomic is both fun and educational game built around molecular geometry. It employs simplistic two-dimensional looks at different chemical elements which are disassembled into separate atoms and scattered around the play field. Player is expected to reassemble the molecule, thus completing current level and moving up to the next one.

How to play

Sample

Objective: assemble molecules from compound atoms by sliding the atoms around.

Gameplay:

1. Katomic loads directly into the game play mode at startup. So, no additional actions are required to start the game.
2. Study a reference screen, located in the top-right corner to view an assembled molecule.
3. Use mouse cursor to click any atom on the play field, this will reveal the directional icons.
4. Click on a corresponding icon to move atom in desired direction. Note that atom can not be stopped after it started moving, unless it meets a wall or another atom.
5. Keep moving atoms around until you reconstruct the molecule exactly as shown on the preview screen.
6. Once the molecule is complete you will be allowed to move to the next level.

Maybe make this a full text

Game Rules, Strategies and Tips

Sample

Rules:

• Game pieces can only move in one direction at a time.
• Once an atom begins moving it will not stop until it meets either a wall or another peace.
• The only way to progress to the next game level is to complete a current one. *Once player completes a certain level game automatically switches to the next one, thus 'uncovering it'.
• Player can only switch between the levels which have been uncovered.
• The game progress is automatically saved every time an adjacent level is reached, and will be reloaded the next time application is started.

Strategies and tips:

1. Always review the complete molecule using the reference screen before making any moves.
2. Next, study the play field and plan your moves. Remember, once a piece is moved it may not be possible to return it into the starting position.
3. Think through your every move and try to visualize the trajectory piece will follow once a directional arrow is clicked.
4. When using keyboard to move pieces make sure that an exact piece is selected. If a wrong atom is marked as selected, use 'Tab' key to switch between the pieces until you reach a desired one.

Frequently asked questions

Sample

• Q. How do I start a game?
• A. Katomic loads directly into the game play mode at startup. So, no additional actions are required to start the game.

Users are usually capable of doing this themselves...

• Q. How do I know what does the molecule look like?
• A. You can view the molecule on the reference screen located in the top right corner of the game screen.

• Q. Where is the reference screen?
• A. The reference screen is located in the top right corner of the game screen.

• Q. How do I move a game piece(atom)?
• A. To move a game piece(atom) use your mouse cursor to click on it. At this time the available directional icon will become visible. Click on the corresponding directional icon to make a game piece move in desired direction. Alternatively, you can use your keyboard to move the pieces. Use [Tab] key to switch between the items, and directional key to move them once selected.

• Q. Can I use keyboard to control the pieces(atoms)?
• A. Yes. Use [Tab] key to switch between the items, and directional key to move them once selected.

• Q. When I move a peace (atom) it goes right past the place where I want it. How do I make it stop there?
• A. You don't. Once an atom begins moving, it will not stop until it meets either a wall or another peace.

• Q. I have stuck. How can I restart the game?
• A. To restart Karomic choose 'Game' in the game window menu. There choose 'Restart Game'. Alternatively you can press [F5] key on your keyboard to restart the game.

• Q. I can't beat the level. Is there a hint system, or a solver?
• A. No. Unfortunately at this time Katomic does not feature a hint system. So the only way to finish a level is to solve it on your own.

• Q. I did something wrong. Can I undo.
• A. Yes. To undo a wrong move select 'Move' from the menubar. Then select 'Undo'. Alternatively you can press [Ctrl+Z] on your keyboard.

Interface Overview

Sample

Menubar:

1. Game
   1. Load... [Ctrl+O] – load saved game
   2. Restart Game [F5] – restart current game
   3. Save [Ctrl+S] – save current game
   4. Previous Level [Ctrl+P] – switch to the next level
   5. Next Level [Ctrl+N] – go back to the previous level
   6. Quit [Ctrl+Q] – quit application
2. Move
   1. Undo [Ctrl+Z] – unto the last move
   2. Redo [Ctrl+Shift+Z] – redo the last undone move
   3. Undo All – undo all the moves made
   4. Redo All – redo all the moves made
3. Settings
   1. Animation Speed – adjust the speed of onscreen animation
      1. Slow
      2. Normal
      3. Fast
   2. Show Toolbar – show or hide toolbar
   3. Show Statusbar – show or hide statusbar
   4. Configure Shortcuts... - bring up shortcat configuration utility
   5. Configure Toolbars... - bring up toolbar configuration utility
4. Help
   1. Katomic Handbook [F1] – shows this help
   2. What's This? [Shift+F1] – draws a question mark (?) beside the mouse pointer. Clicking then on a window item such as a toolbar button will then display a brief explanation
   3. Report Bug... - starts bug report wizard
   4. About Katomic - displays brief information about the product. Such as version number, authors, contributors, and license agreement.
   5. About KDE - displays brief information about KDE. Such as version number, authors and license agreement.

Maybe not explain *everything*

Default keyboard shortcuts

• Restart game - F5
• Cycle atoms - Tab
• Cycle atoms backwards - Shift+Tab
• Highscore table - Ctrl+H
• Load - Ctrl+O
• Quit - Ctrl+Q
• Help - F1
• What's this - Shift+F1
• Redo - Ctrl+Shift+Z
• Undo - Ctrl+Z
• Next level - Ctrl+N
• Previous level - Ctrl+P