1
0
mirror of https://github.com/maaslalani/gambit.git synced 2025-02-19 19:00:09 +02:00
gambit/README.md

51 lines
1011 B
Markdown
Raw Normal View History

2022-02-08 17:49:36 -05:00
<img src="./assets/gambit.png?raw=true" alt="Gambit: Play chess in your terminal" />
2021-11-26 20:52:32 -05:00
# Gambit
Chess board in your terminal.
2022-02-05 12:27:39 -05:00
### Installation
```sh
go install github.com/maaslalani/gambit@latest
```
or run from source
```sh
git clone github.com/maaslalani/gambit
go run ./...
```
2022-02-05 10:04:53 -05:00
### Play
2021-11-26 20:52:32 -05:00
2022-02-05 10:04:53 -05:00
You can play a game by running:
```
gambit
```
You can press <kbd>ctrl+f</kbd> to flip the board to give a better perspective
for the second player.
2022-02-08 17:49:36 -05:00
<br/>
<p align="center">
<img width="90%" src="./assets/chess.gif?raw=true" alt="Terminal chess" />
</p>
### Move
There are two ways to move in `gambit`:
* Type out the square the piece you want to move is on, then type out the square to which you want to move the piece.
* With the mouse, click on the target piece and target square.
2022-02-05 10:04:53 -05:00
### Future
In the future, `gambit` will support:
* networked play, where two players can run
`gabmit unique-room-id` and play together through peer-to-peer communication.
* Single player games, by adding a chess engine