Skip to content

Commit

Permalink
clean up readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jalpp authored Apr 22, 2024
1 parent 9de2165 commit 95a4039
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 4 deletions.
27 changes: 27 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,30 @@
- 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-13.5-SNAPSHOT-jar-with-dependencies.jar ```


# API

1. [Lichess API](https://lichess.org/api)
2. [Chess.com API](https://github.com/sornerol/chess-com-pubapi-java-wrapper)
3. [JDA 5 Discord API](https://github.com/DV8FromTheWorld/JDA)
4. [StockFish API](https://stockfish.online/)
5. [Fide API](https://github.com/lenguyenthanh/fide?tab=readme-ov-file)

# Libraries

1. [Lichess Java Client](https://github.com/tors42/chariot)
2. [Tors42 JBang-chariot Java Client Examples](https://github.com/tors42/jbang-chariot)
3. [Chess.com Java Wrapper](https://github.com/sornerol/chess-com-pubapi-java-wrapper)
4. [Java Chess Lib](https://github.com/bhlangonijr/chesslib)

# Engines

- [Lise Chess Engine](https://github.com/jalpp/LiseChessEngine)
- [Stockfish](https://stockfishchess.org/)

# Image Generation
- [Lichess Gifs](https://github.com/lichess-org/lila-gif)

# Chesslise High-level Design
![Lisev10B drawio](https://github.com/jalpp/LichessSearchEngineBot/assets/92553013/ab1aa349-135b-4f57-a592-bba4e6faf733)
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
![](https://img.shields.io/badge/Status-Online-brightgreen)
![](https://img.shields.io/badge/Discord%20API-JDA-purple)
![](https://img.shields.io/badge/Available%20On-Discord%20App%20Directory%20-blue)
![GitHub License](https://img.shields.io/github/license/jalpp/Chesslise)


Chesslise is open source Chess based Discord application, which allows users to play, learn, and watch chess on their Discord server

Expand Down Expand Up @@ -30,8 +32,6 @@ Chesslise is open source Chess based Discord application, which allows users to
# Image Generation
- [Lichess Gifs](https://github.com/lichess-org/lila-gif)

# Chesslise High-level Design
![Lisev10B drawio](https://github.com/jalpp/LichessSearchEngineBot/assets/92553013/ab1aa349-135b-4f57-a592-bba4e6faf733)

# Popular Commands
| Commands | Description |
Expand All @@ -40,8 +40,6 @@ Chesslise is open source Chess based Discord application, which allows users to
| /analyze | analyze positions |
| /play | create live chess games in Discord |



## App Directory
[View More](https://discord.com/application-directory/930544707300393021)

Expand Down
File renamed without changes.
File renamed without changes.

0 comments on commit 95a4039

Please sign in to comment.