# StormBeatz Documentation

Developed by the Storm Developmentz team

### Welcome to the official help center of StormBeatz!

{% hint style="info" %}
**What's StormBeatz?** StormBeatz is a highly customizable and advanced Discord music bot fit for every server's needs! [Invite StormBeatz](https://link.stormbeatz.org/invite)
{% endhint %}

### Navigation

{% content-ref url="/pages/-MNKesfR-iH4X44R7-er" %}
[Frequently Asked Questions](/faq)
{% endcontent-ref %}

{% content-ref url="/pages/-MNL9eqn2cJF\_976fDeF" %}
[Changelog](/changelog)
{% endcontent-ref %}

{% content-ref url="/pages/-MNLU-RuXP-PjYatcsRG" %}
[Setup Guide](/guides/setup-guide)
{% endcontent-ref %}

{% content-ref url="/spaces/-MNKe7UyPnpNSZyWsymP/pages/YOgAUg0I99C53ak55qne" %}
[Commands](/commands)
{% endcontent-ref %}

{% hint style="info" %}
You can use the search bar, located at the top right corner, to search for keywords throughout the entire documentation on what you need help with!
{% endhint %}

{% hint style="info" %}
For additional assistance/inquiries, join our [official Discord server](https://link.stormbeatz.org/discord)!
{% endhint %}

![](https://cdn.discordapp.com/attachments/771833657781518378/929612695152517130/StormBeatz_Banner_2022_GIF_VERSION.gif)


# Frequently Asked Questions

This page consists of some commonly asked questions.

## The player lags, speeds up/slows down randomly, or cracks up?

There’s unfortunately really nothing we can do about it since it isn’t a problem with the bot or the code. Voice connections have different strengths based on multiple factors, and that’s just the way it is.

**Here are some possible causes and solutions:** \
**1.** VPN. If you have a VPN enabled, you should disable it since the voice quality and connection are likely to be poor over VPN. \
**2.** Your internet. If your internet connection is poor, then you may have issues with voice connectivity and the player might lag. \
**3.** If all else fails, check your voice region by going to the voice channel's settings. Try setting it to either US East, US South, or US Central.

## Why is the bot deafened?

Storm Developmentz highly values the privacy of all users, and as such, the bot remains deafened while in a voice channel at all times. This also improves bot performance and audio quality to a certain extent.

## How can I make StormBeatz play from specific voice channels?

Run `;settings voicechannel [#channel/channel ID]`\
\
To remove the voice channel just run the command again.\
\
**Note:** Administrators can bypass this setting. The maximum amount of channels you can do is 10.

## Who is behind the team?

StormBeatz is a bot made by Storm Developmentz, an organization of people that are experienced and dedicated to developing and maintaining advanced, efficient, customizable, and reliable bots! Our team consists of multiple members within various internal departments.

**Developers:** \
`DaStormer#7986`\
`Muh#1657`\
`TotallyNotNero#0420`\
`MyUsernamesThis#0001`\
\
**Designer:** \
`Prosome#1000`\
\
**Contributors:**\
`Veld#0001`

## What music platforms does StormBeatz support?

StormBeatz supports many different sources that you can play from (10+ sources).&#x20;


# Changelog

Information on StormBeatz updates and changes will be logged here.

## StormBeatz V6.0.0

{% tabs %}
{% tab title="New Features" %}
**+ WEB PLAYER!** Easily manage the StormBeatz music player live right from the web, with full-fledged player controls, time-synced lyrics (premium servers), logs, and more! (<https://panel.stormbeatz.org/>)

**+ LAST.FM INTEGRATION!** Enjoy detailed activity statistics, highlights, listening history, recommendations, and more by connecting your last.fm account to StormBeatz! [Click here](/guides/last.fm-integration) to learn more.

**+ SPEED SOUND EFFECT RATES!** Make the audio faster, slower, or set a custom speed!

**+ MIX SOUND EFFECTS!** Goof around by mixing up to 3 sound effects together with the `mix` command (premium feature)!

**+ SKIP VOTES SETTING!** Configure the amount of votes required for the `skip` command!

**+ PREMIUM REDUCED COOLDOWN!** Premium users get shorter command cooldowns!
{% endtab %}

{% tab title="Improvements" %}

* Playlist commands now have `add` and `remove` subcommands to **add/remove single tracks** without editing the whole playlist!
* If you have the `announce` setting enabled, **song announcements are now sent to the voice channel's text chat**!
* The filter words setting has been changed to **Block Explicit Tracks**, which will block songs flagged as explicit by our providers!
* The savedqueues command has been renamed to `serverplaylist`
* Slash command improvements
* Bug fixes & minor enhancements
  {% endtab %}
  {% endtabs %}

## StormBeatz V5.2.0

{% tabs %}
{% tab title="Additions" %}

* Echo command! By enabling this sound effect, the bot will apply an echo effect to any music you play. We can guarantee this one will impress your friends.
* Dashboard! <mark style="color:blue;"><https://panel.stormbeatz.org></mark>
  {% endtab %}

{% tab title="Fixes" %}

* Internal fixes
  {% endtab %}
  {% endtabs %}

## StormBeatz V5.1.0

{% tabs %}
{% tab title="Additions" %}
**+ TIKTOK SUPPORT!** Yeah, you can now plug your TikTok videos in voice chats!

**+ YOUTUBE PREMIERES/TRAILERS SUPPORT!** \
And also Mixcloud, but who even uses that, right?!

**+ TEXT-TO-SPEECH SUPPORT!** Troll your friends in VC by using the new `speak` command to make the bot say whatever you want!

**+ NEW COMMANDS!:** spotify, apple, tidal, deezer, spotifysearch, applesearch, tidalsearch, deezersearch, speak

**+ CUSTOM STORMBEATZ BOT!** We silently released this premium tier on our website recently. For $22/mo, you can personalize StormBeatz for your server even more by getting your OWN bot, complete with your choice of username, profile picture, and embed color!
{% endtab %}

{% tab title="Fixes" %}
\+ Fixed an issue with Spotify playlists not loading\
\+ Improved lyrics functionality\
\+ Fixed an issue causing nonexistent players (hopefully)\
\+ Improved audio player to reduce amount of errors while playing\
\+ Fixed an issue with rejoining\
\+ Fixed an issue with the forward slash command\
\+ Improved a few responses and styling\
\+ Other internal fixes
{% endtab %}
{% endtabs %}

## StormBeatz V5.0.0 🚀

{% tabs %}
{% tab title="Additions" %}
***Major New Features***\
\
**Buttons!** \
Instead of old and bland reactions, we now use buttons for most things! These are better in terms of visuals and give a better user experience. Example:\
![](https://3797580367-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MNKe7UyPnpNSZyWsymP%2Fuploads%2FCRPVcjLk1AlHCHwQ1BUj%2Fimage.png?alt=media\&token=449656cb-492f-4d6d-b143-306f7b777ccc)<br>

**Context Menus!**\
Ever want to add tracks to the queue or search for lyrics without the need of typing in with a command? With these context menus, all you need to do is right-click the mesage, click **Apps,** and click on the button you want!<br>

**Player Control Channel System!**

Allows members to go to a specific channel that the server has set and play tracks from there by simply sending the track name, link, file, etc. The channel is kept clean and all messages are deleted!

\
**Dropdown Menus!** \
We now utilize dropdown menus in commands like `;search`, allowing you to choose from the top 10 songs. Try it out for yourself to see! Example: \
![](https://3797580367-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MNKe7UyPnpNSZyWsymP%2Fuploads%2Fjf7aqUPr6HLXB860ZLtj%2Fimage.png?alt=media\&token=580f1baa-2b85-4262-94ad-60c5eee61ef7)\
\
**Autoplay!** \
Something we've been trying to figure out and work on for a **very long time**! Premium servers have the option to enable this setting which will continue to queue similar songs of the same type/genre/artist, even after the queue has ended. This way, you don't have to search for more similar songs yourself! \
\
P**ersonalized!**

You can now enjoy a personalized experience with StormBeatz, tailored entirely to YOU! Get your top songs, artists, genres, and Premium users can even get a song recommendations playlist based on their music taste!\
\
**Soundboard System!** \
You can now play saved files/links using the `;soundboard` command. Great to troll your friends with hilarious sounds. Regular servers may save up to 5 sounds, premium servers may have up to 20.

\
**Autopause Setting!**\
The bot will automatically pause if all listeners leave, and automatically resume when a listener joins!

\
**Voice Channels Setting!**\
Restrict StormBeatz to specific voice channels!<br>

**Rejoin Command!**

The bot will rejoin the voice channel without deleting the queue!

\
**Queue History!**\
View previously queued tracks with the `;queue history` command!\
\
**Autocomplete!**\
Slash commands like play will automatically give you search suggetions as you type!
{% endtab %}

{% tab title="Improvements" %}
**Command Additions/Changes!** \
Some commands have gotten some slight additions or improvements. For example, the `;back` command now accepts an optional argument for how many songs to go back by. You can also use the command even when nothing is playing now.\
\
**Slash Commands Revamp!** \
No more subcommands integrated into messy slash commands! All of our bot commands are now synced with our slash commands, so for example, `;forceskip` and `/forceskip` are both valid now, rather than `;forceskip` and `/skip force` like you would usually need to do. Not only does this give more consistency in general, but also gives our users a more friendly user-friendly experience and reduces confusion.\
\
**Instantaneous Track & Playlist Load Time!** \
We know that the load time for tracks in v4 and previous versions were very slow and inconvenient especially for large playlists. Say goodbye to that hassle now because the bot can now load hundreds of tracks in a playlist instantly now!\
\
**Announce Songs Setting!**\
Instead of choosing specific channel(s) for the bot to announce whenever a new song gets played, it will now send it directly to the channel the command was used in.\
\
**Queue size limit increased!**

10000 tracks for premium servers and 1000 tracks for regular servers!
{% endtab %}

{% tab title="Bug Fixes" %}
**Bug fixes** include the volume not saving properly when the bot plays a new track, some commands returning errors, slash commands not working randomly, the music player returning 403, 503, age-restricted errors, etc. have now been fixed. No more annoying and pesky bugs!

{% endtab %}
{% endtabs %}

## StormBeatz V4.5.0

{% tabs %}
{% tab title="Additions" %}
***QUALITY OF LIFE ENHANCEMENTS***

* **SLASH COMMANDS SUPPORT!** Just type `/` and click the StormBeatz icon for the list of commands with descriptions and options!
* **NEW SUPPORTED MUSIC PLATFORMS!:** Apple Music, TIDAL, iHeartRadio live stations, Deezer, Vimeo, Bandcamp, Twitch streams, MP3/MP4 links.\
  View the full list of supported music platforms [here](/faq#what-music-platforms-does-stormbeatz-support).
* **YOUTUBE LIVESTREAMS SUPPORT!**
* **STAGE CHANNELS SUPPORT!** Just invite StormBeatz to speak after it joins and it'll be ready to play!

***MAJOR NEW FEATURES***

* **TRACK REQUESTS SYSTEM!** Feel like members should be able to make music requests, but DJs need to review them first? No problem, we've got you covered! Read details [here](/guides/track-requests-system).
* **SAVED QUEUES FUNCTIONALITY!** You can now save the current queue to load and play later! [Premium](https://stormbeatz.org/premium) servers can save up to 10, and non-Premium servers can save 1.
* **IGNOREDEAFENED SETTING!** If enabled, StormBeatz will ignore commands that modify the player from members who are deafened!
* **DJLIVESTREAMS SETTING!** If enabled, only DJs will be able to add livestreams to the queue!
* `cleaninactive` DJ command to clear tracks queued by users who left the VC!
* `drunk` sound effect -- perfect for trolling or having a good laugh!
* `leftear`, `rightear` sound effect -- play audio on only the left or right side of your headphones!

{% endtab %}

{% tab title="Improvements" %}

* **CUSTOM EMOJI REACTIONS!** Say goodbye to icky default reactions, and hello to our very own aesthetical ones :)
* **DISCORD INLINE REPLIES!** Error messages now use Discord's reply feature!
* **MANY VISUAL ENHANCEMENTS!** We've made many minor but epic visual changes - too many to list!
* `underwater` sound effect was enhanced!
* **Spotify playlist** tracks now **load in order**, and the first track **plays INSTANTLY** so you don't have to wait!
  {% endtab %}
  {% endtabs %}

## StormBeatz V4.1.0-alpha

**Published:** Apr. 8, 2021

{% tabs %}
{% tab title="Additions" %}

* Added the `distortion` sound effect
* Added thumbnails for SoundCloud tracks
  {% endtab %}

{% tab title="Improvements" %}

* Unavailable Spotify tracks in playlists no longer cause errors and are correctly handled
* The explicit songs filter was made more accurate
* Seek command response is correctly parsed
* Other bug fixes
  {% endtab %}
  {% endtabs %}

## StormBeatz V4.0.0-alpha

**Published:** Mar. 30, 2021

{% tabs %}
{% tab title="Additions" %}

* Added an inactivity self-destruct system; bot will automatically leave the VC if:
  * No users are in the VC
  * Loop is enabled for an extended period of time
  * Queue is empty for 5+ minutes
* Added a `24/7 Mode` setting for Premium servers
  * Immune to inactivity self-destruct system
  * Bot will stay in VC until disconnected
* Added an `Audit Logs` setting for Premium servers
  * Logs every music/DJ action(s) a member executes
  * Example:

![](https://3797580367-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MNKe7UyPnpNSZyWsymP%2F-MX43CXN3FzVtUUkXNHD%2F-MX43JlgWF4_RFnxJz3P%2Fimage.png?alt=media\&token=685fbf91-34e3-42e4-b185-c23fe09a9be3)
{% endtab %}

{% tab title="Improvements" %}

* Internal revamp and optimization of the Premium system
* Fixed many code style discrepancies&#x20;
  {% endtab %}

{% tab title="Changes" %}

* Removed `autoleave` setting
  {% endtab %}
  {% endtabs %}

## StormBeatz V3.6.0

**Published:** Mar. 9, 2021

{% tabs %}
{% tab title="Additions" %}

* Added `playtop` command
  * Plays the song at the top of the queue
    {% endtab %}

{% tab title="Fixes" %}

* Fixed an issue with YouTube playlists
* Other bug fixes
  {% endtab %}
  {% endtabs %}

## StormBeatz V3.5.0

**Published:** Feb. 28, 2021

{% tabs %}
{% tab title="Additions" %}

* Added a few new sound effects
* Added `soundcloud` and `scsearch` commands which fetch songs directly from SoundCloud
* Added video thumbnails
  {% endtab %}

{% tab title="Improvements" %}

* Improved some sound effects
* Moving the bot to another VC will keep audio playing, instead of stopping the music
  {% endtab %}
  {% endtabs %}

## StormBeatz V3.4.0

**Published:** Feb. 8, 2021

{% tabs %}
{% tab title="Additions" %}

* (Re)added the the 8d sound effect
  {% endtab %}

{% tab title="Changes" %}

* Maximum songs per queue
  * *Non-Premium servers:* 100
  * *Premium servers*: 500
* Maximum duration per song
  * *Non-Premium servers:* 2 hours
  * *Premium servers:* 15 hours
    {% endtab %}

{% tab title="Fixes" %}

* Fixed an issue with Premium perks not being recognized
* Handled `queue` embed to make sure it doesn't surpass character limit
* Other bug fixes and improvements
  {% endtab %}
  {% endtabs %}

## StormBeatz V3.3.0

**Published:** Jan. 22, 2021

{% tabs %}
{% tab title="Additions" %}

* Added `fix` command.
  * `fix voice` to change server voice region
  * `fix --force` to destroy the player
* Added `reset effects` command which gets rid of whatever sound effect enabled, if any&#x20;
  {% endtab %}

{% tab title="Improvements" %}

* minor changes & fixes
  {% endtab %}
  {% endtabs %}

## StormBeatz V3.2.0

**Published:** Jan. 15, 2021

{% tabs %}
{% tab title="Additions" %}

* Added highlighting to the song duration bar

![](https://3797580367-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MNKe7UyPnpNSZyWsymP%2F-MWzFYzo_Z6q5xEhlx6k%2F-MWzHAyLYOrlnS5XE7-b%2Fimage.png?alt=media\&token=0bdf50bd-ed6b-425c-a65f-8b85ef1206bf)
{% endtab %}

{% tab title="Improvements" %}

* minor fixes
  {% endtab %}
  {% endtabs %}

## StormBeatz V3.1.0

**Published:** Jan. 11, 2021

{% tabs %}
{% tab title="Additions" %}

* Added duration of queue to the queue embed
* Added "playing since" to the queue embed
  {% endtab %}
  {% endtabs %}

## StormBeatz V3.0.0

**Published:** Jan. 10, 2021

{% tabs %}
{% tab title="Additions, Improvements, Changes" %}

* **LAVALINK!!** Our entire code has been rewritten, and we are now using Lavalink for more stability and better quality in the long run.
* HOPEFULLY **NO MORE UNEXPECTED CRASHES**
* Sound effects and seeking are now **INSTANTLY** applied (under 1 second)
* Playlists now load **MUCH FASTER** and **WITHOUT LAG**
* Volume and sound effects will now save until you change it unless the bot finishes the queue.
* Now Playing embed has been improved.
* Current duration of audio is more accurate.
* Sound effects are vote-locked for performance reasons, but you don't need to pay!&#x20;
* New sound effect commands (VERY COOL ONES): `demon`, `devil`, `goofyhelium`, `heliumbuzz`, `heartbeat`
* **AND MUCH MORE!!** Just check it out yourself! :D
  {% endtab %}
  {% endtabs %}

## StormBeatz V2.7.0

**Published:** Nov. 30, 2020

{% tabs %}
{% tab title="Added" %}

* **New music command:** `radio`
  {% endtab %}

{% tab title="Improvements" %}

* Changed up seek, forward, rewind and the rest of the Sound Effect commands/system a little. Instead of it stopping for a second, and then applying the filter, it will now wait 2 seconds and then instantly apply the change without stopping. This way is considered more preferred by people and is more convenient.
  {% endtab %}
  {% endtabs %}

## StormBeatz V2.6.0

**Published:** Nov. 30, 2020

{% tabs %}
{% tab title="Added" %}

* **New DJ commands:** `forward`, `rewind`
  {% endtab %}
  {% endtabs %}

## StormBeatz V2.5.0

**Published:** Nov. 29, 2020

{% tabs %}
{% tab title="Added" %}

* **New Sound Effects** :notes: \
  `drunk`, `invert`, `crusher`, `compressor`, `pulsator`, `bandpass`, `bandreject`
  {% endtab %}

{% tab title="Fixed" %}

* Improved some embed responses
* Sound effects now save after using the seek command
  {% endtab %}
  {% endtabs %}

## StormBeatz V2.0.0

**Published:** Nov. 25, 2020

{% tabs %}
{% tab title="Added" %}

* **Sound Effect Commands** :notes: \
  &#x20;`8bit` `bass` `echo` `nightcore` `phaser` `pitch` `pop` `speed` `static` `treble` `vaporwave`
* **New DJ command:** `seek`

![](https://3797580367-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MNKe7UyPnpNSZyWsymP%2F-MNLFQ0QQn2DP7r-jV1P%2F-MNLGXDhEx8lExEg3rE-%2Funknown.png?alt=media\&token=4a79fdb7-347d-4824-95df-1ef37eefdc10)
{% endtab %}
{% endtabs %}


# Commands

You can view StormBeatz's full detailed commands list on our main website: <https://stormbeatz.org/commands>

You can also use the `help` command for an overview of all commands.

For more information on a specific command, simply run `help [command name]`.


# YouTube Removal

This temporary info page is about the removal of YT support (April 6, 2022)

Since before the start of this project, our central mission has always been clear, and that is to create a vibrant service that allows for a unique and engaging experience. We strive to provide our users with a full-fledged product that can satisfy their needs - which is why this decision wasn’t made lightly.

In an effort to ensure our service remains **ToS-compliant** and intact, we have decided to **remove YouTube support** from StormBeatz effective immediately due to **legal concerns**.

**The side effects of this change are:**

* YouTube videos cannot be played
* All platform-specific commands have been removed (youtubesearch, soundcloudsearch, spotifysearch, etc.)
* Soundboard must use audio file links (YT links won't work)

**How can I play music now?**\
Try using the `play` command with the song name and artist name. If our new primary source has it, it will play. Most fairly well-known songs should be available. Track and playlist links from various music platforms (spotify, soundcloud, tidal, apple) still work and attempt to play the song from our primary source.

We apologize for any inconvenience and hope you stick around to see the cool new features we have in the works for the remainder of the year :)

:purple\_heart: - The SD Team


# Setup Guide

This section contains useful information that may help with setting up StormBeatz.

### Setup Guides

{% content-ref url="/pages/-MNLVO\_jVP-xqIWVBRWD" %}
[Introduction](/guides/introduction)
{% endcontent-ref %}

{% content-ref url="/pages/-MNLbmFT-JeRXjGZnCmo" %}
[Bot Access/Permissions](/guides/cmd-permissions)
{% endcontent-ref %}

{% content-ref url="/pages/-Ma0Tl0sDUxKAOp0uwc9" %}
[Track Requests System](/guides/track-requests-system)
{% endcontent-ref %}


# Introduction

This page contains basic setup instructions.

{% hint style="warning" %}
Only server administrators (users with`ADMINISTRATOR`permission) can modify StormBeatz settings!
{% endhint %}

{% hint style="info" %}
You can @mention the bot as a prefix or use our slash commands!
{% endhint %}

### Permissions

**StormBeatz requires the following TEXT permissions:**

* `READ_MESSAGES`
* `SEND_MESSAGES`
* `EMBED_LINKS`
* `USE_EXTERNAL_EMOJIS`
* `ADD_REACTIONS`
* `MANAGE_MESSAGES`
* `READ_MESSAGE_HISTORY`

**StormBeatz requires the following VOICE permissions:**

* `VIEW_CHANNEL`
* `CONNECT`
* `SPEAK`
* `USE_VOICE_ACTIVITY`

Not giving the proper permissions to the bot will result in the bot returning an error requesting for the missing permissions. Example:\
![](https://3797580367-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MNKe7UyPnpNSZyWsymP%2Fuploads%2F3aDnGEkU4tb0cA4qF353%2Fimage.png?alt=media\&token=ab6c012a-2ffb-4af6-aee4-c55591101eeb)

{% hint style="warning" %}
Make sure the Discord channel permissions are correct!\
*Discord Permissions Guide:* <https://support.discord.com/hc/en-us/articles/206029707>
{% endhint %}

### Change Prefix

{% tabs %}
{% tab title="Explanation" %}
**To change the bot's prefix, use this command:**&#x20;

{% hint style="success" %}
`;settings setprefix [new prefix]`
{% endhint %}
{% endtab %}

{% tab title="Visualization" %}
![](https://3797580367-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MNKe7UyPnpNSZyWsymP%2F-Ma0R5jswUJnbfrmOSmY%2F-Ma0Rq7_jzsrFX36GGMk%2Fimage.png?alt=media\&token=aa9ae958-df3b-4e72-9286-30bc6d3b910f)
{% endtab %}
{% endtabs %}


# Bot Access/Permissions

This page contains instructions on configuring which channels/roles are allowed to use the bot.

{% hint style="warning" %}
Only server administrators (users with`ADMINISTRATOR`permission) can modify StormBeatz settings!
{% endhint %}

### Command Channels

{% tabs %}
{% tab title="Explanation" %}
This setting can be used to set specific channels where StormBeatz commands can be used. Commands will not work in other channels. If no command channel is set, commands will work in all channels the bot can access. You can set a maximum of 10 command channels. Server Administrators can bypass this setting.

{% hint style="success" %}
`settings cmdchannel [#channel]`
{% endhint %}

{% hint style="danger" %}
Make sure the bot has the correct text [permissions](https://docs.stormbeatz.xyz/guides/introduction#permissions) in that channel!
{% endhint %}

{% hint style="info" %}
To remove a command channel, just use the same command again!
{% endhint %}
{% endtab %}

{% tab title="Visualization" %}
![](https://3797580367-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MNKe7UyPnpNSZyWsymP%2F-Ma0R5jswUJnbfrmOSmY%2F-Ma0S7XlOHTD2Zw2R5LT%2Fimage.png?alt=media\&token=a5a4983c-3b35-4159-ae62-080d0a885a26)

![](https://3797580367-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MNKe7UyPnpNSZyWsymP%2F-Ma0R5jswUJnbfrmOSmY%2F-Ma0SB9ldGprTvs4KveX%2Fimage.png?alt=media\&token=8299fab7-4de7-47a1-94f9-f1b9ceee0cd9)

{% endtab %}
{% endtabs %}

### **Music Roles**

{% tabs %}
{% tab title="Explanation" %}
This setting can be used to set specific roles that can use the [Music Commands](broken://pages/-MNLSy02eC23gpKmqkA_). Only members with music roles, DJ roles, or admin permission will be able to use music commands. If no music role is set, all members will be able to use music commands (in the command channels only, if any are set).

{% hint style="success" %}
`settings musicrole [role]`
{% endhint %}

{% hint style="info" %}
To remove a music role, just use the same command again!
{% endhint %}
{% endtab %}

{% tab title="Visualization" %}
![](https://3797580367-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MNKe7UyPnpNSZyWsymP%2F-Ma0R5jswUJnbfrmOSmY%2F-Ma0STQTWvCKZan8bcb4%2Fimage.png?alt=media\&token=4d16360a-0e77-4aef-b5d9-7a9fd3c6ba5b)

![](https://3797580367-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MNKe7UyPnpNSZyWsymP%2F-Ma0R5jswUJnbfrmOSmY%2F-Ma0SdxfSUrozxesTqL1%2Fimage.png?alt=media\&token=4799d698-8084-448c-8db2-ca02cbca2c09)

{% endtab %}
{% endtabs %}

### DJ Roles

{% tabs %}
{% tab title="Explanation" %}
This setting can be used to set specific roles that can use the [DJ Commands](broken://pages/-MNLWXgX_SQko9NuQFhC) and are considered server DJs. Members with the `ADMINISTRATOR` permission are considered DJs by default. If no DJ role is set, only admins will be able to use DJ commands.

{% hint style="success" %}
`settings djrole [role]`
{% endhint %}

{% hint style="info" %}
To remove a DJ role, just use the same command again!
{% endhint %}
{% endtab %}

{% tab title=" Visualization" %}
![](https://3797580367-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MNKe7UyPnpNSZyWsymP%2F-Ma0R5jswUJnbfrmOSmY%2F-Ma0SnfdKVVnNmpQzByn%2Fimage.png?alt=media\&token=66cf34b1-dbcc-4ab3-8411-064848a74756)

![](https://3797580367-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MNKe7UyPnpNSZyWsymP%2F-Ma0R5jswUJnbfrmOSmY%2F-Ma0Sr1k6NWYJZWirUAa%2Fimage.png?alt=media\&token=a0bf2172-2cb4-43d6-9374-aacd25e42931)
{% endtab %}
{% endtabs %}

### Role Blacklist

{% tabs %}
{% tab title="Explanation" %}
This setting can be used to set roles that will not be able to use any StormBeatz commands in your server. Blacklisted roles are above music roles, so if a member has both roles, they will not be able to use commands. DJ roles and admins bypass blacklisted roles, so even if they have a blacklisted role, they will still be able to use commands.

{% hint style="success" %}
`settings blacklistrole [role]`
{% endhint %}

{% hint style="info" %}
To remove a role from the blacklist, just use the same command again!
{% endhint %}

{% endtab %}

{% tab title="Visualization" %}
![](https://3797580367-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MNKe7UyPnpNSZyWsymP%2F-Ma0R5jswUJnbfrmOSmY%2F-Ma0SzAmu6V2W8sHLUIM%2Fimage.png?alt=media\&token=b76da748-c92d-467c-b481-45462301c969)

![](https://3797580367-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MNKe7UyPnpNSZyWsymP%2F-Ma0R5jswUJnbfrmOSmY%2F-Ma0T6ZQBcZlzZ6NbMXi%2Fimage.png?alt=media\&token=420de203-3486-4f03-b656-33b0c4dd3e4f)
{% endtab %}
{% endtabs %}

### Voice Channels

{% tabs %}
{% tab title="Explanation" %}
This setting can be used to set voice channel(s) you want StormBeatz to play from. The bot will not join any other voice channel(s). DJ roles and admins bypass this setting, so even if you set this up, they will still be able to make the bot join other voice channel(s).

{% hint style="success" %}
`;settings voicechannel [#channel/channel ID]`
{% endhint %}

{% hint style="info" %}
To remove a voice channel, just use the same command again!
{% endhint %}
{% endtab %}

{% tab title="Visualization " %}
![](https://3797580367-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MNKe7UyPnpNSZyWsymP%2Fuploads%2FIxaevGAlvVleL85SDGOf%2Fimage.png?alt=media\&token=484f0f33-bcff-44b5-83bb-e585f5d4048c)

![](https://3797580367-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MNKe7UyPnpNSZyWsymP%2Fuploads%2FUIyObhDNZpRzTmUA5dce%2Fimage.png?alt=media\&token=77aaa588-6ed0-49d9-9989-0b94ef2f825f)
{% endtab %}
{% endtabs %}


# Player Control System

This page contains useful information about the player control channel system!

### What does the Player Control system do?

It allows members to go to a specific channel that the server has set and play tracks from there by simply sending the track name, link, file, etc. The channel is kept clean and all messages are deleted!

{% hint style="info" %}
This system is completely **optional**! Only implement it if you want it.&#x20;
{% endhint %}

### How does this work?

Firstly, you have to set the player control channel. You can only have one player control channel at a time. To add a player control channel, just run the following:&#x20;

{% hint style="success" %}
`settings control [#channel/channel ID]`
{% endhint %}

### What's unique about our Player Control system?

Our player control embed is very unique with many buttons, select menus, and a cool system overall. Once a track is queued through the player control channel, you can use the buttons to backtrack, pause/unpause, skip, get lyrics, view queue, change sound effects, and more! <br>

### What does it look like?

![](https://3797580367-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MNKe7UyPnpNSZyWsymP%2Fuploads%2FQ4DtijvI7h8xXLqNKsnJ%2Fimage.png?alt=media\&token=02e784a6-bcce-402a-bf7c-f78babeb443f) ![](https://3797580367-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MNKe7UyPnpNSZyWsymP%2Fuploads%2FS52AKzCLC6VFRqMIEBPn%2Fimage.png?alt=media\&token=b3b5745a-73f3-4f10-bd7c-65c6a12c8431)


# Last.fm Integration

This page contains useful information about our last.fm integration.

### What does this system do?

Last.fm is the world's largest music tracking service, providing you with detailed activity statistics, highlights, listening history, recommendations, and more with all your favorite music streaming platforms including Spotify, Apple Music, SoundCloud, and even StormBeatz!

This system syncs your StormBeatz music activity with your last.fm account, allowing you to see all sorts of cool statistics!

### How can I link my last.fm account to StormBeatz?

Authorize StormBeatz to send your music data to last.fm: <https://panel.stormbeatz.org/lastfm>

Manage your last.fm account integration with the `lastfm` command!

![](https://3797580367-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MNKe7UyPnpNSZyWsymP%2Fuploads%2FiF88GXLHvaN8kS2NIgKp%2Fimage.png?alt=media\&token=56dbdabe-d8bc-4a4e-aaa7-05211754b383)

### Can I temporarily pause music tracking?

Yes! Use the `lastfm` command and click the "Stop Tracking" button. If you want to start syncing your music activity with last.fm again, simply click the "Resume Tracking" button.

### Statistic Examples:

![](https://3797580367-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MNKe7UyPnpNSZyWsymP%2Fuploads%2FV1LDMy65SULT1NHa3wIJ%2Fimage.png?alt=media\&token=574fcb11-53c1-43e2-adac-985e8f7553c5)![](https://3797580367-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MNKe7UyPnpNSZyWsymP%2Fuploads%2FNoJpr3IdCxDVde4U2OXt%2Fimage.png?alt=media\&token=3fa2fa7f-467d-42fc-a289-ef3cad052d3f)![](https://3797580367-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MNKe7UyPnpNSZyWsymP%2Fuploads%2FDYmq4YhSQ9GqmaFfcHf9%2Fimage.png?alt=media\&token=c113ff0d-fb0c-4661-bc1a-daf50b59b545)

**Activity Report Example:** [**https://www.last.fm/user/DaStormer/listening-report**](https://www.last.fm/user/DaStormer/listening-report)


# Autoplay

This page contains information on our autoplay functionality.

{% hint style="info" %}
The autoplay feature requires you to have a [server premium](https://stormbeatz.org/premium) tier.
{% endhint %}

### What does the autoplay feature do?

The autoplay feature queues music to the queue for you based on your queue's music taste! If you have a queue of any length, whether small or big and the queue ends, the bot will continue to find similar songs for you based on what was queued without you going out of your way to find new songs.&#x20;

### How does this work?

Firstly, you need to enable the autoplay feature. The autoplay feature will not work without it being enabled first.

{% hint style="success" %}
`settings autoplay on`
{% endhint %}

### Is the autoplay accurate?

We guarantee that the autoplay feature is very accurate to get similar songs based on the queue's music taste.

{% hint style="warning" %}
In order for the bot to start finding more songs with autoplay, you must have at least 3 previously queued tracks.
{% endhint %}


# Track Requests System

This page contains useful information about the track requests feature and how to utilize it correctly.

### What does the track requests system do?

It allows members to use the `request` command, which works similarly to the play command.\
[DJs](/guides/cmd-permissions#dj-roles) are able to accept or deny requests. Regular users will not be able to use any other music managing command.

{% hint style="info" %}
This system is completely **optional**! Only implement it if you want it.
{% endhint %}

### How does this work?

Firstly, you have to set the requests channel. The request command will not function without it! You can only have one requests channel at a time. To add a requests channel, just run the following:

{% hint style="success" %}
`settings requests [#channel/channel ID]`
{% endhint %}

{% hint style="danger" %}
When a requests channel is set, regular members will not be able to use any music managing commands (join, leave, play, skip, etc.).
{% endhint %}

Now, members will be able to use the `request` command. When they use it, a message embed with information is sent to the requests channel. It contains the track name, link, author, duration, requester, and the current voice channel.

{% hint style="warning" %}
Make sure StormBeatz has the `USE_EXTERNAL_EMOJIS` permissions in the channel!
{% endhint %}

[DJs](/guides/cmd-permissions#dj-roles) and server admins are able to accept or deny requests by clicking the respective buttons. If a request is accepted, the embed color will turn green and StormBeatz will add the track to the queue. If a request is denied, the embed color will turn red and StormBeatz will not add the track. After a request is reviewed, StormBeatz removes the buttons.

{% hint style="warning" %}
Make sure StormBeatz has the `MANAGE_MESSAGES` permission in the channel!
{% endhint %}

### How can I restrict the request command to specific members?

The request command can only be accessed by members with a [music role](/guides/cmd-permissions#music-roles). If there is no music role, all members will be able to access it.

### How can I disable/remove the requests system?

To remove the requests system in your server, simply run the `settings requests [#channel/channel ID]` command again. Make sure to mention the same channel it's currently set to.


# Playlists System

This page contains information on our playlists functionality.

### What is the difference between playlists and server playlists?

The `playlist` command allows premium users to save playlists and load them in any server.\
The `serverplaylist` command allows server DJs to save playlists for that specific server, and they can be managed by any other DJ.

{% hint style="info" %}
On this page, we're using `serverplaylist`, but you can use `playlist` too!
{% endhint %}

### How can I create a server playlist?

First, make sure the tracks that you want to save are in the current queue.\
Then, use this command:

{% hint style="success" %}
`serverplaylist create [name]`
{% endhint %}

Remember to replace "\[name]" with the name you want to save the queue with!\
[Premium](https://stormbeatz.org/premium) servers can create up to 10 server playlists. Non-Premium servers can create 1.

### How can I delete a server playlist?

Just run this command:

{% hint style="success" %}
`serverplaylist delete [name]`
{% endhint %}

Make sure the name is correct; it's case-sensitive!

### How can I see all server playlists?

Just run this command:

{% hint style="success" %}
`serverplaylist list`
{% endhint %}

### How can I view the tracks in a playlist?

Just run this command:

{% hint style="success" %}
`serverplaylist view [playlist name]`
{% endhint %}

Make sure the name is correct; it's case-sensitive!

### How can I load and play a server playlist?

Just run this command:

{% hint style="success" %}
`serverplaylist load [name]`
{% endhint %}

Make sure the name is correct; it's case-sensitive!

### How can I edit a server playlist?

First load the current save and add all the tracks you want to save to the current queue, and then run this command:

{% hint style="success" %}
`serverplaylist edit [name]`
{% endhint %}

To add just a single track to a playlist, use this command:

{% hint style="success" %}
`serverplaylist add [playlist name], [track name/link]`
{% endhint %}

To remove a single track from a playlist, use this command:

{% hint style="success" %}
`serverplaylist remove [playlist name] [track position]`
{% endhint %}

**Tip:** You can get the track position from the [view](#how-can-i-view-the-tracks-in-a-playlist) subcommand!


# Soundboard System

This page contains information on our soundboard functionality.

### What is the Soundboard system for?

The Soundboard allows for the storage and eventual playing of different sounds, allowing for the endless trolling of your server members.

### How can I create a sound?

To create a sound, run the soundboard command with your first argument as "create":

{% hint style="success" %}
`soundboard create`
{% endhint %}

Next, pick a name for your sound and find the link that directs towards that sound. It can be any link that is supported by the bot's regular music player. We recommend using an audio file link!

{% hint style="success" %}
`soundboard create [name] [link]`
{% endhint %}

StormBeatz will verify the sound before storing it. If you get an error returned, simply try to find another link, as that means our internal system does not recognize the link.

### How do I play a sound?

Once you have stored a sound, use `soundboard list` to list your sounds. From here, you can queue sounds using one of two ways: either by running this command:

{% hint style="success" %}
`soundboard play [name]`
{% endhint %}

Or another way is to use our brand-new buttons system to load a track. To utilize this, simply hop in a voice channel and click the button that corresponds with the sound name you selected.&#x20;

{% hint style="info" %}
While attempting to queue a track using buttons, the embed message with the buttons may disappear after 30 seconds. Try again if this happens!
{% endhint %}

### How do I delete a sound?

To delete a sound, run the command `soundboard delete [name]`.


