diff --git a/README.md b/README.md index 8302821..35e9741 100644 --- a/README.md +++ b/README.md @@ -2,61 +2,35 @@ Discord -# Vocard (Discord Music Bot) -> Vocard is a simple custom Disocrd Music Bot built with Python & [discord.py](https://discordpy.readthedocs.io/en/stable/)
-Demo: [Discord Bot Demo](https://discord.com/api/oauth2/authorize?client_id=890399639008866355&permissions=36708608&scope=bot%20applications.commands), -[Dashboard Demo](https://vocard.xyz) +# Vocard Bot +Vocard is a highly customizable Discord music bot, designed to deliver a user-friendly experience. It offers support for a wide range of streaming platforms including Youtube, Soundcloud, Spotify, Twitch, and more. -# Host for you? - - Patreon - +## Features +* Fast song loading +* Works with slash and message commands +* Lightweight design +* Smooth playback +* Clean and nice interface +* Supports many music platforms (YouTube, SoundCloud, etc.) +* Built-in playlist support +* Fully customizable settings +* Lyrics support +* Various sound effects +* Multiple languages available +* Easy to update +* Supports docker +* Premium dashboard (in beta) -# Tutorial -Click on the image below to watch the tutorial on Youtube. - -[![Discord Music Bot](https://img.youtube.com/vi/f_Z0RLRZzWw/maxresdefault.jpg)](https://www.youtube.com/watch?v=f_Z0RLRZzWw) - ## Screenshot -### Discord Bot - - - - - -### Dashboard - - +![features](https://github.com/user-attachments/assets/5d1dadb3-c706-4906-b1b6-fdee192705d5) ## Requirements -* [Python 3.10+](https://www.python.org/downloads/) +* [Python 3.11+](https://www.python.org/downloads/) * [Lavalink Server (Requires 4.0.0+)](https://github.com/freyacodes/Lavalink) -## Quick Start -```sh -git clone https://github.com/ChocoMeow/Vocard.git #Clone the repository -cd Vocard #Go to the directory -python -m pip install -r requirements.txt #Install required packages -``` -After installing all packages, you must configure the bot before to start! [How To Configure](https://docs.vocard.xyz/configuration/)
-Start your bot with `python main.py` +## Setup +Please see the [Setup Page](https://docs.vocard.xyz) in the docs to run this bot yourself! -## Configuration -1. Rename `settings Example.json` to `settings.json` and [customize your settings](https://docs.vocard.xyz/configuration/#settings-up-settingsjson). -3. Now, you can start your bot with `python main.py`. +## Need Help? +Join the [Vocard Support Discord](https://discord.gg/wRCgB7vBQv) for help or questions. -## How to update? (For Windows and Linux) -***Note: Make sure there are no personal files in the directory! Otherwise it will be deleted.*** -```sh -# Check the current version -python update.py -c - -# Install the latest version -python update.py -l - -# Install the specified version -python update.py -v VERSION - -# Install the beta version -python update.py -b -```