niallb98/chessdb

A text-based multiplayer chess game written in Kx System's (https://kx.com/) programming language Q

ChessDB

A text-based multiplayer chess game written in Kx System's (https://kx.com/) programming language Q

---

Requirements

• bash (Tested with Git Bash for Windows' MinTTY terminal)
• q/kdb+ (Tested in version 4.0)

Note: Some terminals may be too slow at refreshing their visuals to show the game at 60 FPS properly, it is recommended to run through a faster terminal than the default, like running through a MinTTY terminal

How to Start a Game

First you will need a server to join; to start a server run start_server.sh, which can optionally be passed a port number as an argument for which it will host the server on, otherwise the server's port will default to the DEFAULT_PORT variable's value defined in config.env and the public and local IP address of the server will be logged upon it starting up

Clicking run.sh will start a client process for playing the game, to join a server you:

1. Select PLAY on the main menu
2. Enter and confirm a name you wish to call yourself in-game
3. Enter the IP and port of the server (Use local IP if on same network as the server and public otherwise) and select Join
4. Wait for another player to join the same server to start the game

Note:

To play a game hosted on another network port forwarding may be necessary on the host network (Search "How to port forward" for more information)

Tips

• If run.sh and start_server.sh cannot start Q you may need to edit the Q_CMD override variable in config.env to a command that works on your machine
• To reset the server you can execute reset[] in its console
• When typing in the server IP address you can enter localhost or .z.a to easily set the IP to your local address
• You can move the game cursor out of bounds to wrap it around to the other side of the board

Extras

Screenshot of Gameplay:

chessdb's Issues

Player who has ended their turn still has cursor shown

Show pieces captured

Add pawn promotion

Add single player

Add decorations to menus

Add option to call a stalemate if half-turn timer is greater than or equal to 50

Must be done after or along with #5

Show game version on game menu

Active player cannot tell server they are leaving the game

Tidy commonly used functions

Add notifying when a game has been won/lost/drawn

Allow players to choose whether they want a rematch or not

Convert variables to camelCase format for readablity

Remove batch file support

Add regular garbage collection

Add message telling player their turn has started

Second player's cursor doesn't show until moved first time

Add README.md

Game freezes sometimes (When using Q in command prompt)

(When using Q in Windows CMD)

Add automatic stalemate if there is insufficient material left on the board

Player names don't allow spaces

Add a special message if player becomes checked

Improve cls function

It is possible to clear the screen (When the "clear" bash command is available) with:

-1"\033[3;J\033[H\033[2J";

Fix castling

Inactive player immediately loses connection when starting the game

King piece not able to move where it should

Split functionality used only by multiplayer into seperate folders/files

Add repetition rule

See https://en.wikipedia.org/wiki/Threefold_repetition for more details

Add more detail for message for when a piece is captured

Ie. say what piece was captured

Fix castling being possible when no rooks are on side

Can recreate with this board:

START_BOARD:"4k3/R6R/8/8/8/8/8/R2QK3 w KQkq - 0 1";

Add special message for castling

Add functionality to restart/end game session after players are asked for rematch

Add message for when a piece is moved (and nothing else happens) instead of the "It is your turn" message

Add chess AI

Should expose a function which takes the current board state as an argument and returns a move to take

Write non bash file version of verify_ip.sh

Show last move taken

Add CONFIG.env file to customise Q_CMD and RLWRAP_CMD used in run.sh