diff --git a/Commands.md b/Commands.md new file mode 100644 index 0000000..47ff7be --- /dev/null +++ b/Commands.md @@ -0,0 +1,51 @@ +Biscuit comes with some commands. The command signifier can be changed in the config, but for this tutorial, we will be using the default signifier (-). + +In order to give staff access to the moderation tools, create a role called ``biscuit-key`` (can be changed in the config) and grant it to whoever you want to have access. + +To give a user unrestricted access to all commands and features of the bot, create a role called ``biscuit-admin`` (can also be changed in the config) and grant it to whoever you want to have access. + +# Commands: + +* **-help [Page #]** - Pulls up a list of commands +* **-ping** - Check if the bot is responding +* **-softmute @(mention-user)** - Soft mutes a user. In this state, they will only be able to send a message every two minutes. **[2]** +* **-unsoftmute @(mention-user)** - Removes a soft mute from a user. **[2]** +* **-notspammer @(mention-user)** - Delists user as spammer. **[2]** +* **-recentspammers** - Shows a list of recent spammers. +* **-chanid** - Displays the ID of the current channel. +* **-uid @(mention-user)** - Displays the ID of the mentioned user. **[2]** +* **-togglerole (role)** [ALIAS -tr (role)] - Used by members to toggle on/off a role specified in ``ToggleRoles`` in the config. +* **-makeinvite (channel-name) [max-age-hours]** - Creates an invite in the specified channel. **[1]** +* **-guildid** - Displays the ID of the guild. **[2]** +* **-wiki** - Links the wiki. **[2]** +* **-getconfig** - Get a current copy of the guild config. **[1]** +* **-saveconfig** (With file upload) - Saves the config with the contents of the uploaded file. **[1]** + +### Music Player Commands + +* **-play (YouTube link OR Search Phrase)** - Plays the specified song or plays a song found using search parameters. +* **-playfirst (YouTube link OR Search Phrase)** - Places specified song at the front of the queue. **[3]** +* **-clear** - Clears all upcoming songs from the queue. **[3]** +* **-clearusersongs @(mention-user)** - Clears all upcoming songs from specified user. **[3]** +* **-forceskip** - Forces the current song to be skipped. +* **-forceskipto (Track #)** - Force skips all songs until the specified track. **[3]** +* **-loopmusic** - Enables looping of all songs played. **[3]** +* **-moveto (CurrentTrack #) (NewTrack #)** - Moves track to specified position. **[3]** +* **-nowplaying** - Displays the currently playing song. +* **-pause** - Pauses the current track. **[3]** +* **-unpause OR -resume** - Unpauses the current track. **[3]** +* **-togglepause OR -tp** - Toggles the pause status of the current track. **[3]** +* **-queue [Page #]** - Displays the upcoming songs in the music queue. +* **-remove (Track #)** - Removes song from specified position in queue. +* **-shuffle** - Shuffles the sender's songs in the queue. +* **-skipall** - Forces the all songs to be skipped. **[3]** +* **-skip** - Sends a vote to skip the song that is currently playing. +* **-volume [0-150]** - Changes the player volume or displays the current volume. **[3]** + +**[1]**: Requires Admin role or server administrator + +**[2]**: Requires Moderator role, Admin role, or server administrator + +**[3]**: Requires Music Player Controller role, Moderator role, Admin role, or server administrator + +There are also some basic math functions that you can find listed in **-help**. Additionally from the command line, you can use the command ``say `` (``bsay`` when running on spigot) to send a message to a specific text channel on all servers (Don't include the "#" in the channel name) and ``gsay `` to send a message to a channel on a specific server. If you are running the bot as a spigot plugin, use the command ``bsay `` instead. You can also shut down the bot from console using ``shutdown``. Shutdown is not available when running as a spigot plugin. \ No newline at end of file