Skip to content

Latest commit

 

History

History
49 lines (38 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

49 lines (38 loc) · 2.31 KB

How to add Chesslise to your discord server

  • Head over to App Directory
  • Click on "Add to Server"
  • If you are not logged in to discord you might have to log in
  • You would have to get a server selection list that you own, pick the server you want to install Lise in
  • View Lise's permission and click "Authorize"
  • To check if Lise has joined, go to the server where you installed Lise and run /help or /play and see if the LISEBOT selection menu opens up
  • You're done! Please read the command information below you can also run /help to view it in discord.

How to set up lise locally?

  • To set up lise you need to have Java 21, IntelliJ, and Maven
  • git clone the project
  • use any IDE (IntelliJ recommended)
  • configure ENV_BETA to either true or false to use the current working env, ideally for development use DISCORD_BETA_TOKEN
  • configure DISCORD_{ENV}_TOKEN for your own bots' discord token in .env
  • configure LICHESS_TOKEN if you also want to run lise on lichess
  • you are ready to run the bot with mvn clean
  • finally, compile the code mvn compile
  • Please note you need to follow the same steps as adding Chesslise for your own local bot
  • build the project mvn package
  • run the application java -jar /target/Chesslise-15.0-SNAPSHOT-jar-with-dependencies.jar

API

  1. lichess API
  2. Chess.com API
  3. JDA 5 discord API
  4. StockFish API
  5. Chessdb cn

Libraries

  1. lichess Java Client
  2. Tors42 JBang-chariot Java Client Examples
  3. Chess.com Java Wrapper
  4. Java Chess Lib

Engines

Image Generation

Chesslise High-level Design

Lisev10B drawio