diff --git a/README.md b/README.md index c115ae6..c003fa1 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,32 @@ -asa bot +# Asa Bot -![alt text](https://i.imgur.com/ofQIlrt.png) \ No newline at end of file +AsaBot is a easy to host Discord bot that can be used to play music in a voice channel and do other fun things. It was created using JDA (Java Discord API) and LavaPlayer. + +![alt text](https://i.imgur.com/ofQIlrt.png) +## Features +- Easy to host and use +- Play music from a number of sources (YouTube, SoundCloud, Bandcamp, Vimeo, Twitch streams, local files, HTTP URLs, etc.) +- Variety of music controls (play, pause, stop, skip, seek, volume, queue, remove, shuffle, loop, etc.) +- Playlists support +- Anime image commands powered by [ImageBoard (Booru) API](https://github.com/Kodehawa/imageboard-api) +- Oricon chart commands +- And more! + +## Installation and set-up + +1. Install [JDK 17](https://www.oracle.com/java/technologies/java-se-glance.html) or higher +2. Download the latest release from the [releases page](https://github.com/rainman226/asa-bot/releases) +3. Extract the zip file into a folder +4. Get a Discord bot token from the [Discord Developer Portal](https://discord.com/developers/applications) +5. Open a terminal and run the following command: +```bash +java -jar asa-bot.jar "YOUR_DISCORD_BOT_TOKEN" +``` +## To-do +- [ ] Add more commands (recommendations are welcome!) +- [ ] Add Spotify support +- [ ] Add more error handling +- [ ] Combine the Oricon chart commands into one command +- [ ] Add more configuration options + +For any questions, suggestions, or issues, feel free to open an issue or contact me on Discord (rainman226). \ No newline at end of file