Skip to content

Commit

Permalink
The End of Harmodify's Docs for Now 💀
Browse files Browse the repository at this point in the history
  • Loading branch information
@wolf4605
wolf4605 committed Nov 29, 2024
1 parent 7bb1866 commit aee1876
Showing 1 changed file with 128 additions and 30 deletions.
158 changes: 128 additions & 30 deletions guides/bots/Harmodify/commands.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,16 @@ text-decoration: none;
a.external:hover {
text-decoration: underline;
}
.custom_image {
border-radius:50%;
}
</style>

# Harmodify's Commands
# <img class="custom_image" src="https://images.disutils.com/bot_assets/profile_pictures_jpg/Harmodify.jpg" width=50 lenght=50> Harmodify's Commands

___

Harmodify cosists of a total of **33 commands**, that have been organized into **3 groups** for the ease of our users.
Harmodify cosists of a total of **23 commands**, that have been organized into **3 groups** for the ease of our users.

Here is a list of available groups and the commands included:
<!--
Expand Down Expand Up @@ -45,17 +48,17 @@ Here is a list of available groups and the commands included:
<ul>
<li><a href="#1-music">1. Music</a><br /></li>
<ul>
<li><a href="#11-play">1.1. Play</a><br/></li>
<li><a href="#12-skip">1.2. Skip</a><br/></li>
<li><a href="#13-shuffle">1.3. Shuffle</a><br/></li>
<li><a href="#14-nightcore">1.4. Nightcore</a><br/></li>
<li><a href="#15-bass">1.5. Bass</a><br /></li>
<li><a href="#16-toggle">1.6. Toggle</a><br /></li>
<li><a href="#17-volume">1.7. Volume</a><br /></li>
<li><a href="#18-disconnect">1.8. Disconnect</a><br /></li>
<li><a href="#19-queue">1.9. Queue</a><br /></li>
<li><a href="#110-clear-queue">1.10. Clear Queue</a><br /></li>
<li><a href="#111-lyrics">1.11. Lyrics</a><br /></li>
<li><a href="#11-play">1.1 Play</a><br/></li>
<li><a href="#12-skip">1.2 Skip</a><br/></li>
<li><a href="#13-shuffle">1.3 Shuffle</a><br/></li>
<li><a href="#14-nightcore">1.4 Nightcore</a><br/></li>
<li><a href="#15-bass">1.5 Bass</a><br /></li>
<li><a href="#16-toggle">1.6 Toggle</a><br /></li>
<li><a href="#17-volume">1.7 Volume</a><br /></li>
<li><a href="#18-disconnect">1.8 Disconnect</a><br /></li>
<li><a href="#19-queue">1.9 Queue</a><br /></li>
<li><a href="#110-clear-queue">1.10 Clear Queue</a><br /></li>
<li><a href="#111-lyrics">1.11 Lyrics</a><br /></li>
</ul>
<li><a href="#2-info">2. Info</a><br />
<ul>
Expand All @@ -66,12 +69,13 @@ Here is a list of available groups and the commands included:
</ul>
</blockquote>

---
## 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
### 1.1 Play

Plays a song with a qiven query.<br/>
&emsp;**Requred Argument:** `<query>`
Expand All @@ -92,7 +96,7 @@ Plays a song with a qiven query.<br/>
![](/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
### 1.2 Skip

Skips the currently playing song.<br/>
&emsp;**Requred Argument:** `None`
Expand All @@ -103,7 +107,7 @@ Skips the currently playing song.<br/>
&emsp;**Response:**<br>
&emsp;&emsp;Sends a confirmation embed and skips the currently playing song.

### 1.3. Shuffle
### 1.3 Shuffle
Shuffles the current user queue.<br>
&emsp;**Requred Argument:** `None`

Expand All @@ -114,26 +118,41 @@ Shuffles the current user queue.<br>
&emsp;&emsp;Shuffles the current queue if there is one otherwise does nothing.


### 1.4. Nightcore
Toggles on/off the Nightcore style.
### 1.4 Nightcore
Toggles on/off the Nightcore style.<br>
&emsp;**Requred Argument:** `None`

&emsp;**Usage:**<br/>
>/music nightcore
&emsp;**Response:**<br>
&emsp;&emsp;What is Nightcore? Have a look
&emsp;&emsp;Increases Pitch and Speed of the songs currently being played and in queue.

!!!Note
What is Nightcore? Have a look
<a class="external" href="https://en.wikipedia.org/wiki/Nightcore" target="_blank" >
here
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor"
class="bi bi-box-arrow-up-right" viewBox="0 0 16 16" style="margin-left: 4px;">
<path fill-rule="evenodd" d="M8.636 3.5a.5.5 0 0 0-.5-.5H1.5A1.5 1.5 0 0 0 0 4.5v10A1.5 1.5 0 0 0 1.5 16h10a1.5 1.5 0 0 0 1.5-1.5V7.864a.5.5 0 0 0-1 0V14.5a.5.5 0 0 1-.5.5h-10a.5.5 0 0 1-.5-.5v-10a.5.5 0 0 1 .5-.5h6.636a.5.5 0 0 0 .5-.5"/>
<path fill-rule="evenodd" d="M16 .5a.5.5 0 0 0-.5-.5h-5a.5.5 0 0 0 0 1h3.793L6.146 9.146a.5.5 0 1 0 .708.708L15 1.707V5.5a.5.5 0 0 0 1 0z"/>
</svg>
</a>.
!!!Note
</a>.<br>
Even I don't know what is Nightcore. :skull:
!!!

### 1.5. Bass
### 1.5 Bass

Sets the bass level.<br>
&emsp;**Require Argument:** `<level>`
> `<level>` the bass boost level to set.
> - **Max Value:** 100
> - **Min Value:** 1
&emsp;**Response:**<br>
&emsp;&emsp;Sets the bass level to given level.
### 1.6 Toggle

### 1.6. Toggle
Pauses or Resumes the player depending on it's current state.<br>
&emsp;**Requred Argument:** `None`

Expand All @@ -143,26 +162,105 @@ Pauses or Resumes the player depending on it's current state.<br>
&emsp;**Response:**<br>
&emsp;&emsp;Changes the current state of player if it's paused resumes the audio playback otherwise pauses the playback.

### 1.7. Volume
### 1.7 Volume

Sets the Voume of the player.<br>
&emsp;**Requred Argument:** `<value>`
>`value` The amount you want the volume to be set at.<br>
> `<value>` The amount you want the volume to be set at.<br>
> - **Max Value:** 100
> - **Min Value:** 0 (which is equal to muting the audio.)
&emsp;**Response:**<br>
&emsp;&emsp;Changes the volume to the amount you set it to be if it's a valid value.

### 1.8. Disconnect
### 1.8 Disconnect

### 1.9. Queue
Stops the Music Player.<br>
&emsp;**Requred Argument:** `None`

### 1.10. Clear Queue
&emsp;**Usage:**<br/>
>/music disconnect
### 1.11. Lyrics
&emsp;**Response:**<br>
&emsp;&emsp;Stops the currently playing song and clears up the queue, exits the voice channel.

### 1.9 Queue

Shows the queue.<br>
&emsp;**Requred Argument:** `None`

&emsp;**Usage:**<br/>
>/music queue
&emsp;**Response:**<br>
&emsp;&emsp;Sends an embed showing the current playing queue.

### 1.10 Clear Queue

Clears the queue.<br>
&emsp;**Requred Argument:** `None`

&emsp;**Usage:**<br/>
>/music clearqueue
&emsp;**Response:**<br>
&emsp;&emsp;Clears the current playing queue.

### 1.11 Lyrics

Fetches the lyrics of the searched Song.<br>
&emsp;**Requred Argument:** `<title>` `[author]`
> - `<title>` the name of the song.<br>
> - `[author]` (Optional) the singer of the song.
&emsp;**Usage:**<br/>
>/music lyrics `title: Imagine Dragon Bones`<br>
>/music lyrics `title: Love Story` `author: Taylor Swift`
&emsp;**Response:**<br>
&emsp;&emsp; Sends an Embed with the lyrics of the searched title otherwise sends an error if no lyrics found

---

## 2. Info

A set of commands to know various info regarding the bot or a user.

!!!Important
This group is common to all our bots a details regarding this group can be found [here](/guides/common-commands.md#info-cog).
!!!

### 2.1 Spotify

## 3. Misc
!!!Info
This is an exclusive command to **Harmodify Only.**
!!!
Shows the currently playing song in a user's activity.<br>
&emsp;**Required Arguments:** `[user]`
> `[user]` (Optional) The user whom activity you want to know.
&emsp;**Usage:**
>/info spotify<br>
>/info spotify `user: @Jiggly-Ball`
&emsp;**Response**<br>
&emsp;&emsp;Sends an embed containg info regarding the song, if the user tagged is listening to a song on Spotify. If no user is tagged then it will check your Spotify activity.<br>
!!!warning Note
This command will only work if it is the orignal spotify client provided by <a class="external" href="https://open.spotify.com/" target="_blank" >
Spotify
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor"
class="bi bi-box-arrow-up-right" viewBox="0 0 16 16" style="margin-left: 4px;">
<path fill-rule="evenodd" d="M8.636 3.5a.5.5 0 0 0-.5-.5H1.5A1.5 1.5 0 0 0 0 4.5v10A1.5 1.5 0 0 0 1.5 16h10a1.5 1.5 0 0 0 1.5-1.5V7.864a.5.5 0 0 0-1 0V14.5a.5.5 0 0 1-.5.5h-10a.5.5 0 0 1-.5-.5v-10a.5.5 0 0 1 .5-.5h6.636a.5.5 0 0 0 .5-.5"/>
<path fill-rule="evenodd" d="M16 .5a.5.5 0 0 0-.5-.5h-5a.5.5 0 0 0 0 1h3.793L6.146 9.146a.5.5 0 1 0 .708.708L15 1.707V5.5a.5.5 0 0 0 1 0z"/>
</svg>
</a>. Alternatives like Spotipy, Ncspot, Spot, etc might or might not work with this command.
!!!

---

## 3. Misc
A set miscellenous commands that can be used for bug reporting and some other purposes that have nothing to do with the main functionality of bot.
!!!Important
This group is common to all our bots a details regarding this group can be found [here](/guides/common-commands.md#misc-cog).
!!!
---

0 comments on commit aee1876

Please sign in to comment.