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

35 lines
950 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
2021-12-22 21:32:11 +02:00
`gambit` does not have a large number of features at the
moment. I plan on adding a chess engine, mouse support,
timers, networked play, game replays, etc...
2021-12-02 04:19:27 +02:00
2021-11-27 03:52:32 +02:00
### Move
2021-12-22 21:32:11 +02:00
You may use the mouse to move your pieces. You may also
type out the square the piece you want to move is on
followed by the square to which you want to move the piece.
2021-11-27 03:52:32 +02:00
2021-12-22 21:32:11 +02:00
Like a real chess board, `gambit` supports illegal moves.
2021-11-27 03:52:32 +02:00
### Players
2021-12-22 21:32:11 +02:00
`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 <kbd>ctrl+f</kbd> to allow
the second player to go.
2021-11-27 03:52:32 +02:00
2021-12-22 21:32:11 +02:00
For networked play (not available yet), both players can
run `gambit unique-room-id`, this will connect both players
to a shared room in which both can take turns making moves.