Guest User

Untitled

a guest
Oct 24th, 2019
2,163
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 8.43 KB | None | 0 0
  1. ## Custom commands
  2.  
  3. >>nosound
  4. - **If the bot's speaking light is active, but there is no sound, try these:**
  5. ```md
  6. 1. Is the bot's user volume turned up? (right click on the bot in discord, see the slider)
  7. 2. Is the bot muted or deafened? Are you deafened? Are you deaf?
  8. 3. Check Discord audio device settings and volume (cog icon next to your username in the bottom left, click "Voice and Video")
  9. 4. Check system audio device settings and volume
  10. 5. Ask another member to come into the voice channel to confirm that it's not just you
  11. ```- **If the track progress is stuck on 00:00 when you run `[p]now`:**```md
  12. 1. Try to run [p]disconnect and replay the song
  13. 2. Try to reload the audio cog with [p]reload audio
  14. 3. Try to restart your bot with [p]restart
  15. 4. Try to restart your host machine
  16. ```- **If all else fails copy the contents of your spring.log/lavalink.log file; post it on gist, pastebin, hastebin, etc** and send the link in <#387398816317440000>:```md
  17. - It can be found in: <datapath>/cogs/Audio/logs/
  18. -- Use [p]datapath to find out what your <datapath>
  19. ```
  20.  
  21.  
  22. >audiolag
  23. - **Laggy audio is most likely a problem with the connection between the host machine of your bot to the discord server** (or discord is wonking out)**, try these**:
  24. ```md
  25. 1. Wait
  26. 2. Try restarting your bot
  27. 3. Check to make sure it's not just a bad quality song (try a different song)
  28. 4. Try a different server region
  29. 5. Try hosting your bot elsewhere
  30. 6. If not everyone is experiencing the issue, it's a discord client issue.
  31. ```
  32. There is a known issue with the desktop discord client causing audio playback issues. If you listen from the discord web browser you should hear significant quality improvements.
  33.  
  34.  
  35. >ll
  36. The logs from Lavalink may be useful here:
  37. - **If all else fails copy the contents of your spring.log/lavalink.log file; post it on gist, pastebin, hastebin, etc** *and send the link here*
  38. ```md
  39. - They can be found in: <datapath>/cogs/Audio/logs/
  40. - Use [p]datapath to find out what your <datapath>
  41. ```
  42.  
  43. >lldownload
  44. - **To manually download the jar:**
  45. ```md
  46. 1. Stop your bot
  47. 2. Go to https://github.com/Cog-Creators/Lavalink-Jars/releases/tag/3.2.1_823
  48. 3. Download the Lavalink.jar file
  49. ```- **If you are not running an external instance of Lavalink**:```md
  50. 1. Stop your bot by running [p]shutdown
  51. 2. Move Lavalink.jar to your <datapath> /cogs/Audio/ folder
  52. 3. Start your bot
  53. -- Use [p]datapath to find out what your <datapath>
  54. ```- ** If you are running an external instance of Lavalink:**```md
  55. 1. Stop all instances of Red running on host.
  56. 2. Stop the Lavalink process
  57. 3. Move Lavalink.jar to where your old Lavalink.jar is located
  58. 4. Start up the new Lavalink.jar with "java -jar Lavalink.jar"
  59. 5. Start up your bots
  60. ```
  61.  
  62.  
  63. >localtracks
  64. - **Red 3.2**
  65. ```md
  66. 1. Create a "localtracks" folder anywhere where Lavalink has permissions to access
  67. 2. Create/move/copy/symblink your album folders (Sub folders containing your tracks) to the folder created in step 1
  68. 3. Put ogg, mp3, or flac files in those folders:
  69. -- localtracks/<parent folder>/song.mp3
  70. -- localtracks/<parent folder>/<child folder>/song.mp3
  71. - Use [p]local commands and interact with the menu reactions to play songs
  72. - Use [p]play <parent folder>/song.mp3 for single songs
  73. - Use [p]local folder <parent folder>/<child folder> to play the whole folder
  74.  
  75. -- Use [p]datapath to find out what your <datapath>
  76.  
  77. Note: /* Localtracks needs to be on the same machine as your bot AND the Lavalink.jar*
  78.  
  79. ```
  80.  
  81. >multibots
  82. - **You will need to run an enternal instance of Lavalink**
  83. ```md
  84. 1. Stop all Red bots
  85. a) Start Bot 1
  86. b) Run command [p]llset external
  87. c) Stop Bot 1
  88. -- Repeat step 1.a through to 1.c for each additional bot
  89. 2. Open a command prompt/terminal window
  90. 3. Navigate to <datapath>/cogs/Audio (doesn't matter which bot as all your bots will now use this single instance of lavalink)
  91. 4. Run command "java -jar Lavalink.jar"
  92. 5. Leave this window open (you will need to do this every time you want to start Lavalink for your bots)
  93. 6. Once Lavalink says it has fully started, you can start your bots back up
  94.  
  95. -- Use [p]datapath to find out what your <datapath>
  96. ```
  97.  
  98.  
  99. >redautorestart
  100. https://docs.discord.red/en/stable/autostart_systemd.html
  101.  
  102.  
  103. >llautorestart
  104. - **Lavalink** - *For external instances **only***
  105. Run *`sudo -e /etc/systemd/system/lavalink.service`* and put the following inside of it.
  106. ```md
  107. [Unit]
  108. Description=lavalink
  109. After=multi-user.target
  110.  
  111. [Service]
  112. ExecStart= < Jar executable path > -jar < Lavalink path >/Lavalink.jar
  113. User=< username >
  114. Group=< username >
  115. Type=idle
  116. Restart=always
  117. RestartSec=15
  118.  
  119. [Install]
  120. WantedBy=multi-user.target
  121. ```**Variables**```md
  122. < Jar executable path > -- You can find your Java path by running "which java"
  123. < Lavalink path > -- Parent folder where your Lavalink executable can be located (usually in <datapath>/cogs/Audio)
  124. < username > -- Username on host machine, often the output of: 'echo "$USER"'
  125.  
  126. -- Use [p]datapath to find out what your <datapath>
  127. ```
  128. **Run the following:**
  129. - *`sudo systemctl start lavalink`* - This will start the service
  130. - *`sudo systemctl enable lavalink`* - This will allow the service to auto start after a reboot
  131. - *`sudo journalctl -u lavalink`* - This will allow you to read the logs for the service
  132.  
  133.  
  134. >spotify
  135. Audio V3+ supports playing spotify tracks by using the **YouTube Data API** and **Spotify API** and will be required to obtain authentication for those services if you wish to use this feature.
  136.  
  137. **Please note the following:**
  138. `The following is not permitted for any reason whatsoever: copying, redistributing, reproducing, “ripping”, recording, transferring, performing or displaying to the public, broadcasting, or making available to the public any part of the Spotify Service or the Content... [and] “crawling” the Spotify Service or otherwise using any automated means (including bots, scrapers, and spiders) to collect information from Spotify`
  139. <https://www.spotify.com/us/legal/end-user-agreement/>
  140.  
  141. **As such we will never support direct play from Spotify**.
  142.  
  143.  
  144. >audiocache
  145. **Red 3.2 support a local cache**, these allows you to reduce repeated API calls to the YouTube Data and Lavalink APIs.
  146. ```md
  147. 1. [p]audioset cache < level >
  148. - Will set the active cacheing
  149. - Run [p]help audioset cache to see what the supported values are.
  150. 2. [p]audioset cacheage < age in days >
  151. - Will tell the bot how many days a cache entry is valid for
  152. - If an entry is invalid, then the bot will call the API next time this track is requested.
  153. ```
  154.  
  155. >playlists
  156. **Red 3.2 supports multiple types of playlists**, they are as follows:
  157. ```md
  158. < Global Playlist >
  159. - These playlists will be available in all servers the bot is in.
  160. - These can be managed by the Bot Owner only.
  161.  
  162. < Server Playlist >
  163. - These playlists will only be available in the server they were created in.
  164. - These can be managed by the Bot Owner, Guild Owner, Mods, Admins, DJs and creator (if DJ role is disabled).
  165.  
  166. < User Playlist >
  167. - These playlists will be available in all servers both the bot and the creator are in
  168. - These can be managed by the Bot Owner and Creator only
  169.  
  170. ```**Argument Parsing**
  171. *Due to the complexity added by these, we had to implement an new format of arguments for all commands that touch bot playlists.*```md
  172. < New command format >
  173. - [p]playlist start playlist_name_OR_id [args]
  174.  
  175. - Args are optional and if not used it will default to < Server Playlist > (same behaviour pre-3.2), they are the following:
  176. 1. --scope <scope>
  177. 2. --author [user]
  178. 3. --guild [guild]
  179.  
  180. - <scope> can be one of following:
  181. 1. Global - to access < Global Playlist >
  182. 2. Server - to access < Server Playlist >
  183. 3. User - to access < User Playlist >
  184.  
  185. - [user] can be the following:
  186. 1. User ID
  187.  
  188. - [guild] can be the following:
  189. 1. Guild ID
  190. 2. Exact guild name
  191. ```**Usage**```md
  192. 1. [p]playlist start <playlist_name_OR_id> --scope Global
  193. - Will start a < Global Playlist >
  194.  
  195. 2. [p]playlist start <playlist_name_OR_id> --scope Server --guild 133049272517001216
  196. - Will start a < Server Playlist > that exists in server 133049272517001216
  197.  
  198. 3. [p]playlist start <playlist_name_OR_id> --scope User --author 208903205982044161
  199. - Will start a < User Playlist > that eas created by 208903205982044161
  200.  
  201. 4. [p]playlist list --scope Server --guild 133049272517001216 --author 208903205982044161
  202. - Will list all < Server Playlist > created by user 208903205982044161 in server 133049272517001216
  203. ```
Advertisement
Add Comment
Please, Sign In to add comment