Nota: La arquitectura de esta aplicación así como el protocolo de comunicación están inspirados en http://irc-chess.sourceforge.net/. El módulo Chess es autoría de Arno van Lumig: https://github.com/ArnoVanLumig/chesshs, pero fue modificado corrigiendo las funciones stalmate y mate, así como otros errores.
Este documento pretende describir el protocolo que rige la comunicación entre el servidor de ajedrez (escrito en Haskell) y el cliente IRC que actúa como bot.
El servidor es quien implementa toda la lógica de negocio requerida por el juego de ajedrez. El cliente simplemente se encarga de:
- Recoger las solicitudes de los jugadores en un canal IRC, digamos #foo, y enviarlas al servidor.
- Recibir las respuestas del servidor para luego mostrarlas en #foo.
Los mensajes enviados del cliente al servidor son descritos a continuación. Los mensajes del servidor al cliente son documentados después, junto con el código de colores empleado.
SESSION <channel>
Mensaje enviado cada vez que se establece una conexión cliente-servidor. El canal channel estará asociado a esta sesión, debido a que será de donde se recojan los mensajes de los jugadores así como donde se desplieguen las respuestas del servidor. No habrá más de una sesión por canal al mismo tiempo. La sesión termina o bien después de que culmina la partida o bien después de un mensaje de CLOSE.
CLOSE
Cierra la conexión con el servidor.
REGISTER <nick>
Se registra el jugador nick. El primero que se registre será las blancas y el segundo las negras.
START <nick> <FEN|'Default'>
Comienza el juego en la posición dada por FEN (notación Forsyth-Eduards). Si es 'Default' es la posición inicial por defecto. El jugador nick debe haberse registrado previamente a esa partida.
MOVE <nick> <move>
Realiza una jugada. El parámetro nick es el nick del jugador que realiza el movimiento, mientras move es su representación algebraica estándar (SAN).
BOARD <'White'|'Black'>
Retorna el tablero desde la perspectiva de las blancas/negras.
POSITION
Retorna la posición actual en notación FEN.
PGN
Guarda la partida actual en formato PGN en un archivo de texto.
DRAW <nick>
El jugador nick ofrece o acepta tablas, dependiendo del turno.
RESIGN <nick>
El jugador nick se retira del juego.
Responden al siguiente formato:
<message><endmark> | <message><delimiter><history><delimiter><board><endmark>
donde cada uno de estos tokens tiene el siguiente significado:
<message> ::= <string>
{utilizado para mensajes, ej. "Blancas mueven."}
<board> ::= representación del tablero
{sigue el código de colores descrito al final de esta sección}
<delimiter> ::= "<:=:>"
{el delimitador es "<:=:>" sin las comillas}
<history> ::= la historia de las últimas jugadas
{por ejemplo, "1. e4"}
<string> ::= cualquier secuencia de caracteres excepto <delimiter>
<endmark> ::= "-###-"
{esta secuencia indica el fin de un mensaje}
Para ejemplificar la codificación de los escaques, lo mejor es ver una sesión completa a través de telnet:
pierrot@TOSHIBA-Debian-pbz:~$ telnet localhost 4321
Trying ::1...
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
SESSION #chess
Se ha iniciado una sesión en #chess.
-###-
REGISTER netman
Se ha registrado 'netman' para jugar con Blancas.
-###-
REGISTER pierrot
Se ha registrado 'pierrot' para jugar con Negras.
-###-
START pierrot Default
Blancas mueven. Es el turno de 'netman'.
<:=:>
8 <BYELLOW><bBLACK> ♜ <BBLUE><bBLACK> ♞ <BYELLOW><bBLACK> ♝ <BBLUE><bBLACK> ♛ <BYELLOW><bBLACK> ♚ <BBLUE><bBLACK> ♝ <BYELLOW><bBLACK> ♞ <BBLUE><bBLACK> ♜ <NORMAL>
7 <BBLUE><bBLACK> ♟ <BYELLOW><bBLACK> ♟ <BBLUE><bBLACK> ♟ <BYELLOW><bBLACK> ♟ <BBLUE><bBLACK> ♟ <BYELLOW><bBLACK> ♟ <BBLUE><bBLACK> ♟ <BYELLOW><bBLACK> ♟ <NORMAL>
6 <BYELLOW> <BBLUE> <BYELLOW> <BBLUE> <BYELLOW> <BBLUE> <BYELLOW> <BBLUE> <NORMAL>
5 <BBLUE> <BYELLOW> <BBLUE> <BYELLOW> <BBLUE> <BYELLOW> <BBLUE> <BYELLOW> <NORMAL>
4 <BYELLOW> <BBLUE> <BYELLOW> <BBLUE> <BYELLOW> <BBLUE> <BYELLOW> <BBLUE> <NORMAL>
3 <BBLUE> <BYELLOW> <BBLUE> <BYELLOW> <BBLUE> <BYELLOW> <BBLUE> <BYELLOW> <NORMAL>
2 <BYELLOW><bWHITE> ♟ <BBLUE><bWHITE> ♟ <BYELLOW><bWHITE> ♟ <BBLUE><bWHITE> ♟ <BYELLOW><bWHITE> ♟ <BBLUE><bWHITE> ♟ <BYELLOW><bWHITE> ♟ <BBLUE><bWHITE> ♟ <NORMAL>
1 <BBLUE><bWHITE> ♜ <BYELLOW><bWHITE> ♞ <BBLUE><bWHITE> ♝ <BYELLOW><bWHITE> ♛ <BBLUE><bWHITE> ♚ <BYELLOW><bWHITE> ♝ <BBLUE><bWHITE> ♞ <BYELLOW><bWHITE> ♜ <NORMAL>
a b c d e f g h
-###-
MOVE netman d4
1. d4
Negras mueven. Es el turno de 'pierrot'.
<:=:>
1 <BYELLOW><bWHITE> ♜ <BBLUE><bWHITE> ♞ <BYELLOW><bWHITE> ♝ <BBLUE><bWHITE> ♚ <BYELLOW><bWHITE> ♛ <BBLUE><bWHITE> ♝ <BYELLOW><bWHITE> ♞ <BBLUE><bWHITE> ♜ <NORMAL>
2 <BBLUE><bWHITE> ♟ <BYELLOW><bWHITE> ♟ <BBLUE><bWHITE> ♟ <BYELLOW><bWHITE> ♟ <BBLUE> <BYELLOW><bWHITE> ♟ <BBLUE><bWHITE> ♟ <BYELLOW><bWHITE> ♟ <NORMAL>
3 <BYELLOW> <BBLUE> <BYELLOW> <BBLUE> <BYELLOW> <BBLUE> <BYELLOW> <BBLUE> <NORMAL>
4 <BBLUE> <BYELLOW> <BBLUE> <BYELLOW> <BBLUE><bWHITE> ♟ <BYELLOW> <BBLUE> <BYELLOW> <NORMAL>
5 <BYELLOW> <BBLUE> <BYELLOW> <BBLUE> <BYELLOW> <BBLUE> <BYELLOW> <BBLUE> <NORMAL>
6 <BBLUE> <BYELLOW> <BBLUE> <BYELLOW> <BBLUE> <BYELLOW> <BBLUE> <BYELLOW> <NORMAL>
7 <BYELLOW><bBLACK> ♟ <BBLUE><bBLACK> ♟ <BYELLOW><bBLACK> ♟ <BBLUE><bBLACK> ♟ <BYELLOW><bBLACK> ♟ <BBLUE><bBLACK> ♟ <BYELLOW><bBLACK> ♟ <BBLUE><bBLACK> ♟ <NORMAL>
8 <BBLUE><bBLACK> ♜ <BYELLOW><bBLACK> ♞ <BBLUE><bBLACK> ♝ <BYELLOW><bBLACK> ♚ <BBLUE><bBLACK> ♛ <BYELLOW><bBLACK> ♝ <BBLUE><bBLACK> ♞ <BYELLOW><bBLACK> ♜ <NORMAL>
h g f e d c b a
-###-
A continuación se muestra al servidor en funcionamiento. El bot bumble consiste en un script Perl que hace de cliente, actuando de intermediario entre los jugadores y el servidor de ajedrez.
