diff --git a/doc/boardeditor.png b/doc/boardeditor.png new file mode 100644 index 0000000..f0ae126 Binary files /dev/null and b/doc/boardeditor.png differ diff --git a/doc/index.docbook b/doc/index.docbook index e6e3315..6faf087 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -1,583 +1,611 @@ ]> The &kmahjongg; Handbook John Hayes justlinux@bellsouth.net EugeneTrounev
eugene.trounev@gmail.com
 &FDLNotice; -2019-05-06 -0.9 (Applications 19.08) +2019-10-17 +0.9 (Applications 19.12) This documentation describes the game of &kmahjongg; version 0.9 KDE kdegames game KMahjongg board arcade tile game tiles one player Introduction Gametype:Board, Arcade Number of possible players:One &kmahjongg; is a fun board game created after the famous oriental game of Mahjong (from Chinese 麻將). Unlike the original however, &kmahjongg; is a tile matching game for one player, a variation usually known as Mahjong Solitaire. In &kmahjongg; the tiles are scrambled and stacked on top of each other to resemble a certain shape. The player is then expected to remove all the tiles off the game board by locating each tile's matching pair. How to play Objective:Remove all tiles from the game board by locating each tile's matching pair as fast as possible. &kmahjongg; will load a default layout automatically once you start the game and you can start playing right away. Note:The game timer will start immediately if the game is started. You should carefully study the stack of tiles laid out on the game board and find two tiles matching exactly. When you have found such a pair use your mouse to select these. Note: Bear in mind that you can only select the tiles which are Open. Tiles are considered Blocked when they are positioned behind other tiles, or when both the right and left sides of the tile are filled by others. If at least one of the lateral sides is empty then the tile is considered 'Open', and can be removed. Once you have selected the right pair of tiles they will vanish off the game board, thus revealing the tiles previously located underneath, and opening the tiles adjacent to them. Find as many matches as possible to remove all the tiles from the game board. Game Rules, Strategies and Tips The Game Screen A screenshot of &kmahjongg; Screenshot A quick explanation of the parts of the game screen. Game Screen The Game screen is in the center of the screen and is the largest section of the window. The background is populated with the game tiles. Statusbar The status bar is located at the bottom of the screen, and contains four panes. The first pane displays the game timer, which keeps track of the elapsed time from the start of the game until the game is finished. The second pane lists the removed/total tiles and the number of matching tiles that have free sides. The third pane gives the sequence number of the game you are playing and the last pane lets the player know when the game is ready. Rules Standard Mahjong set of tiles includes: Group nameTile nameQuantity in a set Dots 1 of Dots4 2 of Dots4 3 of Dots4 4 of Dots4 5 of Dots4 6 of Dots4 7 of Dots4 8 of Dots4 9 of Dots4 Bamboos 1 of Bamboos4 2 of Bamboos4 3 of Bamboos4 4 of Bamboos4 5 of Bamboos4 6 of Bamboos4 7 of Bamboos4 8 of Bamboos4 9 of Bamboos4 Characters 1 of Characters4 2 of Characters4 3 of Characters4 4 of Characters4 5 of Characters4 6 of Characters4 7 of Characters4 8 of Characters4 9 of Characters4 Winds East Wind4 South Wind4 West Wind4 North Wind4 Dragons Red Dragon4 Green Dragon4 White Dragon4 Flowers Plum (1)1 Lily (2)1 Chrysanthemum (3)1 Bamboo (4)1 Seasons Spring (1)1 Summer (2)1 Autumn (3)1 Winter (4)1 The number of tiles on a KMahjongg board layout can differ from the number of tiles in the standard Mahjong tile set. That means that the number of occurrences of tiles of the same type can also differ from the number stated in the table above. Only the open tiles can be selected. Open tile is the tile which has one of the tile's lateral sides open, meaning that no other tiles are located immediately next to it. Only when matching, open tiles can be removed from the game board. Matching tiles are those where the face pictograms match. Note:There are exceptions to this rule! In the traditional game of Mahjong each tile has a matching one except for the Flowers and Seasons tiles. The Flowers tiles have no doubles in the set and can be matched directly to each other. The Seasons tiles have no doubles in the set and can be matched directly to each other. Not every &kmahjongg; game can be finished. Sometimes the tiles are mixed in such a way that it may not be possible to find all the matches. This problem can be avoided. Please refer to this section of the configuration dialog. To be eligible for a place amongst the high scores the player has to complete a game instance within the shortest period of time possible. Note:If the player uses the Hint feature the record will not be considered as a high score. Interface Overview Menu Items &Ctrl;N Game New Starts a new game. &Ctrl;O Game Load... Loads a saved game. F5 Game Restart Game Restarts the current game. Game New Numbered Game... Starts a specifically numbered game. Start a Numbered Game Dialog Start a Numbered Game Dialog &Ctrl;S Game Save Saves the current game. P Game Pause Pauses or resumes the game. While the game is paused, all tiles are hidden. &Ctrl;H Game Show High Scores Shows the high score list. Show High scores Show High scores When your game scores exceed the top ten scores listed, you are prompted to enter your name. Game Board Editor - Shows the board editor. + Shows the board editor. + + The board editor + + + The board editor + + + + + Procedure to edit layout: + + Use the board editor toolbar to create a new layout or to load and edit an existing one. + Save the layout in your user's local home folder in $XDG_DATA_HOME/kmahjongg/layouts + Create the name_of_your_layout.desktop file in the same folder. + Put the following lines in this file using your favorite text editor: + +[KMahjonggLayout] +Name=name_of_your_layout +Description=description_of_your_layout +VersionFormat=1 +Author=your_name +AuthorEmail=your_email +FileName=name_of_your_layout.layout + + Reload &kmahjongg; to use your new layout. + + + &Ctrl;Q Game Quit Quits &kmahjongg;. &Ctrl;Z Move Undo Undo your last move. &Ctrl;&Shift;Z Move Redo Redo a move that was undone. H Move Hint Gives a Hint by flashing a matching pair of tiles. D Move Demo Starts the game Demo mode. Move Shuffle Shuffles the tiles on the board. G View Rotate View Clockwise Rotates the tile viewing angle clockwise. F View Rotate View Counter Clockwise Rotates the tile viewing angle counter clockwise. Additionally &kmahjongg; has the common &kde; Settings and Help menu items, for more information read the sections about the Settings Menu and Help Menu of the &kde; Fundamentals. Frequently asked questions I want to change the way this game looks. Can I? Yes. To change the way &kmahjongg; looks use the menubar to open the configuration utility. Can I use the keyboard to play the game? No. This game does not feature a keyboard play mode yet. Game Configuration Configure Dialog Configure Dialog SettingsConfigure &kmahjongg;... opens the Configure - &kmahjongg; dialog. General options Blink matching tiles when first one is selected This setting will make the game highlight the selected tile on mouse click, and flash any matching tiles that have a free side at each move. No additional tiles will be highlighted if there are no matching tiles with a free side. Generate solvable games Selects only games that can be solved when you start a new game. Show removed tiles If checked, this setting allows &kmahjongg; to show the removed tiles on the board. Board layout options Random Layout Every new game will have a random layout of the existing one in the list. Board Layout selector Use the Board Layout selector to pick a gameboard to play. Different boards provide variable difficulty, depending on the number of tiles and their position. Board Layout selector Board Layout selector Tiles options Tiles selector Use the Tiles selector to choose graphics for the tiles. Tile selector Tiles selector Background options Background selector Use the Background selector to choose a background graphic for the game. Background selector Background selector Default Keybindings SettingsConfigure Shortcuts... allows you to change the default keyboard bindings. The default kebindings are as follows: Keyboard Shortcuts Key ComboAction&Ctrl;NStarts a new game&Ctrl;OLoads a previously saved gameF5Restart the game&Ctrl;SSaves the gamePPauses or resumes a game&Ctrl;HShow the highscores&Ctrl;QQuits the game&Ctrl;ZMove undo&Ctrl;&Shift;ZMove redoHGives you a hint by flashing two matching tilesDPlays the game in Demo modeGRotate the view angle clockwiseFRotate the view angle counter-clockwiseF1Displays this handbook&Shift;F1What's This Help
 Credits and License &kmahjongg; by &kde; Program Copyright © 1997 MathiasMueller in5y158@public.uni-hamburg.de Program Copyright © 2007 MauricioPiacentini piacentini@kde.org Contributors: DavidBlack david.black@lutris.com MichaelHaertjens mhaertjens@modusoperandi.com OsvaldoStark starko@dnet.it BenjaminMeyer ben+kmahjongg@meyerhome.net AlbertAstalsCid &Albert.Astals.Cid.mail; RaquelRavanini raquel@tabuleiro.com Documentation Copyright © 2005 JohnHayes justlinux@bellsouth.net &underFDL; &underGPL; &documentation.index;