Quantum Chess

Taller de Programación I

Matías Charrut - 101137

Santiago Lopez - 100566

Andrés Zambrano - 105500

Link al repositorio

Dependencias

• Git
• Make
• CMake
• gcc
• g++
• SDL2 (paquetes libsdl2-dev, libsdl2-mixer-dev, libsdl2-ttf-dev, libsdl2-image-dev)
• Valgrind (solo si se desea correr con el mismo)

Instalación

Para instalar el programam, primeramente se debe clonar el repositorio en una consola utilizando

git clone --recurse-submodules git@github.com:Santoi/quantum-chess

luego, estando ubicado en la carpeta del repositorio, se debe ejecutar el script de instalación con permisos de super usuario.

sudo bash install.sh

Esto copiará los archivos tanto binarios como de recursos en las carpetas correspondientes. Para desinstalar, de la misma manera, se debe ejecutar

sudo bash uninstall.sh

Ejecución del server

Para ejecutar el server, se debe ejecutar la siguiente linea en una terminal desde cualquier ubicación, donde port es el puerto en el que se abrirá el server y config_file el archivo de configuración del tablero, el cual debe estar ubicado en /usr/local/share/quantum_chess/boards/ (solo el nombre del archivo, sin esta primera carpeta). Si no se explicita este último parámetro, se utilizara el archivo default.txt.

quantum_chess_server <port> [config_file]

Ejecución del cliente

Al instalar, se creará un acceso directo al cliente del juego en la sección de Juegos del sistema operativo, que permite ejecutarlo directamente.

También es posible ejecutarlo desde una consola, estando en cualquier ubicación, utilizando

quantum_chess

Compilación (sin instalación)

Para compilar el programa sin instalarlo, se deben seguir los siguientes pasos. De esta manera se pueden correr los tests y las ejecuciones del programa utilizando valgrind.

Compilación

Para compilar, en una consola se debe clonar el resositorio utilizando

git clone --recurse-submodules git@github.com:Santoi/quantum-chess

y luego ejecutar la compilación usando el script de bash.

bash build.sh

Ejecución del servidor

Para ejecutar el server, se debe ejecutar la siguiente linea, donde port es el puerto en el que se abrirá el server y config_file el archivo de configuración del tablero, el cual debe estar ubicado en boards/ (solo el nombre del archivo, sin esta primera carpeta). Si no se explicita este último parámetro, se utilizara el archivo default.txt.

bash server.sh <port> [config_file]

Ejecución del cliente

Para ejecutar el cliente, se debe ejecutar la siguiente linea

bash client.sh

Ejecución de tests y valgrind

Para ejecutar los tests se debe correr la siguiente linea, para ello se debe tener instalado Valgrind.

bash valtest.sh

Para ejecutar el servidor o el cliente con Valgrind, se ejecuta de la misma manera detallada en la sección anterior pero con los scripts

    bash valserver.sh <port> [config_file]
    bash valclient.sh

Limpieza de build

Para limpiar la build, simplemente se debe borrar la carpeta build con

rm -r build

Uniendose a una partida

Una vez se ejecuta el programa, se encuentra la pantalla de inicio de sesión, allí se deberá ingresar la dirección IP del host y el puerto correspondientes al server.

Luego, se pasa a la selección de partida, donde se puede seleccionar entre unirse a una partida existente o crear una nueva. Con el boton 'Refresh' se puede obtener una actualización de las partidas. Los botones 'Previous' y 'Next' permiten ir hacia adelante en la lista de partidas o hacia atrás si hay más del máximo de partidas por pantalla.

Luego, se pasa a seleccionar el rol, se puede elegir entre blancas, negras y espectador. Indicandose que rol no esta disponible con una cruz roja sobre el botón.

Como jugar

Movimiento

Los movimientos que pueden realizar las piezas son iguales a los que se realizan en el ajedrez clásico (excepto por el peón pasado y la coronación). Al presionar clic izquierdo en una pieza se marcaran en azul todas las posiciones a los que se puede mover esa pieza.

Al dar un segundo clic en la posición deseada, si el movimiento es válido, la pieza se moverá al casillero indicado. Se indicará en el event log el movimiento realizado.

De no ser valido el movimiento, se indicará un error en la zona de log de errores.

Si una pieza se mueve a un casillero del color contrario, al igual que en el ajedrez clásico, la pieza será capturada.

Fin del juego

A diferencia del ajedrez clásico, en el ajedrez cuántico no existe el jaque ni el jaque mate. Ya que por la aleatoriedad de las piezas superpuestas, un jaque mate es practicamente imposible. Por lo tanto el juego terminará cuando el rey de un bando sea capturado.

Split

Las piezas pueden ser partidas y puestas en superposición, y pasará a ser una pieza cuántica. Una vez entrado en este modo, la pieza estará en dos o más lugares a la vez con cierta probabilidad. Esta probabilidad se divide por dos cada vez que se divide una pieza con un split.

Para realizar el split, se debe mantener presionada la tecla LEFT SHIFT y hacer clic izquierdo en una casilla. Se mostrarán en violeta las casillas a donde se puede hacer un split. Luego se debe clickear (ya no hace falta seguir apretando la tecla) y seleccionar el primer lugar al que se desea hacer el split, y luego al segundo.

Algunas consideraciones y limitaciones a la hora de hacer un split:

• No se puede hacer split a una casilla llena.
• No se puede hacer un split y comer a la vez.
• No se puede hacer un split y hacer una medición a la vez (ver Medición).
• No se puede hacer un split y entrelazar a la vez (ver Entrelazamiento)

Merge

Una pieza partida podrá ser reunida de nuevo mediante el movimiento merge. Una vez que se unan dos piezas, estas sumarán sus probabilidades resultando en una nueva pieza.

Para realizar el merge, se debe mantener presionada la tecla LEFT CTRL y hacer clic izquierdo en la pieza que se quiere mergear. Se mostrarán en marrón las casillas a donde se puede hacer un merge. Luego se debe clickear (ya no hace falta seguir apretando la tecla) y seleccionar la otra pieza con la que se quiere mergear. El color marrón cambiara a las casillas a las que ambas piezas pueden moverse. Un tercer clic en una casilla valida, efectuará el merge.

Algunas consideraciones y limitaciones a la hora de hacer un merge:

• El merge se puede realizar a la casilla de algunas de las piezas involucradas, siempre que el movimiento para la otra sea posible.
• No se puede hacer un merge y comer a la vez.
• No se puede hacer un merge y hacer una medición a la vez (ver Medición).
• No se puede hacer un merge y entrelazar a la vez (ver Entrelazamiento)
• Si existiese un entrelazamiento, y este se hubiera realizado luego de hacer el split que dividió a las piezas, este desaparecería (ver Entrelazamiento).

Medición

Cuando se intente mover una pieza a un casillero lleno, pueden ocurrir dos situaciones, que esté ocupado por una pieza propia o una pieza contraria.

Si ambas piezas son clásicas, se resuelve igual que en el ajedrez clásico, si son del mismo color, no se hace el movimiento, y si son de distinto color, se captura.

En cambio, si alguna de las dos piezas es cuántica, se produce una medición, es decir, se conocerá si la pieza estaba allí o no realmente. En el primer caso, las demas partes de esta pieza desaparecerán y la nueva pieza pasará a tener probabilidad 1. Si la pieza a la que se intenta mover es del mismo color (y efectivamente estaba allí), no se hará el movimiento, si en cambio era de distinto color, se comerá.

En el caso de que la pieza no esté realmente allí, esta desaparecerá, y se propagarán probabilidades por las demás partes de las piezas.

En el siguiente caso, la torre mide a la reina contraria, y como la reina estaba allí, fue capturada.

En el siguiente caso, el rey mide a la torre propia, y resulta que no estaba alli, por lo que se realiza el movimiento.

Si hubiera piezas entrelazadas, estas también son medidas si corresponden.

Entrelazamiento

Cuando se realiza un movimiento, podría ocurrir que en el camino de la pieza, se encuentre una pieza cuántica, de ocurrir esto, se partirá la pieza que se está moviendo y se producirá un entrelazamiento entre las piezas, con lo cual sus destinos quedan ligados.

A partir de aquí cuando, se mida una de las piezas entrelazadas, el destino de la otra también se definirá.

Algunas consideraciones y limitaciones a la hora de entrelazar:

• No se puede entrelazar con más de una pieza a la vez.
• No se puede entrelazar dos veces la misma pieza.
• No se puede hacer split, measure o merge a la vez que se entrelaza.

Visualización de piezas partidas y entrelazadas

Si se hace clic derecho en una pieza, se podra observar en verde cuales son las otras partes de la pieza, y en celeste con que piezas está entrelazada.

Enroque

El enroque permite mover en un mismo movimiento al rey y a una de las torres. Según que torre se utilize, se puede hacer:

• Enroque largo (en la imagen): se intercambian el rey y la torre de la izquierda, en este caso tienen que estar vacios los tres casilleros entre el rey y la torre. El rey queda en el casillero C1 (si se juega con blancas) y la torre en el casillero D1.
• Enroque corto: se intercambian el rey y la torre de la derecha, en este caso tienen que estar vacios los dos casilleros entre el rey y la torre. El rey queda en el casillero G1 (si se juega con blancas) y la torre en el casillero F1.

Para hacer un enroque simplemente se debe hacer clic en la posición que el rey ocupará, cuando esté disponible.

Consideraciones y limitaciones a la hora de enrocar:

• No se puede enrocar si alguno de los dos casilleros que deben ocupar la torre y el rey, están ocupados (no se puede medir).
• Al igual que en el ajedrez clásico, tanto torre como rey no deben haberse movido nunca (aunque hayan vuelto al lugar).
• A diferencia del ajedrez clásico, como no existe el jaque, el rey puede estar siendo atacado, y las casillas de paso y finales pueden estar bajo ataque tambien.

Además, se pueden hacer movimientos de tipo cuantico mientras se enroca.

• Podría ocurrir que en el enroque largo, al lado de la torre haya una pieza cuantica, con lo cual, como no es un casillero donde quedará una pieza del enroque, y la pieza podría estar allí o no, se enlazará la torre y el rey con esta pieza.

• Podría hacerse un split mientras se enroca, eligiendo en el split una posición correspondiente al enroque (o ambas). Al hacer esto, la torre (o las torres, si se hizo el split en ambos enroques) quedarán entrelazadas con el rey.

Logs y Chat

En la zona derecha de la pantalla, se pueden visualizar 4 secciones: el log de errores (1), el log de turnos (2), el log de movimientos (3) y el chat(4).

1. El log de errores se muestra en rojo, cuando un movimiento no se haya podido completar por algún error del usuario (tal como un movimiento inválido, no es su turno, etcetera).
2. El log de turnos se muestra en verde, e indica quien debe jugar.
3. El log de movimientos detalla en vivo cuales fueron los últimos movimientos realizados en la partida y sus consecuencias.
4. El chat permite conversar con los otros jugadores y observadores. Para utilizarlo se deberá hacer la entrada de texto que indica 'CHAT HERE', allí se podrá tipear. Los mensajes son enviados utilizando ENTER o automáticamente al llegar al final de la linea. Para voler al juego, solo se debe presionar sobre el tablero (este primer toque no activará ninguna casilla).

Flip de tablero

El tablero se puede dar vuelta, cambiando entre vista desde el lado de las blancas y de las negras utilizando la tecla F.

Ayuda

Se puede abrir la ayuda del huego utilizando la tecla H.

Rendición

Se puede rendirse de la partida apretando la tecla S.

Activación de musica y sonidos

La música puede ser activada y desactivada utilizando la tecla M. Los efectos de sonidos pueden ser desactivados utilizando la tecla N.

Cancelando movimientos

Todos los movimientos pueden ser cancelados con la tecla ESC

Archivo de configuración del juego

El juego permite configurar parámetros a traves del archivo de configuración ubicado en /usr/local/share/quantum_chess/config_files/config.txt donde se puede modificar resolución y frame rate.

Archivo de configuración del tablero

El archivo de configuracion permite cargar tableros pre-definidos. Esto es para el server, por lo que un server inicializado con un archivo, lo usará para todas sus partidas.

Los archivos de configuración deben ser guardados en texto plano en la carpeta /usr/local/share/quantum_chess/boards.

Cada pieza debe ser colocada en una línea distinta, teniendo la siguiente forma:

<CHESSMAN><POS_X><POS_Y><COLOR>

donde:

• CHESSMAN es un caracter que representa a la pieza que se coloca (este caracter es la inicial del nombre de la pieza en inglés, excepto para el caballo que es representado por H).
• POS_X es la posición en x, caracter de A a H.
• POS_Y es la posicion en y, número de 1 a 8.
• COLOR es un caracter que representa el color de la pieza, W para blancas y B para negras.

Las lineas en blanco son ignoradas y se pueden insertar comentarios utilizando # como primer caracter de la linea. Todos los caracteres deben ser ingresados en mayúsculas.

Por ejemplo, si se carga un archivo como se muestra a continuación, se obtiene el siguiente tablero.

# White chessmen
TA1W
KE1W
PA2W
PG5W

# Black chessmen
KE7B
QC3B
BF1B

Ascii Chess

El Ascii Chess se realizó como herramienta de debugging durante la etapa inicial del desarrollo. Puede ser jugado, aunque solo contiene movimientos clásicos.

Para jugarlo se debe compilar el programa (no instalarlo), y ejecutar

bash ascii.sh

Para jugar simplemente se debe ingresar el comando

M initial_x initial_y final_x final_y

donde las coordenadas en x van de A a H y en y de 0 a 7.

Se puede salir presionando la tecla q.