Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #26

Closed
wants to merge 1 commit into from
Closed

Update README.md #26

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 14 additions & 55 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,81 +9,46 @@
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/)

# 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)


# Contribution details

To set up Lise you need the following

- Java 18
- Maven
- Chess.com app useragent details see more in Controller/CCProfile.java
- Discord Dev app
- Discord Dev Account
- Discord Dev app token (Note: select only Send Embeds, Send Msg, Embed links, Use Slash command permissions)
- JDA 18 knowledge, as Controller/CommandHandler.java is mostly JDA
- You don't need chess knowledge to contribute
- if your stuck join the discord server.

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


# Lise Chess Engine

LISEBOT supports built in Chess AI that uses complex move search algorithms for users to play, more details
about the AI can be found [here](https://github.com/jalpp/LiseChessEngine)
- [Lichess Gifs](https://github.com/lichess-org/lila-gif)

# LISEBOT Highlevel Design
![image](https://www.linkpicture.com/q/Untitled-Diagram.drawio.png)
![image](https://www.linkpicture.com/q/autodraw-2022-09-24.png)


# Lichess Commands:
| Commands | Description |
| ----------- | ----------- |
| /help | to see command information for the LISEBOT |
| /profile | to see lichess profiles for given username |
| /streamers | Watch current live streamers |
| /dailypuzzle | see the daily Lichess puzzle and try to solve it! |
| /play | created opnended challenge for users to play with, given variant and rated/casual <variant = blitz, rapid, etc> |
| /arena <Lichess arena URL> | see the standings and tournament information for given tournament link|


# LISE Chess AI Commands
| Commands | Description |
| ----------- | ----------- |
| /move | make a chess move to play LISE AI |
| /resetboard | reset the chess game with LISE AI |

| Commands | Description |
|----------------------------| ----------- |
| /help | to see command information for the LISEBOT |
| /profile | to see lichess profiles for given username |
| /streamers | Watch current live streamers |
| /dailypuzzle | see the daily Lichess Chesscom.puzzle and try to solve it! |
| /play | created opnended challenge for users to play with, given variant and rated/casual <variant = blitz, rapid, etc> |
| /arena <Lichess arena URL> | see the standings and tournament information for given tournament link|
| /analyze [fen] | analyze chess position |


# Chess.com Commands
| Commands | Description |
| Commands | Description |
| ----------- | ----------- |
| /puzzle | Do random Chess.com puzzles |
| /profilecc | view Chess.com user profile |
| /dailypuzzlecc | do Chess.com daily puzzle |


## Create Lichess Games


![image](https://www.linkpicture.com/q/Screen-Shot-2022-09-24-at-5.16.24-PM.png)

## Lise Authors
LiseBot is open source bot that is mantained by its contributers, Lise is not affiliated with Lichess.org or
Chess.com, Lisebot acts an thrid party software that allows chess lovers to use respective chess websites
features in Discord. Lise does not depend on these chess sites, as Lise has its own features like Lise AI, and other
features. Lisebot nor the authors support these sites ideas/features and is not responsible for their features, Lisebot
can only gurentee its own Discord logic side of things to be maintained. Lisebot should not be confused as Lichess.org/Chess.com Discord bot/affiliated software.

## Terms of Service
User agrees that they will have to use latest updated versions of LISEBOT, User also agrees that some commands may be deleted if developer does not want to maintain those commands in future. User is fully responsible for their discord server and LISEBOT does not have any access to the server information/ management. User also agrees to privacy policy which states that LISEBOT does not and will not store any private information
Expand All @@ -94,9 +59,3 @@ LISEBOT Does not and will not store any private user information, all bot comman
# Bot Testing Link
[Invite me](https://discord.com/oauth2/authorize?client_id=930544707300393021&permissions=8&scope=bot%20applications.commands)

## Contribute

LISEBOT is open to contributors for bug fixes, enhancements, some features are "good first issues" to get started

## Dev Community
Join [LISEBOT community Discord](https://discord.gg/596rYGBDXz) to contribute and test LISEBOT!