1
0
mirror of https://github.com/maaslalani/gambit.git synced 2024-11-30 08:46:39 +02:00
gambit/README.md

33 lines
1010 B
Markdown
Raw Normal View History

2021-11-27 03:52:32 +02:00
# Gambit
Chess board in your terminal.
2021-12-02 03:34:51 +02:00
<br/>
<p align="center">
<img width="90%" src="./chess.gif?raw=true" alt="Terminal chess" />
</p>
<br/>
2021-11-27 03:52:32 +02:00
2021-12-02 04:19:27 +02:00
### Warning
`gambit` does not have many features at the moment.
I plan on adding a chess engine, mouse support, timers, networked play, game replays, etc...
2021-11-27 03:52:32 +02:00
### Move
2021-12-02 04:19:27 +02:00
Suppose you want to open as white with Pawn `E4`.
2021-11-27 03:52:32 +02:00
You will first select the square with the piece you want to move by typing `E2`,
then type the square of the desired end position `E4`.
Just like a real chess board, `gambit` currently supports illegal moves.
_This will likely change in the future_.
### Players
`gambit` supports local and networked play. You can play a local game by
running `gambit` and moving the pieces. You can flip the board by pressing
2021-11-27 08:20:17 +02:00
<kbd>ctrl+f</kbd> to allow the second player to go.
2021-11-27 03:52:32 +02:00
2021-11-27 08:20:17 +02:00
For networked play (not available yet), both players can run `gambit unique-room-id`, this will connect
2021-11-27 03:52:32 +02:00
both players to a shared room in which both can take turns making moves.