# The &kappname; Handbook

Wolfgang
Rohdewald
wolfgang@rohdewald.de
Xosé
Calvo

Tradutor do proxecto Trasno
2010-03-19
&kappversion;

This documentation describes the game of &kappname; version &kappversion;

KDE
kdegames
xogo
kajongg
taboleiro
arcade
xogo de pezas
pezas
catro xogadores

## Introdución

### Tipo de xogo:

Taboleiro, Arcade

### Número de xogadores posíbeis:

Catro

&kajongg; is a board game created after the famous oriental game of Mahjong (from Chinese 麻將). It is played by four players. Worldwide many different rulesets are in use. Right now &kajongg; supports the Classical Chinese rules as played in Germany, eventually other main rulesets will follow. It is possible to customize or add new rulesets. Please do so and send them to the program author for integration!

O &kajongg; pódese empregar de dúas maneiras distintas: Xogando unha partidamanual no que ti xogas como sempre sen a axuda dun computador e empregas o &kajongg; para que leve a puntuación e as anotacións. Ou podes empregar o &kajongg; para xogar contra calquera combinación de xogadores humanos ou informáticos.

## A disposición da pantalla

Unha captura de pantalla do &kajongg; Captura de pantalla

Unha explicación rápida das partes da pantalla de xogo.

Barra de ferramentas

  A barra de ferramentas está situada por baixo da barra do menú e contén botóns para as accións máis frecuentes. Pódese modificar o contido da barra de ferramentas. Tamén se pode facer invisíbel para obter así máis espazo para o taboleiro.

Taboleiro

  O Taboleiro é a sección máis grande da xanela. Vense os catro muros cunha lonxitude de 18 pezas (o número exacto depende das regras, como se se usan pezas de premio ou non). os nomes dos xogadores están escritos nos muros, xunto co valor actual da man (no que se coñeza) e as pezas dos ventos. O vento dominante ten un fondo de cores, o leste na captura de pantalla anterior.

  Ao xogar, o interior dos muros contén as pezas descartadas polos xogadores. Colócanse á toa. A última peza descartada reálzase cunha moldura azul.

  Ao puntuar xogos manualmente, o interior dos muros ten unha selección de todas as pezas dispoñíbeis, o selector central. Pódenselle asignar aos xogadores empregando o rato ou o teclado.

Rexión do xogador

  Cada xogador ten un espazo para as súas pezas. A ringleira superior contén as pezas expostas e a inferior as que están agochadas. Ao puntuar xogos manualmente, as pezas agochadas aparecen cunha sombra sobre toda a peza. As pezas de premio van ao extremo dereito.

Diálogo

  O diálogo presenta as opcións de que dispón o xogador. O máis frecuente é que teña unha conta atrás cunha barra de progreso que mostra o tempo que resta.

Statusbar

  The Statusbar is located at the bottom of the screen and contains the current totals for the players.

## Puntuar un xogo manual

Neste modo, o &kajongg; só se emprega para levar as puntuacións. Xógase como normalmente con persoas reais nunha mesa real e ao final da partida pódeselle dicir ao &kajongg; as pezas que ten cada xogador na man e todo o demais de que precise saber o &kajongg; para calcular as puntuacións - que é o que fai. Alternativamente, pódense calcular as puntuacións das mans e introducilas manualmente. Nese caso, o &kajongg; fai os pagamentos entre os xogadores e escribe os resultados nunha base de datos. É posíbel suspender unha partida, iniciar outra con outros xogadores e retomar partidas anteriores. Gárdanse todas as regras xunto coas partidas, polo que se poden xogar partidas diferentes con regras diferentes.

- No menú, escolle Partida / Puntuar un xogo manualmente ou preme &Ctrl;C.

- Agora pódese tanto escoller unha partida existente sen rematar ou iniciar unha nova. Se se inicia unha nova, preguntaráseche polo número de xogadores e o conxunto de regras. O &kajongg; proporá os mesmos valores que se empregasen na partida anterior. Se non houber ningunha partida anterior, proporá os catro primeiros xogadores definidos. Lembra que non se pode mudar de conxunto de regras nen ningunha das regras unha vez seleccionado. Pódese facer antes no editor de conxuntos de regras.

- Agora aparece unha xanela nova chamada «Introducir os resultados da man». Le Facer que o &kajongg; calcule a puntuación para unha descrición detallada.

- Unha vez gardados os resultados da man, continúa coa man seguinte.

### Introducir os resultados dunha man

#### Puntuacións

Unha captura de pantalla do &kajongg;
Captura de pantalla

Esta é a xanela para introducir os resultados dunha man. Aparece automaticamente cando o &kajongg; pensa que se necesita. Pódese agochar ou mostrar en calquera momento premendo &Ctrl;S ou seleccionando a correspondente entrada do menú.

Como sempre, o vento dominante ten o fondo colorido.

Aquí pódense introducir manualmente as puntuacións de todos os xogadores. Alternativamente, pódense definir exactamente as pezas que cada xogador tiña na man. Se escolles facer isto, ponse en gris o campo correspondente ao valor da puntuación manual. O &kajongg; calcula a puntuación automaticamente.

After having entered all relevant data for a hand, press the button Save hand. The hand values will be entered in the data base, and they are also entered in the score table. You might be prompted to change the seating positions of the players but you can choose not to change seats. The proposed changes are currently not customizable - if a ruleset needs something different, we will change that.

If the player might have won, the checkbox in the column "Winner" will be enabled - click this for the winner.

A barra de estado mostra os saldos dos xogadores e pódese continuar coa man seguinte.

##### Introdución manual da puntuación

Un bo xogador normalmente prefire calcular a súa propia puntuación. Nese caso, pódese introducir directamente. Isto só é posíbel cando ese xogador non tiver ningunha peza seleccionada.

Se se introduce unha puntuación manual, esta ten que conter xa todo o necesario, excepto as penalizacións; non hai regras opcionais das que escoller. Hai unha excepción: «Xogo Perigoso». Isto non inflúe nas puntuacións nin é ningunha falta. Só significa que o pagamento entre os xogadores é distinto: O que comete unha infracción págalle todo por todo ao gañador. Os outros dous xogadores non intercambian os pagamentos. De momento isto non se pode personalizar.

##### Facer que o &kajongg; calcule a puntuación

Se se lle indican explicitamente ao &kajongg; as pezas que ten cada xogador, a introdución de puntuacións aparecerá en gris para ese xogador nesta xanela. Ao asociar as pezas cun xogador vese como medra a súa puntuación - mais así que se engade a peza número 14, a puntuación baixa a cero. Podería sorprender, mais, a non ser que se declare como man gañadora, recoñécese como man longa, que sempre ten cero puntos. Este comportamento aparece definido no conxunto de regras clásicas chinesas; podería ser diferente se se modifica ou se se emprega un conxunto diferente.

Pódense asociar as pezas e os grupos cun xogador empregando tanto o rato como o teclado como ambos os dous. Co rato chega con mover as pezas para a rexión do xogador. Ao soltar a peza pregúntase polo que se desexa mover: Simple, Par, Pung, Kong, Kong Reclamado ou Chow. A ringleira superior é para as pezas expostas, a inferior para as agochadas. As pezas de premio aparecen no extremo dereito. Tamén se poden mover as pezas e os grupos entre as ringleiras, entre os xogadores e de volta ao selector central.

If you prefer using the keyboard, you can use &Tab; to move between the central selector and the player regions. The keys eswnESWN move a tile to the players East, South, West and North. The keys xX move it back to the central selector. ESWN moves to the concealed row, eswn moves to the exposed row. You can move the cursor between tiles or melds using the arrow keys, the currently selected tile or meld has a blue frame. Since the key arrows are far away from letters on the keyboard, you can also use the letters hjkl or HJKL for moving the cursor. hH move left, jJ move down, kK move up, lL move right. This is how the unix editor "vi" does it. The KDE browser konqueror and even this help program also support those keys in the same way. Those keys may differ if you use a language other than English but it is currently not possible to configure them.

As opcións «Última peza» e «Último grupo» precísanas algunhas regras, como «a última peza completa o par». Só se poden empregar para a man gañadora.

Na parte dereita da xanela pódense aplicar algunhas regras manualmente. As regras que aparecen na lista dependen do conxunto de regras actual e das pezas. No exemplo da captura de pantalla de arriba, os xogadores que perden poderían ter unha opción de «xogo perigoso» - igual que antes, dependendo do conxunto de regras e das súas pezas. Os programadores pretenden manter esta lista de regras seleccionábeis manualmente o máis reducida posíbel. Optimamente, o &kajongg; debería ser quen de determinar automaticamente se se aplica unha regra, aínda que ás veces o &kajongg; non dispón de información de abondo ou non sabe como decidir.

#### Penalties

Unha captura de pantalla do &kajongg;
Captura de pantalla

Na xanela para introducir os resultados manualmente, o botón Penalizacións activa esta xanela, na que se poden introducir as penalizacións. Pódese facer en calquera momento, independentemente do mecanismo de puntuación normal.

The offense selection shows all offenses that might be applicable to the hands the players hold. Choose among them.

Agora pódese adaptar a Penalización Total. Esta é a suma total que se move de pagadores a pagados. Repártese equitativamente entre eles.

Dependendo do tipo de infracción varía o número de pagadores e de pagados. Móstrase o número correcto de xogadores. Se escolles un xogador, o &kajongg; asegúrase de que ese xogador só aparece unha vez adaptando os demais xogadores.

## Forma de xogar

### Xogar contra o computador

First you will get a login dialog. Enter the game server you want to connect to and your user name. If you choose the special entry "Local Game", you only need to enter your name (or accept the proposed name) and the wanted ruleset. This will immediately start a local game where you play against 3 robot players.

### Xogar contra amigos

Se queres xogar contra outras persoas reais precisas dun servidor de xogos ao que se poidan conectar todos os xogadores, ti incluído/a. Faino escollendo calquera outra máquina ou introducindo manualmente un nome de máquina novo e indicando o teu contrasinal para esa máquina. Proponse o último contrasinal empregado.

If you do not have an account on that server with the name you entered, you will be asked if you want to open an account. If you say yes, you will get a new dialog where you can enter the wanted password twice. Your account will be created automatically.

Tendo accedido ao servidor de ficheiros, aparece unha lista das mesas con asentos dispoñíbeis nese servidor de xogos. Séntate a unha mesa ou crea unha nova. Se creas unha táboa nova, agarda até que outros xogadores se senten a ela. Podes comezar o xogo nunha mesa que ti creases en calquera momento, pois os sitios que non colla ninguén serán ocupados por xogadores robots.

A listaxe de táboas tamén mostra o nome do conxunto de regras co que se xoga nesa mesa. O conxunto de regras e o seu nome envíaos ao servidor de xogos o xogador que inicia a mesa. Se dispós dun conxunto de regras idéntico, a mesa mostra o nome que ti lle dás ao conxunto de regras - isto é útil se quen iniciou a mesa fala outra lingua e o seu conxunto de regras ten un nome distinto. Tamén, se o nome do teu conxunto de regras local aparece, faino en negro. Se, no entanto, non dispós dun conxunto de regras idéntico, o nome aparece en vermello e entón podes empregar o botón Comparar para comparalo cos teus propios conxuntos de regras.

You can start the Kajongg game server in two different ways:

- conectando ao servidor «localhost». Este é o teu computador. Se fas así e non se está a executar ningún servidor de xogos, un iníciase automaticamente. E cando paras de xogar, tamén para o servidor.

- manually start a server on any computer you want. All you need to do is go to a command line and start the program "kajonggserver". Entering "kajonggserver --help" will show you all available options like changing the default port 8149. This server will run until you kill it.

In both cases you need to tell the other players how they can reach your game server. They need the URL or simply an IP address and the port your server is listening on. This might be something like "mypc.dyndns.org:8149" where 8149 is the port. Of course you need to configure your firewall such that the remote player can reach that port. The communication will be encrypted.

If you encounter possible bugs, you might want to use the option "--showtraffic". This will show you, on the console where the game server has been started, what messages are flowing between the game server and the clients.

#### Advertencias

- Se desexas asegurarte de que ninguén fai trampas, ningún dos xogadores humanos debería ter acceso ao computador no que se está a executar o servidor de xogos. Por suposto, nunca se pode evitar que dous xogadores se axuden mutuamente porque non vas saber o que están a facer realmente. Pode que dous xogadores sexan a mesma persoa.

### How to play

Pregúntaseche que desexas facer. Este é un diálogo que aparece ou na dereita ou no fondo, dependendo do tamaño da xanela. Se é máis larga que alta, o diálogo aparece á dereita. Ás veces o diálogo ten unha conta atrás - cando acaba selecciónase automaticamente a primeira resposta posíbel. Esta conta atrás é configurábel no Editor de conxuntos de regras, en Opcións, Conta atrás da petición. Todos os xogadores teñen que ter a mesma conta atrás e por iso fai parte do conxunto de regras.

Se tes que escoller unha peza da túa man, pódeste mover entre as pezas empregando as teclas de frechas dereita e esquerda ou as letras h e l do teclado. Tamén se pode empregar o rato, claro.

Con frecuencia, os diálogos ofrecen opcións que non son realmente aplicábeis, como pedir Pung cando non se teñen as pezas precisas. Isto é adrede, como nun xogo real.

As pezas descartadas colócanse ao chou entre os muros. Algunha variantes do xogo definen onde hai que colocar as pezas mais isto aínda non é configurábel. Cando o sexa, será parte do conxunto de regras.

## Vista xeral da interface

### O menú Partida

Partida Puntuar unha partida manual

  Só puntuar unha partida que se xogue manualmente.

  Pódese cargar unha partida antiga ou iniciar unha nova. Por omisión, na lista de selección só aparecen partidas pendentes (ou sexa, sen rematar). Opcionalmente pódense mostrar todas as partidas, incluídas as rematadas. Tamén se poden eliminar partidas aquí.

Partida Xogar

  Xogar contra outros (persoas e computadores)

Partida Cancelar

  Cancelar esa partida. Se era unha partida manual con só puntuación pódese retomar máis tarde. Se xogaches empregando o &kajongg;, non se pode retomar a partida.

Partida Saír

  Sae do &kappname;.

### O menú Vista

Vista Puntuación

  Diálogo de puntuacións: Mostrar ou agochar o diálogo de puntuacións. Este diálogo está explicado aquí.

Vista Táboa de puntuacións

  Score Table Score Table Screenshot Show the score table. The leftmost column with the values E,S,W,N shows the player wind. The prevailing wind (the round wind) has a yellowish background. The winner has a green background in the Score column. The ∆ column shows how much the player paid to or received from all other players with this hand. The ∑ column shows the balance. The hints give you more details: They show all rules that have been applied to this hand.

  The lower part shows the used ruleset. Between the score table and the used rule you can find a splitter letting you change the relative sizes of both parts.

Vista Explicar as puntuacións

  Explain Scores Score Table Score Table Explains how the score for the current hand was computed.

### O menú Configuración

Configuración Xogadores

  Engadir, modificar e eliminar xogadores.

Configuración Mudar de ángulo visual

  Muda o ángulo de visualización das pezas no sentido anti-horario.

Configuración Modo a pantalla completa

  Conmuta entre o modo a pantalla completa e o modo normal.

Configuración Mostrar a barra de ferramentas

  Mostra ou agocha a barra de ferramentas.

Configuración Mostrar a barra de estado

  Shows or hides the Statusbar.

Configuración Configurar os atallos de teclado...

  Mostra un diálogo normal de configuración de atallos do &kde; para os atallos deteclado do &kappname;.

Configuración Configurar as barras de ferramentas...

  Mostra o diálogo normal do &kde; no que se poden configurar as iconas da barra de ferramentas.

Configuración Configurar o &kappname;...

  Abre un diálogo de configuración do &kappname;.

### O menú Axuda

&help.menu.documentation;

## Configuración do xogo

Diálogo de configuración
Diálogo de configuración

A entrada do menú Configuración Configurar o&kappname;... abre o diálogo Configurar - &kappname;.

Premendo aquí o botón Cancelar restáuranse todas as alteracións feitas, incluído todo o que se fixese no editor de conxuntos de regras.

Tamén se poden escoller as diferentes lapelas co teclado: &Ctrl;1 selecciona as opcións Xogar da primeira lapela, &Ctrl;2 selecciona a segunda lapela, e así.

### Opcións de Xogar

Mostrar as sombras das pezas

  Isto mostra as pezas con bordos e sombras. Tamén hai certo espazo entre as ringleiras de pezas e as pezas do muro aparecen de xeito que se ve que o muro ten dúas ou tres pezas de altura. Polo tanto, se se desactiva esta opción tense unha imaxe máis simple con pezas lixeiramente máis grandes. Pode resultar útil en pantallas pequenas.

Redistribuír as pezas sen descubrir aos grupos

  Isto agrupa os grupos na man. Ás veces o agrupamento podería non ser o que queiras, polo que podes preferir non ter ningún agrupamento, igual que nun xogo no mundo real.

Empregar sons, de habelos dispoñíbeis

  Isto permite ouvir descartes e peticións. SE outros xogadores gravaron ficheiros de son coa súa voz, pódelos escoitar.

Que outros ouzan a miña voz

  Se gravaches ficheiros de son coa túa voz, esta opción permite que os demais xogadores ouzan os teus descartes e peticións coa túa propia voz.

#### Son

It is possible to record sound files for your announcements which will be heard by the other players. There is some manual work needed:

- First you need to find out where to store your voice files. This directory normally is ~/.kde/share/apps/kajongg. So if your login name is joe, this might be /home/joe/.kde/share/apps/kajongg. In there you will also find the database kajongg.db.

- In the directory you just found, generate a new subdirectory with the name `voices`.

- In the directory `voices` generate another subdirectory with your player name. This is the name you use when connecting to a game server. You may also want to define voices for the players `ROBOT 1`, `ROBOT 2`, `ROBOT 3`.

- In that subdirectory, you can place the sound files. They have to be encoded with the Ogg Vorbis audio compressor, the file names need to have the extension `.ogg`.

- A single file has a name like `s3.ogg` - this is Stone 3. You should define such files for all tiles and for all claims and announcements.

Please make the length of the sound short but speak clearly - this game can be played very fast when you get used to it. It is easier if you first write down a list with everything that should be spoken. Do not read it as a sequence of items, try to pronounce each item as if it were the only one and as you would when playing. Reading this needs a little practicing.

Esta é só unha das posibilidades que pode haber para crear ficheiros de son:

- Grava un ficheiro de son co programa `garecord`, grávao no formato `WAV`. Neste único ficheiro de son inclúe todos os sons.

- Edítao co editor de son `audacity`. Neste, emprega o rato para marcar un intervalo de ondas sonoras. O editor reproduce esa parte. Repite até que a teñas ben seleccionada. Pode resultar máis doado con Ver Ampliar. Emprega a orde do menú Ficheiro Exportar a selección e grava no formato ogg. En Opcións, escolle calidade baixa - abonda e é o preferido porque así redúcese o tempo de transferencia dos sons aos demais xogadores.

A seguir van os nomes dos ficheiros que hai que xerar. Engádelles sempre a extensión `.ogg`:

##### Nomes dos ficheiros de son

&s1; .. &s9; | Pedra 1 a Pedra 9
&b1; .. &b9; | Bambú 1 a Bambú 9
&c1; .. &c9; | Carácter 1 a Carácter 9
&we; &ws; &ww; &wn; | Os ventos Leste, Sul, Oeste, Norte
&db; &dr; &dg; | Os dragóns azul/branco, vermello, verde
&chow; &pung; &kong; &mahjongg; | Os cantes principais
&originalcall; &violatesoriginalcall; | Original call and its violation
&dangerousgame; | Un xogador dispara un canón (xogo perigoso)
&nochoice; | Un xogador declara que non ten máis opción que xogar un xogo perigoso

### Opcións das pezas

Selector do xogo de pezas
Selector do xogo de pezas

Emprega o selector Pezas para escoller as imaxes das pezas.

### Opcións do fondo

Selector do fondo
Selector do fondo

Emprega o selector fondo para escoller unha imaxe de fondo para o xogo.

Algúns fondos, como Paisaxe chinesa precisan de certo tempo para seren cargados. Se consideras que o programa debería iniciarse máis rápido ou que o cambio de tamaño da xanela leva demasiado tempo, tenta con outro fondo.

### Editor do conxunto de regras

Editor do conxunto de regras
Editor do conxunto de regras

Emprega o Editor do conxunto de regras para personalizar os conxuntos de regras. Os predeterminados aparecen en cursiva e os personalizados teñen un tipo de letra normal. O usuario non pode alterar os conxuntos de regras predeterminados de ningún xeito, aínda que si o podería facer unha actualización do &kajongg;. Os conxuntos de regras personalizados nunca se verán afectados por unha actualización.

Ao comezar unha partida pódese escoller un conxunto de regras. Pódense empregar todos os que se definan no editor de conxuntos de regras. O conxunto de regras grávase xunto co xogo, polo que sempre se pode alterar aquí - as modificacións só afectarán os xogos futuros.

#### Rule, Score and Unit

Simply double click on whatever you want to change.

#### Definition

The definition for a rule can be rather complex. There is a separate chapter Defining a Rule for this. You will normally not have to change a definition. This essentially defines to what hands the rule applies.

#### Copiar e eliminar

You can copy entire rulesets or single rules within a ruleset. Since predefined rulesets are immutable, single rules can only be copied within customized rulesets.

You can remove entire customized rulesets or single rules within them. Again this can even be done if existing games use this ruleset since every game has its own ruleset copy. You can view rulesets for old games: Load the old game and show its score table.

#### Comparar

Comparador de conxuntos de regras Comparador de conxuntos de regras Pódese escoller esta orde cando se selecciona un conxunto de regras completo. Permite comparalo contra calquera outro conxunto de regras.

### Atallos de teclado predeterminados

The menu entry Settings Configure Shortcuts... allows you to change the default keyboard bindings.

The default keybindings are as follows:

F1

  Mostra este manual.

&Ctrl;C

  Puntuar unha partida manual.

&Ctrl;N

  Xogar unha partida contra amigos ou computadores.

&Ctrl;W

  Cancelar esa partida.

&Ctrl;Q

  Saír do programa.

&Ctrl;T

  Mostrar a táboa de puntuacións.

&Ctrl;G

  Mudar de ángulo visual.

&Shift;F1

  Axuda «Que é isto?»

&Ctrl;&Shift;F

  Modo de pantalla completa

## Defining a Rule

The scoring engine and many other aspects of &kajongg; can be customized with the ruleset editor. A rule consists of a name, a score (including its unit) and a definition.

### Rule Groups

There are several groups of rules:

Meld Rules

  Meld rules are applied to single melds independent of the rest of the hand.

Hand Rules

  Hand rules are applied to the entire hand, for all players.

Mah Jongg Rules

  Mah Jongg rules specify how a winnable hand has to look like. This is normally four melds with 3 or 4 tiles each and a pair. But special hands may look differently, for example the 13 Orphans in Classical Chinese.

Winner Rules

  Winner rules are applied to the entire hand but only for the winner. This includes most special hands. Those rules do not have to enforce the correct number of tiles.

Options

  Here you can find several special parameters like points for a limit hand.

Penalties

  Penalties are applied manually by the user.

#### Order of Execution

- build a list of applicable rules from meld rules and hand rules

- using the Mah Jongg rules find out if the declared winner hand is really a winner hand.

- for the winner append applicable winner rules

- if some of the found rules have the action '&absolute;', only keep those. It is yet undefined what happens if more than one is found.

- if some of the rules define limits, throw away all others

- apply the found rules in that order

### The Definition

The definition is one single string because we want to make it easy to save it in a data base. It consists of several parts separated by the two characters "||". A part expresses either a condition under which the rule applies or it expresses some actions. Only one part for actions may be defined, but several condition expressions. The rule applies as soon as at least one condition expression matches the hand.

&kajongg; comes with a predefined ruleset implementing the Classical Chinese rules as defined by the German DMJL. That should give you a lot of examples.

These are all recognized parts:

Variable Case Regular Expression

  A part starting with I is a Regular Expression making no difference between upper/lowercase.

Action

  A part starting with A is a list of Actions.

Manual Expression

  This is an optional Regular Expression. For scoring manual games, it defines whether this rule should be selectable by the user with a checkbox. The leading M does not belong to the Regular Expression. An example would be the Rule "Last Tile Taken from Dead Wall".

Regular Expression

  Any other part is a Regular Expression.

### Regular Expressions

Regular expressions are a very powerful programming tool for matching strings of characters. Powerful but also quite difficult. This is not for the normal game player. There are books available which do nothing else but explain regular expressions.

There are several dialects of regular expressions. &kajongg; is written in the programming language Python. Since the Python standard library contains a module for regular expressions, this is the dialect we use.

For details see

Everything about a hand that might have an influence on the score is encoded in one single string. Then &kajongg; checks if the regular expression matches this string. If it does, the rule is applied.

As an example, this regular expression matches the limit hand "All Greens":

    ( |[bB][23468]|[dD]g)*[fy/]

#### Structure of a Hand String

The content of a hand string is always the same no matter what language you use on your desktop.

The string representing a hand consists of several parts separated by a space. The order of those parts is always the same except for the meld parts at the beginning.

&kajongg; is able to regroup concealed tiles into melds aiming to get a higher score. It does not matter how the concealed tiles are grouped for this to work. However when it comes to limit hands this might fail. That is why &kajongg; will try the original grouping of tiles as entered by the user and also the regrouped tiles. For both variants, all rules are applied. The variant achieving the higher total score is used.

Here comes an example. This is really only one line but split here for better readability. Moreover this sentence is repeated once because some regular expressions are much easier to write if the parts can be referenced in another order. See the rule for Robbing the Kong: Its regular expression first looks at the L group (Last Tile) before looking at the melds.

    c1c1c1C1 s1s2s3 b6b6b7b7b8b8 b5b5 fn yn
    /c416s000b000b000b200 -C416s000b000b000b200 %n Mneka LB5B5B5

A tile is represented by 2 characters. The first one is s for stone, b for bamboo, c for character, w for wind, d for dragon, y for season bonus, f for flower bonus. The second one is 1..9 for the suits, e,s,w,n for the winds, w,r,g for the dragons (white, red, green) and 1,2,3,4 for the bonus tiles. Exposed tiles have the first character in lowercase, concealed tiles have it in uppercase.

All the following parts are always present in this order except the part "Last Tile": This one exists only for the winner hand.

Meld

  The part starting with any of the characters `sbcdwSBCDW` is a meld. A meld holds any number of tiles. &kajongg; will split melds with too many tiles trying to maximize the score.

  We use a special syntax for kongs: c1c1c1c1 is an open kong. c1c1c1C1 is an open kong, 4th tile was called for, completing a concealed pung. This is needed for the limit game 'concealed true color game'. c1C1C1c1 is a concealed declared kong. C1C1C1C1 would be a concealed undeclared kong. But since it is undeclared, it is counted as a pung. So this meld will be split into pung C1C1C1 and single C1.

  Bonus tiles appear after all other melds.

Summary

  The part starting with / holds summary information about the melds. This makes it easier to write some regular expressions. Every meld is represented by four characters. The first character is one out of `sbcdwSBCDW`, again lowercase for exposed and uppercase for concealed. The second character is a number saying how many tiles the meld holds. This is 1 up to 4 for a kong. The 0 is used for a chow. The last two characters hold the value of this meld.

Alternate summary

  The part starting with - is identical to the above summary but it contains claimed kongs as concealed kongs. Some rules like "Three Concealed Pongs" treat a claimed kong as being concealed.

Hand length

  The part starting with % holds information about the length of the hand: s is a short hand having too few tiles, n is a hand with the correct number of tiles, l is a long hand having too many tiles.

Mah Jongg

  The part starting with m, M or x holds additional information. M stands for the winner hand, m for a loser hand, and x stands for a hand that is forbidden to say Mah Jongg. M/m/x is followed by one character for the own wind, one character for the prevailing wind, one character for the source of the last tile leading to Mah Jongg, one character for the declarations a player made.

  These are the possible sources of the last tile: w=wall, d=discarded, e=dead end, z=last tile of living end, Z=last tile of living end, discarded, k=robbing the kong, 1=blessing of heaven/earth. The values w and d are special - they are sort of intermediate values. By choosing a concealed tile as last tile, the source is set to w. Next, several rules say that they apply only if the last tile comes from the wall. So this allows for a better preselection of actually applicable manual rules. For a better understanding, please look at the manual rules and read up about the action &lastsource;.

  These are the possible declarations: a=call at beginning, t=twofold fortune.

Last Tile

  The part starting with L holds information about the last tile. It contains the last tile itself, followed by the meld that was completed with the last tile. We need this last meld for the rule "Last Tile is the Only Possible" because sometimes knowing only the last tile is not sufficient. Note that the last meld cannot be a Kong because if it completes a Kong you have to draw a replacement tile.

Calling Limit Hand

  This is not yet implemented but might be needed for rules like defined by the BMJA (in England). A part starting with K holds all possible tiles to be checked for if we give points for a calling limit hand. We could use brute force and check with every tile but that might take too much time.

### Actions

All actions for a rule are defined in one string. They are separated by spaces. Some of them define a value.

&payforall;

  The player did something very nasty, so she must pay for all. Yet this is not a penalty since the sum of payments is the same - only the payer changes. Also, the two payers not involved do not exchange payments.

&payers;=X

  Defines how many payers this penalty rule implies. X is a number.

&payees;=X

  Defines how many payees this penalty rule implies. X is a number.

&absolute;

  This action defines an absolute payment. The hand score is ignored. Used for penalty rules.

&lastsource;

  This action defines the source of the last tile. Used by manual rules like "last tile from dead end". Setting the last source with this action serves as a filter for other rules - if they trigger only for certain sources. Those other rules can of course also be manual rules. So this filtering will narrow down the amount of manual rules the user gets shown in the scoring dialog. If this seems complicated, just play around with the scoring dialog and watch checkboxes appear and disappear depending on the source of the last tile.

## Problemas coñecidos

- Aínda non é posíbel que o xogador mesmo abra unha conta no servidor do xogo.

- No modo de xogo aínda non é posíbel ter penalizacións.

- Os xogadores-computador son ben parvos aínda.

- Non se poden personalizar os nomes dos xogadores-computador.

- Computer games cannot yet be resumed.

## Posíbeis características futuras

- Engadir máis conxuntos de regras. Opcionalmente isto deberíano facer aquelas persoas que os utilicen habitualmente.

- Add sounds. The calls "Chow" &etc; should be played, also what tiles are discarded. Define standard sounds, but also make it possible for the player to record her own voice.

## Preguntas frecuentes

Quero cambiar o aspecto do xogo. Podo?

Yes. To change the way &kappname; looks use the menubar to open the configuration utility.

Pode empregar o teclado para asignarlles as pezas aos xogadores?

Si. Consulta Facer que o &kajongg; calcule a puntuación

## Créditos e licenza

&kappname; for &kde;

Program Copyright © 2009, 2010 Wolfgang Rohdewald wolfgang@rohdewald.de

Documentation Copyright © 2009, 2010 Wolfgang Rohdewald wolfgang@rohdewald.de

Tradución da documentación: Xosé Calvo - http://trasno.net/

&underFDL; &underGPL;

## Instalación

Empregue o paquete de . Se non funciona, pódese descargar kajongg-x-y.tar.gz do mesmo enderezo e a seguir facer o seguinte:

    tar xfz kajongg-x-y.tar.gz
    cd kajongg-x-y
    ./setup.py install

Nos dous casos haise que asegurar manualmente de que se dispón dos demais paquetes requiridos. O paquete para debian aínda non contén estes requisitos. O &kajongg; precisa de: (os paquetes de debian correspondentes en parénteses)

- a biblioteca para xogos do KDE4 (libkdegames5)

- Python 2.5 or higher (python)

- QT4.4 or superior (libqt4-core, libqt4-gui, libqt4-svg, libqt4-sql, libqt4-sql-sqlite)

- os bindings de python para o QT4 (python-qt4, python-qt4-sql)

- os bindings de python para o KDE4 (python-kde4)

- a biblioteca twisted de python (python-twisted-core)

- sqlite3 (libsqlite3-0)

&documentation.index;