-
Notifications
You must be signed in to change notification settings - Fork 5
/
faq.yaml
422 lines (422 loc) · 23.6 KB
/
faq.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
# YAML does not support tab characters. Ensure each tab is represented as 4 spaces.
---
Introduction:
What is Rythm Bot?: |
<br/> Rythm is a feature-rich, high-performance music bot for Discord, specially designed to deliver High Quality music, stability and ease of use while also providing advanced music functionalities in order to create the ultimate music bot experience.
How do I add Rythm to my server?: |
<br/> You can add Rythm to your Discord server by clicking on the following link:
<br/>
<br/> <a href="https://rythmbot.co/invite">https://rythmbot.co/invite</a>
<br/>
<br/> <b>Note:</b> You must have a role with the “Administrator” or the “Manage Server” permission to be able to add Rythm to a Discord Server. If you have either of these permissions you should be able to change the name of your server.
<br/> Also make sure you’re logged in to the right account in the web browser when adding Rythm, see <a href="https://discordapp.com/login">https://discordapp.com/login</a>
What is Rythm's Discord Server for?: |
<br/> Rythm’s Discord server is the official platform for everything related to Rythm.
<br/>
<br/> Here you’ll be able to:
<br/>
<br/> • See information about Rythm’s latest features and updates.
<br/> • Keep up with all the news and announcements.
<br/> • Hang out with the members of our fast growing community!
<br/> • Suggest new features for Rythm.
<br/> • Get support from our Staff members.
<br/>
<br/> <b>Note:</b> For an invite to Rythm's Discord server, use the following link:
<br/>
<br/> <a href="https://rythmbot.co/support">https://rythmbot.co/support</a>
How can Rythm be in so many servers at once?: |
<br/> Rythm uses a system called "sharding".
<br/>
<br/> For more information on how sharding works <a href="https://discordapp.com/developers/docs/topics/gateway#sharding">click here (https://discordapp.com/developers/docs/topics/gateway#sharding)</a> to view Discord's documentation of it.
Basics:
How can I play a song with Rythm?: |
<br/> To play a song use the following command format:
<br/>
<br/> <b>!play <code>songname/URL</code></b>
<br/>
<br/> <b><u>Example</u></b>: !play retrograde
<br/>
<br/> For a full list of commands type <b>!help</b> in your server with Rythm in it.
How do I change Rythm's Prefix?: |
<br/> To change Rythm’s prefix use the following command format:
<br/>
<br/> <b>!settings prefix <code>NewPrefix</code></b>
<br/>
<br/> <b><u>Example</u></b>: !settings prefix +
How can I see the current prefix for Rythm or Rythm 2?: |
<br/> You can see the current prefix for either bot by mentioning them.
<br/>
<br/> For Rythm:
<br/> <b> @Rythm#3722 </b> OR <b> <@!235088799074484224> </b>
<br/>
<br/> For Rythm 2:
<br/> <b> @Rythm 2#2000 </b> OR <b> <@!252128902418268161> </b>
<br/>
<br/> A message should be returned by Rythm stating its current prefix.
Can I play a playlist with Rythm?: |
<br/> Rythm can use playlists from a variety of online audio sources including YouTube and SoundCloud.
<br/>
<br/> To add songs to the queue from an online playlist, use the following command format:
<br/>
<br/> <b> !play <code>URL</code> </b>
<br/>
<br/> <b><u>Example</u></b>: !play https://www.youtube.com/playlist?list=PLm_7fYxKwa6Ww1bKoPhV79VqxIjB4BZJv
How do I change Rythm's Nickname?: |
<br/> To change Rythm’s nickname in your server you must:
<br/>
<br/> <b>1)</b> <b>Right Click on Rythm</b> > <b> Change Nickname</b> > <b>Save</b>.
<br/>
<br/> Done.
How can I donate to support Rythm?: |
<br/> Love Rythm? Want to support its development? You can do so by becoming a donator today! Plus, you'll also get access to donator-only features along the way!
<br/>
<br/> <b> If you're interested in donating, please visit the following link</b>:
<br/>
<br/> <a href="https://patreon.com/rythm">https://patreon.com/rythm</a>
What do I get if I donate to Rythm?: |
<br/> You can find the list of donator exclusive features on our Patreon!
<br/>
<br/> <a href="https://patreon.com/rythm">https://patreon.com/rythm</a>
Where can I find a list of all Rythm Commands?: |
<br/> You can see a list of commands by typing <b>!help</b> in your server, or by visiting the following link:
<br/>
<br/> <a href="https://rythmbot.co/#commands">https://rythmbot.co/#commands</a>
<br/>
<br/> <b>Note</b>: In order to execute any command, you must type Rythm's prefix followed by the command. The default prefix for Rythm is: <b>!</b>
How can I have a second Rythm in my server?: |
<br/> Due to high demand we have added the ability to add a second Rythm to your server allowing for twice the music.
<br/>
<br/> <b> If you're interested in getting a second Rythm for your server, please visit the following link</b>:
<br/>
<br/> <a href="https://rythmbot.co/rythm2">https://rythmbot.co/rythm2</a>
How do I change the channel where Rythm announces the songs in?: |
<br/> Rythm announces the songs in the same text channel it was originally called from.
<br/>
<br/> If you summon Rythm in channel #general, all Announce Songs messages will appear in that channel.
<br/>
<br/> To change the channel where it’ll show the messages, just <b>!disconnect</b> Rythm from the current channel and <b>!summon</b> it in the channel you want the songs to be announced in.
How can I view more than one page using the queue command?: |
<br/> <b><code>!queue [page number]</code></b>
<br/>
<br/> <b><u>Example</u></b>: !queue 2
<br/>
<br/> For a full list of commands type <b>!help</b> in your server with Rythm in it.
How can I remove all the duplicate songs in the current queue?: |
<br/> To remove duplicates from Rythm's queue you must use the following command:
<br/>
<br/> <b>!removedupes</b>
<br/>
<br/> Rythm should then purge its queue of any duplicate songs.
Why can some normal users access moderative music commands?: |
<br/> Normal users with no special permissions are only allowed to use the <b>!play</b> command to add songs to the queue by default.
<br/> They can also use other commands that don't affect the playing music in any way. Example: <b>!queue</b> and <b>!lyrics</b>.
<br/>
<br/> However, <b>normal users can access ALL music commands when they are alone with Rythm in the voice channel</b>.
<br/> This is because their commands would not affect anyone but themselves.
<br/>
<br/> For more information about users command permissions, refer to the <b>>Roles/Permissions</b> section in this FAQ.
How many votes are needed for a song to be vote skipped?: |
<br/> For a vote skip to take effect, 75% of the voice chat's population need to vote yes.
<br/>
<br/> <b>Here's an example</b>:
<br/>
<br/> Let's assume there are 10 users in a voice chat.
<br/> The threshold for skipping is calculated as 75% of 10 = 7.5, then rounded down, so 7.
<br/> For the vote skip to take effect, you would then need 7 positive votes.
<br/>
<br/> <b>Note: </b> Vote skip will not be active until there are 3 or more people in the voice channel.
<br/> (As with one person, insta-skip is enabled and with two the threshold for skipping is 1).
Limitations/Restrictions:
Can I have 2 Rythms in the same server?: |
<br/> <b> Short answer</b>: <code>Yes.</code>
<br/>
<br/> We now allow you to get a second version of Rythm at:
<br/>
<br/> <a href="https://rythmbot.co/rythm2">https://rythmbot.co/rythm2</a>
Can I change Rythm's profile picture (avatar) in my server?: |
<br/> <b> Short answer</b>: <code>No.</code>
<br/>
<br/> Discord doesn’t allow for users or bots to have a different profile picture per server.
Which sites does Rythm allow?: |
<br/> Rythm currently supports the following audio streaming services:
<br/>
<br/> <b>•</b> YouTube
<br/> <b>•</b> SoundCloud
<br/> <b>•</b> Twitch
<br/> <b>•</b> Vimeo
<br/> <b>•</b> Mixer
Can I adjust the volume for everyone on my server for Rythm?: |
<br/> <b>Short answer</b>: <code>If you donate.</code>
<br/>
<br/> You may set the local volume of Rythm for yourself by selecting Rythm and adjusting the user volume slider as shown below.
<br/>
<br/> <img src="https://i.imgur.com/qd6w5Yd.png" alt="Discord user volume"/>
<br/>
<br/> Rythm uses the default volume for videos when using audio streams, for donators we allow for encoding to change the volume of these audio streams.
<br/> Due to the fact that encoding takes resources and time, this is why we do not roll this feature out to all Rythm users.
<br/>
<br/> For donators the volume command is <b>!volume</b> <code>number</code> <i>(Allowed Values: 1 --> 200)</i>
<br/>
<br/> <b><u>Example</u></b>: !volume 80
Can I make custom commands for Rythm?: |
<br/> <b>Short answer</b>: <code>No.</code>
<br/>
<br/> We do not allow custom commands/aliases, however we do allow for suggestions of aliases to be added.
<br/>
<br/> Use the <code>!aliases</code> command to view all the aliases.
<br/> You can suggest any aliases that you can think of in the <code>#rythm-suggestions</code> channel on the Rythm Bot Discord server.
Can Rythm play 24/7?: |
<br/> <b>Short answer</b>: <code>No.</code>
<br/>
<br/> Rythm is not a 24/7 bot. However, you can host your own bot to access such feature, such as <a href="https://github.com/repulser/moosic">this bot (https://github.com/repulser/moosic)</a>.
Why isn't Rythm open source?: |
<br/> Rythm isn't open source mainly because of the following reasons:
<br/>
<br/> • Rythm's code isn't portable in any sense so the code isn't built for anyone to deploy it.
<br/> • We do not wish for Rythm to become the next bot everyone ends up emulating.
<br/> • We do not want people to rip apart any credit we have from the code and redistributing.
Roles/Permissions:
What users can use what command?: |
<br/> Rythm’s built-in permission system can be divided in the following groups:
<br/>
<br/>
<br/> <b> <u> Normal</b> Users / Users <b>without</b> any special roles</u>:
<br/>
<br/> <b>•</b> Are able to add songs to the list (queue) but can’t remove them.
<br/> <b>•</b> Are able to use commands that don’t interfere with other people’s music. <b>Example</b>: lyrics, np, queue, etc.
<br/> <b>•</b> Can't skip a song without voting.
<br/> <b>•</b> Don’t have access to control the music in any way.
<br/>
<br/>
<br/> <u>Users with a <b>DJ role</b> / <b>Manage Channels</b> permission</u>:
<br/>
<br/> • Have full access to all music commands.
<br/> • Can’t change Rythm’s settings.
<br/>
<br/> <b>Note</b>: If there isn’t a role named "<b>DJ</b>" in your server, one can be created
<br/> with no special permissions assigned and it will still access these features.
<br/>
<br/>
<br/> <u>Users with <b>Manage Server</b> / <b>Administrator</b> permission</u>:
<br/>
<br/> • <b>Manage Server</b>: Users with the Manage Server permission can change Rythm’s settings,
<br/> but are limited to <b>only</b> use the normal user's music commands.
<br/>
<br/> • <b>Administrator</b>: Users with the Administrator permission have full access to all music commands
<br/> and can also change Rythm’s settings.
<br/>
<br/>
<br/>
<br/> *******************************************<b>NOTICE</b>*******************************************:
<br/> If a user is <b>ALONE WITH RYTHM</b> in a voice channel, they <b>WILL</b> have access to <b>ALL</b> music commands
<br/> even if the user has <b>NO ROLES</b> in the server. This is because these commands wouldn't affect anyone
<br/> but the user, as there would be no one else in the voice channel.
<br/>
<br/> If you want all Rythm commands to be only available to people with a specific role, read the next entry in this FAQ.
How can I make Rythm only respond to Admins/specific roles?: |
<br/> In order to make Rythm commands just available to specific roles you need to:
<br/>
<br/>
<br/> <b>1</b>- Make a text channel that can only be <b>seen</b> by users with the <b>specific role</b>.
<br/>
<br/> <b>2</b>- Blacklist <b>all the other text channels</b> in the server with Rythm’s <b>Blacklist</b> function.
<br/>
<br/>
<br/> To blacklist channels use the following command format:
<br/>
<br/> <b>!settings blacklist <code>#channel</code> </b>
<br/>
<br/> <b>Example</b>: !settings blacklist #general
How do I give normal users access to all music commands?: |
<br/> Users with the <b>Manage Channels</b> permission have access to all music commands by <b>default</b>.
<br/> Users with the <b>Manage Server</b> permission <b>don’t</b>.
<br/>
<br/> However, if you wish to give <b>some users</b> access to <b>all music commands</b> without having to give
<br/> them the <b>Manage Channels</b> permission, you can do so by creating a role named <b>DJ</b> in your server and
<br/> assigning it to the users. This role doesn’t need to have any special Discord permissions.
<br/>
<br/> The <b>DJ</b> role has to be assigned manually and <b>cannot</b> be given to all users at once.
<br/>
<br/> <b>Users alone in a voice channel with Rythm will be treated as though they have the DJ role until another user joins the voice channel with them even if they have no roles</b>
<br/>
<br/> <b>Note</b>: Users with the <b>DJ</b> role <b>will not</b> be able to change or modify Rythm's <b>settings</b>.
How can I block music commands in a specific text channel?: |
<br/> To restrict music commands from working in a text channel, you must <b>blacklist</b>
<br/> the channel with Rythm’s <b>Blacklist</b> function.
<br/>
<br/> To blacklist a text channel use the following command format:
<br/>
<br/> <b>!settings blacklist <code>#channel</code></b>
<br/>
<br/> <b>Example</b>: !settings blacklist #general
How can I limit the number of songs that one user can add to the queue?: |
<br/> To restrict Rythm's queue to a specific number of songs per user you must use the settings menu.
<br/>
<br/> To limit the number of songs per user use the following command format:
<br/>
<br/> <b>!settings maxusersongs <code>Number</code>/<code>disable</code></b>
<br/>
<br/> <b>Example</b>: !settings maxusersongs 5
<br/>
<br/> Now any songs added that will be put the queue over this number for a specific user will be blocked.
How can I prevent duplicate songs from being added to the queue?: |
<br/> To restrict duplicates from Rythm's queue you must use the settings menu.
<br/>
<br/> To prevent duplicate songs from being added to the queue use the following command format:
<br/>
<br/> <b>!settings preventduplicates <code>on</code>/<code>off</code></b>
<br/>
<br/> <b>Example</b>: !settings preventduplicates on
<br/>
<br/> Now any songs added to the queue that are already in the queue will be blocked.
How can I limit the number of songs that can be added to the queue?: |
<br/> To restrict Rythm's queue to a specific number of songs you must use the settings menu.
<br/>
<br/> To limit the number of songs use the following command format:
<br/>
<br/> <b>!settings maxqueuelength <code>Number</code></b>
<br/>
<br/> <b>Example</b>: !settings maxqueuelength 25
<br/>
<br/> Now any songs added that will put the queue over this number will be blocked.
How do I restrict Rythm from joining a voice channel?: |
<br/>To block Rythm from joining a specific voice channel you must:
<br/>
<br/>
<br/> <b>1</b>) Go to your Discord <b>Server Settings</b> > <b>Roles</b>.
<br/>
<br/> <b>2</b>) Find the role that belongs to <b>Rythm</b>.
<br/>
<br/> <b>3</b>) Turn <b>OFF</b> the Administrator permission for Rythm.
<br/>
<br/> <b>4</b>) Turn <b>ON</b> Read Text Channels & See Voice Channels, Send Messages, Embed Links, Connect and Speak Permissions.
<br/>
<br/> <b>5</b>) Go to the voice channel you want to <b>restrict</b> Rythm from connecting to.
<br/>
<br/> <b>6</b>) Click <b>Edit channel</b> > <b>Permissions</b> > <b>Rythm Role</b>.
<br/>
<br/> <b>7</b>) Turn <b>OFF</b> the "Connect" permission for the Rythm role. Save.
<br/>
<br/> Done.
<br/>
<br/> <b>Note</b>: To blacklist multiple channels, just repeat steps 5 to 7
<br/> separately with all the voice channels you wish to blacklist.
Settings:
Intro: |
<br/> <strong> These are the options you can access through Rythm’s settings menu. </strong>
<br/>
<br/> To access this menu use the command <b>!settings</b>
<br/>
<br/> Rythm should then display a menu showing the settings that can be changed.
<br/>
<br/> For more information on a setting just type: <b>!settings</b> <code>Setting Name</code>
<br/>
<br/> <b><u>Example</u></b>: !settings blacklist
<br/>
<br/> Any setting marked with an asterisk <code>*</code> is donator exclusive.
Rythm Prefix: |
<br/> <b><u>Changing Rythm’s prefix</u></b>
<br/>
<br/> Makes Rythm respond to a different prefix.
<br/>
<br/> <u>Command format</u> <b>!settings prefix</b> <code>NewPrefix</code>
<br/>
<br/> <b><u>Example</u></b>: !settings prefix +
Text Channel Blacklist: |
<br/> <b><u>Blacklisting text channels</u></b>
<br/>
<br/> By blacklisting a text channel, you make it impossible for anyone to access music commands through that channel.
<br/>
<br/> <u>Command format</u> <b>!settings blacklist</b> <code>#channel</code>
<br/>
<br/> <b>Note</b>: You can blacklist multiple channels at once.
<br/> <b><u>Example</u></b>: !settings blacklist <code>#channel1 #channel2</code>
<br/>
<br/> <b>Note</b>: To "Whitelist" a text channel and put it back to normal, just run the Blacklist command on it again.
Announcing Songs: |
<br/> <b><u>Turning On/Off Announcesongs</u> </b>
<br/>
<br/> Sends a message to a text channel announcing every song when they start.
<br/>
<br/> <u>Command format</u> <b>!settings announcesongs</b> <code>on/off</code>
<br/>
<br/> <b><u>Example</u></b>: !settings announcesongs on
Queue Length Limit: |
<br/> <b><u>Limiting queue length</u></b>
<br/>
<br/> Limits the max number of songs the queue can hold before refusing to allow users to add any more.
<br/>
<br/> <u>Command format</u> <b>!settings maxqueuelength</b> <code>Number</code>/<code>disable</code>
<br/>
<br/> <b><u>Example</u></b>: !settings maxqueuelength 25
User Songs Limit: |
<br/> <b><u>Limiting the amount of songs a single user can request</u></b>
<br/>
<br/> Limits how many songs the user can queue at one time, can be disabled by typing <code>disable</code> instead of a number.
<br/>
<br/> <u>Command format</u> <b>!settings maxusersongs</b> <code>Number</code>/<code>disable</code>
<br/>
<br/> <b><u>Example</u></b>: !settings maxusersongs 5
Duplicate Song Removal: |
<br/> <b><u>Getting Rythm to automatically remove duplicate songs</u></b>
<br/>
<br/> Prevents users from adding songs to the queue that are already in the current queue.
<br/>
<br/> <u>Command format</u> <b>!settings preventduplicates</b> <code>on</code>/<code>off</code>
<br/>
<br/> <b><u>Example</u></b>: !settings preventduplicates on
DJ Only Mode: |
<br/> <b><u>Enabling DJ only mode</u></b>
<br/>
<br/> Sets the server to run in DJ only mode, allowing only users with the DJ role or the Manage Channels permission to use Rythm's music commands.
<br/>
<br/> <u>Command format</u> <b>!settings djonly</b> <code>on</code>/<code>off</code>
<br/>
<br/> <b><u>Example</u></b>: !settings djonly on
Setting a custom DJ role: |
<br/> <b><u>Setting a custom DJ role</u></b>
<br/>
<br/> Sets a custom role to work as DJ with Rythm.
<br/>
<br/> <u>Command format</u> <b>!settings setdj</b> <code>role-name</code>
<br/>
<br/> <b><u>Example</u></b>: !settings setdj Admin
<br/>
<br/> <b>Important</b>: Do <b>NOT</b> mention the role, its name must be typed out.
<br/>
<br/> <b>Note</b>: Any role called "DJ" will still act as a DJ role.
DJPlaylists: |
<br/> <b><u>Enabling DJ Playlists</u></b>
<br/>
<br/> When enabled only DJ's are able to queue playlists.
<br/>
<br/> <u>Command format</u> <b>!settings djplaylists</b> <code>on</code>/<code>off</code>
<br/>
<br/> <b><u>Example</u></b>: !settings djplaylists on
<br/>
Autoplay*: |
<br/> <b><u>Enabling/Disabling autoplay</u>*</b>
<br/>
<br/> <b>Autoplay feature</b> once setup with your own playlist,
<br/> Rythm will queue songs from it once the queue is empty.
<br/>
<br/> <u>Command format</u> <b>!settings autoplay</b> <code>URL/disable</code>
<br/>
<br/> <b><u>Example</u></b>: !settings autoplay https://www.youtube.com/watch?v=P2l0lbn5TVg&list=PL2788304DC59DBEB4
<br/>
<br/> <b>Note</b>: This feature is donator exclusive.
Server Default Volume*: |
<br/> <b><u>Setting Rythm's default volume</u>*</b>
<br/>
<br/> Sets the default volume for Rythm when joining a channel after being summoned.
<br/>
<br/> <u>Command format</u> <b>!settings defaultvolume</b> <code>Number</code>
<br/>
<br/> <b><u>Example</u></b>: !settings defaultvolume 80
<br/>
<br/> <b>Note</b>: This feature is donator exclusive.
Links:
I have encountered an issue with Rythm: |
<br/> If you find that you have encountered an issue with Rythm, please <a href="https://rythmbot.co/troubleshooting/">click here to go to the Troubleshooting page</a>.
None of this helped me with my problem: |
<br/> If you find that your question was not answered by this FAQ or the Troubleshooting page, please <a href="https://rythmbot.co/support">click here to join the official Rythm Bot Discord server</a>.