diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..821c19d --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.github \ No newline at end of file diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..e07a090 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,5 @@ +{ + "recommendations": [ + "samuelcolvin.jinjahtml" + ] +} \ No newline at end of file diff --git a/assets/harmodify/music_play_response.png b/assets/harmodify/music_play_response.png new file mode 100644 index 0000000..c277750 Binary files /dev/null and b/assets/harmodify/music_play_response.png differ diff --git a/assets/harmodify/music_play_usage.png b/assets/harmodify/music_play_usage.png new file mode 100644 index 0000000..00c4d80 Binary files /dev/null and b/assets/harmodify/music_play_usage.png differ diff --git a/assets/harmodify/play_button_info.png b/assets/harmodify/play_button_info.png new file mode 100644 index 0000000..12f22d0 Binary files /dev/null and b/assets/harmodify/play_button_info.png differ diff --git a/assets/harmodify/questionmark.png b/assets/harmodify/questionmark.png new file mode 100644 index 0000000..4c285c5 Binary files /dev/null and b/assets/harmodify/questionmark.png differ diff --git a/guides/bots/Harmodify/commands.md b/guides/bots/Harmodify/commands.md index 440f1ba..9eecdf8 100644 --- a/guides/bots/Harmodify/commands.md +++ b/guides/bots/Harmodify/commands.md @@ -3,5 +3,134 @@ icon: gear order: 900 --- -Here's a list of all the available commands. +# Harmodify's Commands +___ + +Harmodify cosists of a total of **33 commands**, that have been organized into **54 groups** for the ease of our users. + +Here is a list of available groups and the commands included: + + +
+📋Table of Contents + +
+ +## 1. Music +This group features a set of commands related to the Music functionality of the bot. +!!!warning +The commands in this group require you to be in a voice channel for functionality except Lyrics commands. +!!! +### 1.1. Play + +Plays a song with a qiven query.
+ **Requred Argument:** `` +> `` can be one of the following. +>- Name of song +>- Url: +> - Can either be pointing to a song or playlist. +> - **Supported Sources:** Youtube, Youtube Music, Spotify, Soundcloud and Apple Music.
+ + **Usage:** +> /music play `query: Sunroof`
+> /music play `query: https://www.youtube.com/watch?v=8xg3vE8Ie_E`
+> /music play `query: https://open.spotify.com/track/7hDoxkN20lLb06zifzYnD2`
+ +![](/assets/harmodify/music_play_usage.png) + **Response:**
+  Plays the searched song if found otherwise gives a not found error. +![](/assets/harmodify/music_play_response.png) +The details about the fucntioning of the buttons can be found [here](/guides/bots/Harmodify/play_button_info.md). + +### 1.2. Skip + +Skips the currently playing song.
+ **Requred Argument:** `None` + + **Usage:**
+>/music skip + + **Response:**
+  Sends a confirmation embed and skips the currently playing song. + +### 1.3. Shuffle +Shuffles the current user queue.
+ **Requred Argument:** `None` + + **Usage:**
+>/music shuffle + + **Response:**
+  Shuffles the current queue if there is one otherwise does nothing. + + +### 1.4. Nightcore +Toggles on/off the Nightcore style. What is Nightcore? Have a look + + here + + + + +. + +### 1.5. Bass + +### 1.6. Toggle + +### 1.7. Volume + +### 1.8. Disconnect + +### 1.9. Queue + +### 1.10. Clear Queue + +### 1.11. Lyrics + +## 2. Info + +### 2.1 Spotify + +## 3. Misc \ No newline at end of file diff --git a/guides/bots/Harmodify/overview.md b/guides/bots/Harmodify/overview.md index daf64e0..b3a0e95 100644 --- a/guides/bots/Harmodify/overview.md +++ b/guides/bots/Harmodify/overview.md @@ -2,12 +2,16 @@ icon: rocket order: 1000 --- + - -# **Overview** ---- +# Harmodify Harmodify is the ultimate music and community engagement bot, designed to bring people together through the joy of music. Whether you're hosting a chill hangout or a high-energy event, Harmodify ensures seamless music management and a vibrant atmosphere for your server. +___ ## 🗝️Key Features --- @@ -34,4 +38,4 @@ Invite -. \ No newline at end of file +. diff --git a/guides/bots/Harmodify/play_button_info.md b/guides/bots/Harmodify/play_button_info.md new file mode 100644 index 0000000..9a6a036 --- /dev/null +++ b/guides/bots/Harmodify/play_button_info.md @@ -0,0 +1,30 @@ +--- +visibility: 'hidden' +--- + + +# Music Play Button's Info +You can find the details regarding the buttons by pressing the + +button. +![👆An Embed Showing the info regarding the button's functionality.](/assets/harmodify/play_button_info.png) \ No newline at end of file diff --git a/index.md b/index.md index 43fc2f3..d4e0d16 100644 --- a/index.md +++ b/index.md @@ -18,7 +18,7 @@ To get started with the documentation, check out the [Getting Started](/guides/g - **Sentinel (Moderation Bot)** - **Playdis (Game Bot)** - **UtiliCore (Utilities Bot)** -- [**Harmodify (Music Bot)**](/guides/bots/Harmodify/overview) +- [**Harmodify (Music Bot)**](/guides/bots/Harmodify/overview.md) - **HelpDesk (Ticket Bot)** - **Spotlight (Starboard Bot)** - **PrivateEyes (NSFW Bot)**