diff --git a/README.md b/README.md index 0e5ac72..f253e4b 100644 --- a/README.md +++ b/README.md @@ -29,36 +29,93 @@ ## 🌀 About -[![Readme Card](https://github-readme-stats.vercel.app/api/pin/?username=brblacky&repo=WaveMusic&theme=tokyonight)](https://github.com/brblacky/lavamusic) -## 🎵 Support Source -- [x] Youtube -- [x] SoundCloud -- [x] Spotify -- [x] Bandcamp -- [x] Vimeo -- [x] Https (Radio) -## 🌟 Feature -- [x] Setup System -- [X] Auto reconnect -- [x] Music System -- [x] Playlists System -- [x] Custom Prefix -- [x] Custom Volume(Per Server) -- [x] Slash commands -- [x] Custom Filters -- [x] Easy to use -## 🖼️ Screenshots -
-

- - - -

+[![Readme Card](https://github-readme-stats.vercel.app/api/pin/?username=brblacky&repo=WaveMusic&theme=tokyonight)](https://github.com/brblacky/WaveMusic) + +## 🔥 Unique Features + +- Developed Discord.js v14 +- Advanced Music System +- Customizable Prefix +- Powerful Search Engine +- 12 + Music Filters +- Hybrid Command Handling (Slash and Normal Commands) +- Highly Configurable +- User-friendly and Easy to Use +- 24/7 Music Playback +- Playlist commands +- Setup music channel + +## 🎶 Support Sources + +🔍 **Default Sources**: + +- ![YouTube](https://img.shields.io/badge/YouTube-FF0000?style=plastic&logo=youtube&logoColor=white) +- ![SoundCloud](https://img.shields.io/badge/SoundCloud-FF3300?style=plastic&logo=soundcloud&logoColor=white) +- ![Twitch](https://img.shields.io/badge/Twitch-9146FF?style=plastic&logo=twitch&logoColor=white) +- ![Bandcamp](https://img.shields.io/badge/Bandcamp-629AA9?style=plastic&logo=bandcamp&logoColor=white) +- ![Vimeo](https://img.shields.io/badge/Vimeo-1AB7EA?style=plastic&logo=vimeo&logoColor=white) +- ![http](https://img.shields.io/badge/http-FFA500?style=plastic&logo=http&logoColor=white) + +🔌 **Plugin Sources**: `(Require: LavaLink v3.6.x)` + +**Note: You need to install the plugins to use these sources** + +- ![Spotify](https://img.shields.io/badge/Spotify-1ED760?style=plastic&logo=spotify&logoColor=white) ([Required Plugin][LavaSry]) +- ![Deezer](https://img.shields.io/badge/Deezer-FF0000?style=plastic&logo=deezer&logoColor=white) ([Required Plugin][LavaSry]) +- ![Apple Music](https://img.shields.io/badge/Apple%20Music-000000?style=plastic&logo=apple-music&logoColor=white) ([Required Plugin][LavaSry]) +- ![Yandex Music](https://img.shields.io/badge/Yandex%20Music-FF0066?style=plastic&logo=yandex-music&logoColor=white) ([Required Plugin][LavaSry]) +- ![Mixcloud](https://img.shields.io/badge/Mixcloud-51C4D3?style=plastic&logo=mixcloud&logoColor=white) ([Required Plugin][skybot-lavalink-plugin]) +- ![Ocremix](https://img.shields.io/badge/Ocremix-FF6600?style=plastic&logo=ocremix&logoColor=white) ([Required Plugin][skybot-lavalink-plugin]) +- ![Clyp](https://img.shields.io/badge/Clyp-6BB5A6?style=plastic&logo=clyp&logoColor=white) ([Required Plugin][skybot-lavalink-plugin]) +- ![Reddit](https://img.shields.io/badge/Reddit-FF4500?style=plastic&logo=reddit&logoColor=white) ([Required Plugin][skybot-lavalink-plugin]) +- ![Getyarn](https://img.shields.io/badge/Getyarn-FF9000?style=plastic&logo=getyarn&logoColor=white) ([Required Plugin][skybot-lavalink-plugin]) +- ![TikTok](https://img.shields.io/badge/TikTok-FF2D55?style=plastic&logo=tiktok&logoColor=white) ([Required Plugin][skybot-lavalink-plugin]) +- ![Soundgasm](https://img.shields.io/badge/Soundgasm-F1672F?style=plastic&logo=soundgasm&logoColor=white) ([Required Plugin][skybot-lavalink-plugin]) +- ![Text To Speech](https://img.shields.io/badge/Text%20To%20Speech-3080ff?style=plastic&logo=google-translate&logoColor=white) ([Required Plugin][skybot-lavalink-plugin]) + +[LavaSry]: https://github.com/TopiSenpai/LavaSrc +[skybot-lavalink-plugin]: https://github.com/DuncteBot/skybot-lavalink-plugin + +### **Need Help with plugins?** Join our [Discord Server](https://discord.gg/ns8CTk9J3e) and ask in the `#support` channel + +## 📚 Commands + +
Click to View Commands + +| Name | Description | Options | +| ------------ | ------------------------------------- | ------------------------------------------- | +| `prefix` | Shows the bot's prefix | | +| `help` | Shows the help menu | `command`: The command you want to get info | +| | | on | +| `info` | Shows information about the bot | | +| `invite` | Sends the bot's invite link | | +| `ping` | Shows the bot's ping | | +| `clearqueue` | Clears the queue | | +| `join` | Joins the voice channel | | +| `leave` | Leaves the voice channel | | +| `nowplaying` | Shows the currently playing song | | +| `play` | Plays a song from YouTube or Spotify | `song`: The song you want to play | +| `pause` | Pauses the current song | | +| `queue` | Shows the current queue | | +| `remove` | Removes a song from the queue | `song`: The song number | +| `resume` | Resumes the current song | | +| `seek` | Seeks to a certain time in the song | | +| `shuffle` | Shuffles the queue | | +| `skip` | Skips the current song | | +| `skipto` | Skips to a specific song in the queue | | +| `stop` | Stops the music and clears the queue | | +| `volume` | Sets the volume of the player | `number`: The volume you want to set | + +
+ +## 🔧 Requirements + +Before starting with the installation, you need to have the following: + +- ![Node.js](https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white) [v18.17.1 or higher](https://nodejs.org/en/download/) +- ![MongoDB](https://img.shields.io/badge/MongoDB-4EA94B?style=for-the-badge&logo=mongodb&logoColor=white) [v4.4.0 or higher](https://www.mongodb.com/try/download/community) +- ![Lavalink](https://img.shields.io/badge/Lavalink-7289DA?style=for-the-badge&logo=discord&logoColor=white) [v3.7.8 or higher](https://github.com/freyacodes/Lavalink) -## 🎛️ Requirement -- [x] Node js v 16+ -- [x] Java v 13 (for lavalink server) -- [x] yarn `npm i -g yarn ` ## ⚙️ Installation Fill all requirement in `src/config.js` or `.env` **(rename `.env.example` to `.env`)**