KDE Games/Documentation Progress: Difference between revisions

From KDE Community Wiki
*>Trounev
*>Trounev
Line 19: Line 19:
# Bovo - done, except for GUI description.
# Bovo - done, except for GUI description.
# Kbounce - Superb doc! Thanks Tomasz! (Review only)
# Kbounce - Superb doc! Thanks Tomasz! (Review only)
# Klines
# Klines - done, except for GUI description.
# Knetwalk
# Kiriki
# Kiriki


Revision as of 17:58, 25 October 2007

Purpose

This is the page for the kdegames docs audit.

KDEGames Docteam name list, assignment list and statistics

Games Done

  1. lskat
  2. kwin4
  3. Ktuberling
  4. Mmahjongg
  5. Ksame
  6. KSpaceDuel
  7. KShisen
  8. Konquest
  9. Kjumpingcube - Loved every bit of this doc!
  10. Kbattleship

Games in Works

  1. Bovo - done, except for GUI description.
  2. Kbounce - Superb doc! Thanks Tomasz! (Review only)
  3. Klines - done, except for GUI description.
  4. Kiriki

Games in Queue

  1. KSudoku
  2. Katomic
  3. Kblackbox
  4. Kgoldrunner
  5. Kmines
  6. Kolf
  7. Kreversi
  8. Ksquares
  9. KPat
  10. KBackgammon
  11. libkdegames

Docteam Name List

Name IRC nick Role Assignment Status
Eugene it-s Docbook Editor 1.lskat 2.Ktuberling

3.Kmahjongg 4.Ksame 5. KSpaceDuel 6. KShisen

1.Done 2.Done

3.Done 4.Done 5.Done 6.Done

dinounix Docbook Editor 1.kwin4

2.Konquest 3. Kbattleship

1.Done

2. Done 3. In progress

Docbook writing guidelines

The list of KDEGames Docbook sections:

  1. Introduction
  2. How to Play
  3. Game Rules, Strategies and Tips
  4. Interface Overview
  5. Frequently Asked Questions
  6. Game Configuration
  7. Credits and License

Detailed description of sections

Introduction

--Guidelines--

  1. Indicate 'Game type:' first. Available game types are: Arcade, Board, Card, Dice, Toys, Logic, Strategy. NOTE: game may have more then one type.
  2. Indicate 'Number of possible players:' second. It can be: One, Two,..., Multiplayer
  3. Give a short game description. Use a clean and short sentences in passive voice (no you).
  • First outline a general game idea.
  • Then talk about the same idea in details.
  • Conclude with the main goal of the game.

Length: 3-4 sentences.

Sample

Game type: Logic, Arcade

Number of possible players: One

Katomic is both fun and educational game built around molecular geometry. It employs simplistic two-dimensional looks at different chemical elements. Elements 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

--Guidelines---

  1. State the game objective first. (see sample below)
  2. Describe gameplay. (see sample below) Short description of the game process has to follow. Make sure you use simple and clean sentence structure and 'active voice' form.
    • Describe gameplay to the reader.
    • Include all important gameplay details.
    • You may include screenshots* to illustrate your point if necessary. But don't overload.

Length: 8-18 sentences.

Sample

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

Gameplay: Katomic will load level one once you start the game and you can start playing right away. To see how the molecule you are supposed to make looks like, take a look at the upper right corner. To play, click on an atom. You will see green arrows pointing in the directions where atom can move. To move the atom, click on the desired arrow. When an atom starts moving, it will not stop until it hits another atom or a wall, so make sure you think before you do your next move. You can assemble your molecule where you like on the game board, but some places are better than others. When the molecule is assembled, you can move to the next level.

Game Rules, Strategies and Tips

--Guidelines---

  1. Use leveled bulletpoints only
  2. There have to two sections here: 'Rules', and 'Strategies and tips'
  3. Rules:
    1. All the game dos and don'ts should be described here.
    2. Use passive voice (no you) and clean, short sentence structure.
    3. Lenght: 6-18 points.
  4. Strategies and tips:
    1. Warnings go here.
    2. Any sort of comments that may benefit player directly should go here.
    3. Use active voice (you) and clean, short sentence structure.
    4. Lenght: 4-12 points.

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:

  • Always review the complete molecule using the reference screen before making any moves.
  • 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.
  • Think through your every move and try to visualize the trajectory piece will follow once a directional arrow is clicked.
  • 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.

Interface Overview

--Guidelines--

  1. Use leveled bulletpoints only
  2. Shortly describe every entry of the menubar.
  3. Shortly describe every default shortcut.
  4. Use passive voice only (no you)

Length: as much as it takes.

Sample

Menubar:

  • Game
    • Load... [Ctrl+O] – load saved game
    • Restart Game [F5] – restart current game
    • Save [Ctrl+S] – save current game
    • Previous Level [Ctrl+P] – switch to the next level
    • Next Level [Ctrl+N] – go back to the previous level
    • Quit [Ctrl+Q] – quit application
  • Move
    • Undo [Ctrl+Z] – unto the last move
    • Redo [Ctrl+Shift+Z] – redo the last undone move
    • Undo All – undo all the moves made
    • Redo All – redo all the moves made
  • Settings
    • Animation Speed – adjust the speed of onscreen animation
      • Slow
      • Normal
      • Fast
    • Show Toolbar – show or hide toolbar
    • Show Statusbar – show or hide statusbar
    • Configure Shortcuts... - bring up shortcat configuration utility
    • Configure Toolbars... - bring up toolbar configuration utility
  • Help
    • Katomic Handbook [F1] – shows this help
    • 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
    • Report Bug... - starts bug report wizard
    • About Katomic - displays brief information about the product. Such as version number, authors, contributors, and license agreement.
    • About KDE - displays brief information about KDE. Such as version number, authors and license agreement.

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

Frequently Asked Questions

--Guidelines--

  1. Use leveled bulletpoints only
  2. Use active voice (you) only.

List of generic questions to use with every game

  • Q. Who made this game?
  • A. The kdegames team. You can find their website here.
  • Q. Where can I get cheatcodes?
  • A. You can't get cheatcodes for KDE games.
  • Q. This game is boring, why?
  • A. KDE games are not meant to be high-quality FPS games.
  • Q. How do I start a new game?
  • Q. I have started a new game. What do I do now?
  • Q. How do I pause the game?
  • Q. I want to change the way this game looks. Can I?
  • Q. I have made a mistake. Can I undo?
  • Q. Can I skip a level?
  • Q. Can I use keyboard?
  • Q. Can I change default keyboard shortcuts?
  • A. Yes. Select Settings and then Configure Shortcuts.
  • Q. I can't figure out what to do here! Are there hints?
  • Q. I have to quit the game now, but I'm not finished yet. Can I save my progress?
  • Q. I have saved my progress earlier. How do I restore it?
  • Q. Where are the highscores?
  • Q. I want to change the game configuration. Where do I go?
  • Q. I want to change the toolbar layout. What do I do?

Lenght: no more then 60 points.

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.


Game Configuration

--Guidelines--

  1. Sep-by-step describe every option in configuration form.
  2. Include screenshots* as you dim necessary. But don't overload.

Credits and License

IMPORTANT NOTES

  • Screenshots: '.PNG' and '.JPG' ONLY. NO '.GIF'!
  • Screenshot sizes:

Useful Links

A docbook skeleton to use

<?xml version="1.0" ?> <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ 

 <!ENTITY app-name "<application>KMyApp</application>">
 <!ENTITY kapp-name "&app-name;"> 

 <!ENTITY kappversion "1.0">
 <!ENTITY docversion "1.0">
 <!ENTITY docupdate "YYYY-MM-DD">
 <!ENTITY package "kdegames">  
 <!ENTITY % English "INCLUDE" > 
 <!ENTITY % addindex "IGNORE">

]>

<book lang="&language;"> <bookinfo> <title>&kapp-name; Handbook</title> <authorgroup> <author> <firstname>First name</firstname> <surname>Last name</surname> <affiliation> <address><email>email address</email></address> </affiliation> </author> </authorgroup>

<date>&docupdate;</date> <releaseinfo>&docversion;</releaseinfo>

<abstract> <para>This documentation describes the game of &app-name; version &kappversion;</para> </abstract>

<keywordset> <keyword>KDE</keyword> <keyword>kdegames</keyword> <keyword>game</keyword> <keyword>Application Name</keyword> <keyword>arcade</keyword> <keyword>card</keyword> <keyword>card game</keyword> <keyword>playing cards</keyword> <keyword>two players</keyword> <keyword>skat</keyword> <keyword>lieutenant</keyword> <keyword>lskat</keyword> </keywordset> </bookinfo> <chapter id="introduction"><title>Introduction</title> <note><title>Gametype:</title><para>Card, Arcade</para></note> <note><title>Number of possible players:</title><para>Two</para></note>

<para> Short game description. </para> </chapter>

<chapter id="howto"><title>How to play</title> <note><title>Objective:</title><para>Score more then 60 points in a single game.</para></note> <para> How to play description. </para> </chapter>

<chapter id="rules_and_tips"><title>Game Rules, Strategies and Tips</title> <para>Game Rules, Strategies and Tips</para> </chapter>


<chapter id="interface"><title>Interface Overview</title>

<sect1 id="help"> <title>The <guimenuitem>Help</guimenuitem> Menu</title> &help.menu.documentation; </sect1> </chapter>


<chapter id="faq"><title>Frequently asked questions</title> <qandaset> <qandaentry> <question><para>Who made this game?</para></question> 

<answer><para>The kdegames team. You can find their website here.</para></answer>

</qandaentry> <qandaentry> 

<question><para>Where can I get cheatcodes? </para></question>
<answer><para>You can't get cheatcodes for KDE games.</para></answer>

</qandaentry> <qandaentry> 

<question><para>How do I start a new game? </para></question>
<answer><para>Explain how to start a new game here.</para></answer>

</qandaentry> <qandaentry> 

<question><para>How do I pause the game? </para></question>
<answer><para>Explain how to pause game here.</para></answer>

</qandaentry> <qandaentry> 

<question><para>I want to change the way this game looks. Can I? </para></question>
<answer><para>Explain how the theme selector works.</para></answer>

</qandaentry> <qandaentry> 

<question><para>I have made a mistake. Can I undo? </para></question>
<answer><para>Explain how to undo here.</para></answer>

</qandaentry> <qandaentry> 

<question><para>Can I use keyboard? </para></question>
<answer><para>Answer Yes/No and explain how if positive.</para></answer>

</qandaentry> <qandaentry> 

<question><para>I can't figure out what to do here! Are there hints? </para></question>
<answer><para>Explain how to use feature if exists. If not, write: '&kapp-name; does not have this feature.', but do not remove the question.</para></answer>

</qandaentry> <qandaentry> 

<question><para>I have to quit the game now, but I'm not finished yet. Can I save my progress?</para></question>
 <answer><para>Explain how to use feature if exists. If not, write: '&kapp-name; does not have this feature.', but do not remove the question.</para></answer>

</qandaentry> <qandaentry> 

<question><para>Where are the highscores?</para></question>
<answer><para>Explain how to use feature if exists. If not, write: '&kapp-name; does not have this feature.', but do not remove the question.</para></answer>

</qandaentry> <qandaentry> 

<question><para>I want to change the game configuration. Where do I go? </para></question>
<answer><para>Refer to  section of 'Interface Overview' for details.</para></answer>

</qandaentry> <qandaentry> 

<question><para>I want to change the toolbar layout. What do I do?</para></question>
<answer><para>Refer to  section of 'Interface Overview' for details.</para></answer>

</qandaentry>

</qandaset> </chapter>

<chapter id="configuration"><title>Game Configuration</title> <para>This section describes configuration GUI.</para> </chapter>

<chapter id="credits"><title>Credits and License</title>

<para> &app-name; </para> <para> Program copyright [year from]-[year to] [first name] [last name] <email>[email address]</email> </para> <para> Graphics copyright [year to] [first name] [last name] <email>[email address]</email> </para> <para> Documentation copyright [year from]-[year to] [first name] [last name] <email>[email address]</email> </para>


&underFDL; &underGPL;

</chapter>


<appendix id="installation"> <title>Installation</title>

&install.intro.documentation;


<sect1 id="Compilation"> <title>Compilation and Installation</title>

&install.compile.documentation;

</sect1> </appendix>

&documentation.index; </book>

Retrieved from "https://community.kde.org/index.php?title=KDE_Games/Documentation_Progress&oldid=20425"