From afb9a86eb5039f4b1029a8937f200b7a55d4d605 Mon Sep 17 00:00:00 2001 From: Choco <94597336+ChocoMeow@users.noreply.github.com> Date: Sun, 26 Mar 2023 17:47:27 +0800 Subject: [PATCH] Update README.md --- README.md | 31 +++++++++++++++++++++++++------ 1 file changed, 25 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8baa726..623e670 100644 --- a/README.md +++ b/README.md @@ -5,18 +5,26 @@ # Vocard (Discord Music Bot) > Vocard is a simple custom Disocrd Music Bot built with Python & [discord.py](https://discordpy.readthedocs.io/en/stable/) +# Demo (Bot & Dashboard) +* [Discord Bot](https://discord.com/api/oauth2/authorize?client_id=890399639008866355&permissions=36708608&scope=bot%20applications.commands) +* [Dashboard](http://vocard.xyz) + ## 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 + + + ## Run the Projects [![Run on Repl.it](https://replit.com/badge/github/ChocoMeow/Vocard)](https://replit.com/new/github/ChocoMeow/Vocard) @@ -40,6 +48,9 @@ Start your bot with `python main.py` ```sh TOKEN = XXXXXXXXXXXXXXXXXXXXXXXX.XXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXXXX CLIENT_ID = 123456789012345678 +CLIENT_SECRET_ID = YOUR_BOT_CLIENT_SECRET_ID +SERCET_KEY = DASHBOARD_SERCET_KEY + BUG_REPORT_CHANNEL_ID = 123456789012345678 SPOTIFY_CLIENT_ID = 0XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX @@ -54,6 +65,8 @@ MONGODB_NAME = Vocard | --- | --- | | TOKEN | Your Discord bot token [(Discord Portal)](https://discord.com/developers/applications) | | CLIENT_ID | Your Discord bot client id [(Discord Portal)](https://discord.com/developers/applications) | +| CLIENT_SECRET_ID | Your Discord bot client secret id [(Discord Portal)](https://discord.com/developers/applications) ***(optional)*** | +| SERCET_KEY | Secret key for dashboard [(Discord Portal)](https://discord.com/developers/applications) ***(optional)*** | | BUG_REPORT_CHANNEL_ID | All the error messages will send to this text channel ***(optional)*** | | SPOTIFY_CLIENT_ID | Your Spoity client id [(Spotify Portal)](https://developer.spotify.com/dashboard/applications) ***(optional)*** | | SPOTIFY_CLIENT_SECRET | Your Spoity client sercret id [(Spotify Portal)](https://developer.spotify.com/dashboard/applications) ***(optional)*** | @@ -78,6 +91,11 @@ MONGODB_NAME = Vocard "bot_access_user": [], "color_code":"0xb3b3b3", "default_max_queue": 1000, + "ipc_server": { + "host": "127.0.0.1", + "port": 8000, + "enable": false + }, "emoji_source_raw": { "youtube": "<:youtube:826661982760992778>", "youtube music": "<:youtube:826661982760992778>", @@ -111,6 +129,7 @@ MONGODB_NAME = Vocard * For `bot_access_user` you can pass the [discord user id](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-). Example: `[123456789012345678]` * For `color_code` you must pass a [Hexadecimal color code](https://htmlcolorcodes.com/) and add `0x` before the color code. Example: `"0xb3b3b3"` * For `default_max_queue` you can set a default maximum number of tracks that can be added to the queue. +* For `ipc_server` you can set the host, password and enable of the ipc server. * For `emoji_source_raw` you can change the source emoji of the track with discord emoji like `<:EMOJI_NAME:EMOJI_ID>` * For `cooldowns` you can set a custom cooldown in the command. Example: `"command_name": [The total number of tokens available, The length of the cooldown period in seconds]` * For `aliases` you can set custom aliases in the command. Example: `"command_name": [alias1, alias2, ...]`