Daily Chess Reviews.
-
Clone the project
git clone https://github.com/joeyagreco/daily-chess.git
-
Ensure your environment variables are correctly set
-
Install dependencies
make deps
-
Run the script
make up
- Ensure your environment variables are correctly set
- Build Docker
make build-docker
- Run Docker
make docker
These can be set in an .env file in the root of the project or any other way you prefer to set environment variables
| Variable Name | Required | Type | Description |
|---|---|---|---|
| LICHESS_USERNAME | Yes | string | The username associated with your Lichess account |
| NUM_GAMES | Yes | integer | Your last n games to be included in the analysis |
| PERF_TYPE | Yes | PerfType | The type of games to include. OPTIONS |
| RUN_AT_TIME | Yes | str | The hour and minute to run this at daily. Uses military time (HH:MM) |
| DISCORD_WEBHOOK_URL | Yes | str | The URL of the Discord webhook to call. GUIDE |
| DISCORD_DAILY_OPENINGS_TO_SEND | Yes | integer | The number of openings to send each day (e.g. 3 would mean 3 openings are sent each day in the analysis) |
| EVALUATION_DEPTH | Yes | integer | The depth the chess engine should go to when evaluating a game |
| MAX_LOSSES_TO_EVALUATE | Yes | integer | The maximum number of losses to evaluate |
| STOP_AFTER_EVAL_CHANGE_OF | Yes | integer | Stop evaluating when a move is found with an evaluation change of this much. Should be negative. |
| TEST | No | boolean | Whether to run this in test mode or not. |
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.