diff --git a/BUTTONS.md b/BUTTONS.md index ba20b76..0661cbc 100644 --- a/BUTTONS.md +++ b/BUTTONS.md @@ -12,6 +12,8 @@ | VolumeUp | Increase player volume by 20%. | | VolumeDown | Decrease player volume by 20%. | | VolumeMute | Mute or unmute the player. | +| Autoplay | Enable or disable autoplay mode. | +| Shuffle | Randomizes the tracks in the queue. | | 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 @@ -30,24 +32,30 @@ Change the value of `controller` in `settings.json`. image ```json -{ - "controller": [ - ["back", "resume", "skip", {"stop": "red"}, "add"], - ["tracks"] - ] -} +"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"] - ] -} - +"controller": [ + ["back", "resume", "skip", {"stop": "red"}, {"add": "green"}], + [{"loop": "green"}, {"volumeup": "blue"}, {"volumedown": "blue"}, {"volumemute": "red"}], + ["tracks"] +] ``` + +3. Example 3 +image + +```json +"controller": [ + ["autoplay", "shuffle", {"loop": "green"}, "add"], + ["back", "resume", "skip", {"stop": "red"}], + ["volumeup", "volumedown", {"mute": "red"}] +] +``` \ No newline at end of file diff --git a/README.md b/README.md index 63f2778..e6e585c 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ Start your bot with `python main.py` ```sh TOKEN = XXXXXXXXXXXXXXXXXXXXXXXX.XXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXXXX CLIENT_ID = 123456789012345678 -CLIENT_SECRET_ID = YOUR_BOT_CLIENT_SECRET_ID +CLIENT_SECRET_ID = XXXXXXXXXX-XXXXXXXXXXXXXXXXXXXXX SERCET_KEY = DASHBOARD_SERCET_KEY BUG_REPORT_CHANNEL_ID = 123456789012345678 @@ -71,6 +71,7 @@ MONGODB_NAME = Vocard | 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)*** | | YOUTUBE_API_KEY | Your youtube api key [(Google API)](https://cloud.google.com/apis) ***(optional)*** | +| GENIUS_TOKEN | Your genius api key [(Genius Lyrics API)](https://genius.com/api-clients) ***(optional)*** | | MONGODB_URL | Your Mongo datebase url [(Mongodb)](https://www.mongodb.com/) | | MONGODB_NAME | The datebase name that you created on [Mongodb](https://www.mongodb.com/) | @@ -91,6 +92,7 @@ MONGODB_NAME = Vocard "bot_access_user": [], "color_code":"0xb3b3b3", "default_max_queue": 1000, + "lyrics_platform": "A_ZLyrics", "ipc_server": { "host": "127.0.0.1", "port": 8000, @@ -129,6 +131,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 `lyrics_platform` you can set lyrics search engine (e.g. `A_ZLyrics`, `Genius`)
**NOTE: If you are using Genius as your lyrics search engine, you must install the lyricsgenius module (`pip install lyricsgenius`)** * 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]` @@ -138,4 +141,4 @@ MONGODB_NAME = Vocard ## How to update? 1. Run `python update.py --check` to check if your bot is up to date 2. Run `python update.py --start` to start update your bot
-***Note: Make sure there are no personal files in the directory! Otherwise it will be deleted.*** +***Note: Make sure there are no personal files in the directory! Otherwise it will be deleted.*** \ No newline at end of file diff --git a/update.py b/update.py index 552517f..cbd1afa 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.6.0" +__version__ = "v2.6.1" def checkVersion(withMsg = False): resp = requests.get("https://api.github.com/repos/ChocoMeow/Vocard/releases/latest") diff --git a/voicelink/__init__.py b/voicelink/__init__.py index 5761ca5..e2eb446 100644 --- a/voicelink/__init__.py +++ b/voicelink/__init__.py @@ -21,7 +21,7 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. """ -__version__ = "0.8" +__version__ = "0.9" __author__ = 'Vocard Development, Choco' __license__ = "MIT" __copyright__ = "Copyright 2023 (c) Vocard Development, Choco"