From b90d02b8152274522a4389a9991c9dabee03ace3 Mon Sep 17 00:00:00 2001 From: Choco <94597336+ChocoMeow@users.noreply.github.com> Date: Fri, 24 Feb 2023 13:48:53 +0800 Subject: [PATCH] Add Docs for v2.5.6 --- BUTTONS.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 5 +++++ update.py | 2 +- 3 files changed, 59 insertions(+), 1 deletion(-) create mode 100644 BUTTONS.md diff --git a/BUTTONS.md b/BUTTONS.md new file mode 100644 index 0000000..5086e07 --- /dev/null +++ b/BUTTONS.md @@ -0,0 +1,53 @@ +## Property you can use! +- Buttons + +| Button Name | Description | +| --- | --- | +| Back | Skips back to the previous song. | +| Resume | Resume or pause the music. | +| Skip | Skips to the next song. | +| Stop | Disconnects the bot from your voice channel and chears the queue. | +| Loop | Changes Loop mode. `[Off, Track, Queue]` | +| Add | Add the playing track in to your default custom playlist. | +| VolumeUp | Increase player volume by 20%. | +| VolumeDown | Decrease player volume by 20%. | +| VolumeMute | Mute or unmute the player. | +| Tracks | If there are tracks in the queue, a drop-down list will be appear. Up to 10 tracks. `(This will take one row)`| + +- Colors + +| Color Name | Description | +| --- | --- | +| Grey | Color the button grey. | +| Red | Color the button red. | +| Blue | Color the button blue. | +| Green | Color the button green. | + +## Examples +Change the value of `controller` in `settings.json`. + +1. Example 1 +image + +```json +{ + "controller": [ + ["back", "resume", "skip", {"stop": "red"}, "add"], + ["tracks"] + ] +} +``` + +2. Example 2 +image + +```json +{ + "controller": [ + ["back", "resume", "skip", {"stop": "red"}, {"add": "green"}], + [{"loop": "green"}, {"volumeup": "blue"}, {"volumedown": "blue"}, {"volumemute": "red"}], + ["tracks"] + ] +} + +``` \ No newline at end of file diff --git a/README.md b/README.md index b44d9fc..15dd045 100644 --- a/README.md +++ b/README.md @@ -90,6 +90,10 @@ MONGODB_NAME = Vocard "reddit": "<:reddit:996007566863773717>", "tiktok": "<:tiktok:996007689798811698>" }, + "controller": [ + ["back", "resume", "skip", {"stop": "red"}, "add"], + ["tracks"] + ], "cooldowns": { "connect": [2, 30], "playlist view": [1, 30] @@ -110,6 +114,7 @@ MONGODB_NAME = Vocard * 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, ...]` +* For `controller` you can set custom buttons in controller, you have to pass `2D Array` into controller. [Example Here](https://github.com/ChocoMeow/Vocard/BUTTONS.md#examples) ## How to update? 1. Run `python update.py --check` to check if your bot is up to date diff --git a/update.py b/update.py index b7d21aa..0531e33 100644 --- a/update.py +++ b/update.py @@ -3,7 +3,7 @@ from io import BytesIO root_dir = os.path.dirname(os.path.abspath(__file__)) install_pack_dir = os.path.join(root_dir, "Vocard.zip") -__version__ = "v2.5.5" +__version__ = "v2.5.6" def checkVersion(withMsg = False): resp = requests.get("https://api.github.com/repos/ChocoMeow/Vocard/releases/latest")