Lichs (Lichess in the Terminal)

Info and requirements

Uses Lichess, which means that you need to have a Lichess account
Only Classical and Rapid games because the Lichess API doesn't allow anything else (quite frankly, Blitz and Bullet like games wouldn't be a lot of fun since you would have to input the coordinates really fast)
This program uses UCI-format for inputing moves, see the important section

Lichs uses the Lichess API (more exactly berserk) to make it possible for you to play against other real players directly in the terminal on Lichess servers. This project is still in its early stages; there's no chat support, pretty bad graphics, no ranked games and probably some bugs.

Installation

This package is available on PyPi, therefore just run:

$ pip install lichs

and the program will be installed. The next step is to generate a personal API-key.

How to generate a personal API token

Click here and log in with your Lichess account if needed
Name the token anything (e.g. MyToken)
Scroll down and enable the button Play games with the board API
Click the button Submit in the lower right corner
Copy the token shown in the brown box
Jump into your terminal and write lichs <api_token> (put your API token instead of <api_token>) and run the command. To get this clear, an example would have been lichs lzRceo5XOUND74Lm. You should then see a message to confirm that the API token has been saved.

Usage

You start playing by typing the command lichs into your terminal:

$ lichs

That will take you to the intro screen:

Welcome to Lichess!

What kind of chess do you want to play?
1. Rapid (10+0)
2. Classical (30+0)

Enter 1 or 2:

That should be pretty self-explanatory, you basically choose between Rapid and Classical (the Lichess API doens't support anything else) by entering either 1 or 2. The timing of the games is also listed there; Rapid is 10min and Classical 30min (without extra-time, I might add support for extra-time later)

When you have input either 1 or 2, the program will start to search after an opponent. It shouldn't take long and the game should start pretty quickly.

Searching after opponent...
An opponent was found!

Then the program will let you know whether you're the color white or black. After that you will start playing; the program will output the board after every move and ask for your move when it's your turn.

r n b q k b n r
p p p p p p p p
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . P . . .
P P P P . P P P
R N B Q K B N R

Above is an example of the board displayed. Note: at the moment the board is always displayed from the white's side, because I don't know how to fix this.

Important

When the program asks for your move, you need to input the move in UCI-format. In UCI-format you specify from where to where the move will take place. You don't need to specify what type of piece your moving, the program will know what piece is in the given position.

An example of UCI-format would be e2e4. That would move the piece on e2 to e4 (as a start-move it's the pawn). Just to get this clear; Nf3 wouldn't work.

The program will inform you if you can't make the move you have input.

How to contribute?

See the CONTRIBUTING.md file.