Add Docs for v2.5.6

This commit is contained in:
Choco
2023-02-24 13:48:53 +08:00
parent 3cdf254abf
commit b90d02b815
3 changed files with 59 additions and 1 deletions

53
BUTTONS.md Normal file
View File

@@ -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
<img width="459" alt="image" src="https://user-images.githubusercontent.com/94597336/221099779-d458e274-6052-4265-afb2-b232de1b1fd4.png">
```json
{
"controller": [
["back", "resume", "skip", {"stop": "red"}, "add"],
["tracks"]
]
}
```
2. Example 2
<img width="480" alt="image" src="https://user-images.githubusercontent.com/94597336/221099004-9913ee28-5079-488a-b880-902c7ab7ce38.png">
```json
{
"controller": [
["back", "resume", "skip", {"stop": "red"}, {"add": "green"}],
[{"loop": "green"}, {"volumeup": "blue"}, {"volumedown": "blue"}, {"volumemute": "red"}],
["tracks"]
]
}
```

View File

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

View File

@@ -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")