Skip to content

Commit

Permalink
Merge pull request #67 from LucasB25/patch-1
Browse files Browse the repository at this point in the history 
Update README.md
  • Loading branch information
@appujet
appujet authored Apr 3, 2024
2 parents 1ccebbe + cc9dc15 commit 44c6f08
Showing 1 changed file with 56 additions and 78 deletions.
134 changes: 56 additions & 78 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
<center><img src="https://capsule-render.vercel.app/api?type=waving&color=gradient&height=200&section=header&text=WaveMusic&fontSize=80&fontAlignY=35&animation=twinkling&fontColor=gradient" /></center>

[![Version][version-shield]](version-url)
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
<center><img src="https://capsule-render.vercel.app/api?type=waving&color=gradient&height=200&section=header&text=WaveMusic&fontSize=80&fontAlignY=35&animation=twinkling&fontColor=gradient" /></center>

<!-- PROJECT LOGO -->
<br />
<p align="center">
<a href="https://github.com/brblacky/WaveMusic">
<img src="https://media.discordapp.net/attachments/963097935820750878/963098304483328030/20220411_160253.png" alt="moebot" width="200" height="200">
<img src="https://cdn.discordapp.com/avatars/977742811132743762/a_b38640208ccf2e95cdca9c00fe213d45.gif?size=512" alt="moebot" width="200" height="200">
</a>

<h3 align="center">WaveMusic</h3>
Expand All @@ -20,17 +20,11 @@
WaveMusic is a powerful music Bot
<br />
<br />
<a href="https://github.com/brblacky/WaveMusic/issues">Report Bug</a>
·
<a href="https://github.com/brblacky/WaveMusic/issues">Request Feature</a>
<a href="https://github.com/brblacky/WaveMusic/issues">Report Bug & Request Feature</a>
</p>
</p>
<!-- ABOUT THE PROJECT -->

## 🌀 About

[![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
Expand All @@ -49,64 +43,36 @@

🔍 **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)
- ![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 v4.0.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
- ![Spotify](https://img.shields.io/badge/Spotify-1ED760?style=plastic&logo=spotify&logoColor=white) ([Required Plugin][LavaSrc])
- ![Deezer](https://img.shields.io/badge/Deezer-FF0000?style=plastic&logo=deezer&logoColor=white) ([Required Plugin][LavaSrc])
- ![Apple Music](https://img.shields.io/badge/Apple%20Music-000000?style=plastic&logo=apple-music&logoColor=white) ([Required Plugin][LavaSrc])
- ![Yandex Music](https://img.shields.io/badge/Yandex%20Music-FF0066?style=plastic&logo=yandex-music&logoColor=white) ([Required Plugin][LavaSrc])
- ![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])

[LavaSrc]: 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

<details><summary>Click to View Commands</summary>

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

</details>
### To set up a Lavalink server on Windows, Linux, or Replit, [Click Here.](https://github.com/LucasB25/lavalink-server)

### **Need Help with plugins?** Join our [Discord Server](https://discord.gg/YsJCtDuTXp) and ask for help in the `#support` channel.

## 🔧 Requirements

Expand Down Expand Up @@ -143,28 +109,27 @@ Create a `.env` file in the root directory of your project with the following va
```bash
TOKEN="." # Your bot token
PREFIX= "!" # Your prefix
OWNER_IDS= "" # Your id
CLIENT_ID= "960072976412340254" # Your bot client id
OWNER_IDS=["959276033683628122","859640640640640640"] # Your discord id, you can add multiple ids
GUILD_ID= "859640640640640640" # Your server Id if you want to use the for single server
PRODUCTION="true" # true for production
SEARCH_ENGINE= "ytsearch" # ytsearch, scsearch or ytmsearch
MAX_PLAYLIST_SIZE= "100" # Max playlist size
MAX_QUEUE_SIZE= "100" # Max queue size
BOT_STATUS= "online" # Your bot status
BOT_ACTIVITY= "Wavemusic" # Your bot activity
LAVALINK_URL="localhost:2333" # Your lavalink url
BOT_ACTIVITY= "Lavamusic" # Your bot activity
LAVALINK_URL="lavalink:2333" # Your lavalink url
LAVALINK_AUTH="youshallnotpass" # Your lavalink password
LAVALINK_NAME="Blacky" # Your lavalink name
LAVALINK_SECURE= "true" # true for secure lavalink
LAVALINK_SECURE= "false" # true for secure lavalink
KEEP_ALIVE= "false" # true for keep alive in https://replit.com
LOG_CHANNEL_ID=""
BOT_ACTIVITY_TYPE=0 # Activity type is a number from 0 to 5 see more here https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-types
KEEP_ALIVE= "false" # true for keep alive for replit

```

5. Run the bot:

```bash
npm run start or npm start
npm start
```

## 📝 Configuration
Expand All @@ -191,23 +156,36 @@ npm run start or npm start
WaveMusic is a discord music bot base in [Shoukaku](<https://github.com/Deivu/Shoukaku>)
If you liked this repository, feel free to leave a star ⭐ to help promote !

## 💌 Support Server
## 📜 Contributing

[![DiscordBanner](https://invidget.switchblade.xyz/ns8CTk9J3e)](https://discord.gg/ns8CTk9J3e)
[Support Server](https://discord.gg/ns8CTk9J3e) - WaveMusic's Support Server Invite
Thank you for your interest in contributing to Lavamusic! Here are some guidelines to follow when contributing:

# Donate
1. Fork the repository and create a new branch for your feature or bug fix.
2. Write clean and concise code that follows the established coding style.
3. Create detailed and thorough documentation for any new features or changes.
4. Write and run tests for your code.
5. Submit a pull request with your changes.

By Donating, You Will Help Me To Maintain This Project
Your contribution will be reviewed by the project maintainers, and any necessary feedback or changes will be discussed with you. We appreciate your help in making Lavamusic better!

- [PayPal](https://www.paypal.me/sdip521)
## 🔐 License

<!-- LICENSE -->
Distributed under the GPL-3.0 license. See ![LICENSE](https://img.shields.io/github/license/appujet/WaveMusic?style=social) for more information.

## 🔐 License
## ☕ Donate

Do you like this project? Support it by donating

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/H2H7LKT9L)
[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.me/sdip521)

## 👥 Contributors

Thanks goes to these wonderful people :

Distributed under the GPL License. See [`LICENSE`](https://github.com/brblacky/WaveMusic/blob/master/LICENSE) for more information.
![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fbrblacky%2FWaveMusic.svg?type=shield)
<a href="https://github.com/appujet/WaveMusic/graphs/contributors">
<img src="https://contrib.rocks/image?repo=appujet/WaveMusic" />
</a>

[version-shield]: https://img.shields.io/github/package-json/v/brblacky/WaveMusic?style=for-the-badge
[contributors-shield]: https://img.shields.io/github/contributors/brblacky/WaveMusic.svg?style=for-the-badge
Expand Down

0 comments on commit 44c6f08

Please sign in to comment.