diff options
| author | Elizabeth Hunt <elizabeth.hunt@simponic.xyz> | 2023-05-29 14:48:50 -0700 |
|---|---|---|
| committer | Elizabeth Hunt <elizabeth.hunt@simponic.xyz> | 2023-11-21 17:57:10 -0700 |
| commit | f0ca174ada81a0ec4b1bbff9b70fcc680e4ca0ad (patch) | |
| tree | 309e713bcb63918a4015c623fd778514c977e8ae /README.md | |
| download | chessh_bot-main.tar.gz chessh_bot-main.zip | |
squash everything since there was profanity in the commit log and maybe people won't like thatHEADmain
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..e190b31 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# example chessh bot + +this is a simple CheSSH bot written in TypeScript using js-chess-engine. it's not very good. + +the bot "entrypoint" is at `/src/api/index.ts`. + +## environment +``` +BOT_TOKEN: the token generated by CheSSH for which the bot will be deployed +CHESSH_MOVE_PATH: the path to POST an attempted move in the form "<from square><to square>" according to the CheSSH contract to the game with id :gameId. +``` |