# Full Playlist URL
+# Full Playlist URL
+ !play https://www.youtube.com/playlist?list=PLUib4KwT0DMJaPgg_nr1ia8FY5JcXksvb
-# Playlist ID
+# Playlist ID
+ !play PLUib4KwT0DMJaPgg_nr1ia8FY5JcXksvb
-# Not a Playlist link! (notice the `watch?v=`)
+# Not a Playlist link! (notice the `watch?v=`)
- !play https://www.youtube.com/watch?v=bd2B6SjMh_w&list=PLUib4KwT0DMJaPgg_nr1ia8FY5JcXksvb&index=4
📃 Local Playlists
diff --git a/running-as-a-service/index.html b/running-as-a-service/index.html
index aa4e5cf94..d4f774773 100644
--- a/running-as-a-service/index.html
+++ b/running-as-a-service/index.html
@@ -14,7 +14,7 @@
-
+
diff --git a/search/search_index.json b/search/search_index.json
index 05c5ecef7..7f95722d1 100644
--- a/search/search_index.json
+++ b/search/search_index.json
@@ -1 +1 @@
-{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Welcome to the JMusicBot wiki! # \ud83d\udd22 Setup \u23f0 24/7 Hosting \ud83d\udcc3 Playlists \ud83d\udcdc Full Command Reference \u26a0 Troubleshooting \ud83d\udce5 Support Server Features # Easy to run (just make sure Java is installed, and run!) Fast loading of songs No external keys needed (besides a Discord Bot token) Smooth playback Server-specific setup for the \"DJ\" role that can moderate the music Clean and beautiful menus Supports many sites, including Youtube, Soundcloud, and more Supports many online radio/streams Supports local files Playlist support (both web/youtube, and local) Supported sources and formats # JMusicBot supports all sources and formats supported by lavaplayer : Sources # YouTube SoundCloud Bandcamp Vimeo Twitch streams Local files HTTP URLs Formats # MP3 FLAC WAV Matroska/WebM (AAC, Opus or Vorbis codecs) MP4/M4A (AAC codec) OGG streams (Opus, Vorbis and FLAC codecs) AAC streams Stream playlists (M3U and PLS) Example # Setup # Please see the Setup Page in the wiki to run this bot yourself!","title":"Home"},{"location":"#welcome-to-the-jmusicbot-wiki","text":"\ud83d\udd22 Setup \u23f0 24/7 Hosting \ud83d\udcc3 Playlists \ud83d\udcdc Full Command Reference \u26a0 Troubleshooting \ud83d\udce5 Support Server","title":"Welcome to the JMusicBot wiki!"},{"location":"#features","text":"Easy to run (just make sure Java is installed, and run!) Fast loading of songs No external keys needed (besides a Discord Bot token) Smooth playback Server-specific setup for the \"DJ\" role that can moderate the music Clean and beautiful menus Supports many sites, including Youtube, Soundcloud, and more Supports many online radio/streams Supports local files Playlist support (both web/youtube, and local)","title":"Features"},{"location":"#supported-sources-and-formats","text":"JMusicBot supports all sources and formats supported by lavaplayer :","title":"Supported sources and formats"},{"location":"#sources","text":"YouTube SoundCloud Bandcamp Vimeo Twitch streams Local files HTTP URLs","title":"Sources"},{"location":"#formats","text":"MP3 FLAC WAV Matroska/WebM (AAC, Opus or Vorbis codecs) MP4/M4A (AAC codec) OGG streams (Opus, Vorbis and FLAC codecs) AAC streams Stream playlists (M3U and PLS)","title":"Formats"},{"location":"#example","text":"","title":"Example"},{"location":"#setup","text":"Please see the Setup Page in the wiki to run this bot yourself!","title":"Setup"},{"location":"adding-your-bot/","text":"Don't have an application? If you don't have a bot application created, please reference Getting a Bot Token for how to set one up! Navigate to the Applications page and select one of your bot applications. In the Settings list, select OAuth2 . In the Scopes section, check Bot . Click Copy to copy the OAuth2 URL to your clipboard. Paste the link into your browser. Select a server from the drop-down menu and then click Authorize . You must have the Manage Server permission to add a bot to a server! If no servers appear, you may need to log in . Troubleshooting # If you get a \"Requires Code Grant\" error, make sure that this box is unchecked on your application: If you want to generate the link manually, replace the CLIENTID in the following link with your bot's client ID: https://discordapp.com/oauth2/authorize?client_id=CLIENTID&scope=bot","title":"Adding Your Bot To Your Server"},{"location":"adding-your-bot/#troubleshooting","text":"If you get a \"Requires Code Grant\" error, make sure that this box is unchecked on your application: If you want to generate the link manually, replace the CLIENTID in the following link with your bot's client ID: https://discordapp.com/oauth2/authorize?client_id=CLIENTID&scope=bot","title":"Troubleshooting"},{"location":"advanced-config/","text":"Specify a different config file # Setting a different file to use as the config file is possible via the -Dconfig=/path/to/config.file command-line option. For example: java -Dconfig = alternate_config.txt -jar JMusicBot.jar will run the bot, loading from alternate_config.txt instead of config.txt . Specify config options from the command line # Similar to the -Dconfig option, any setting in the config file can also be set from the command line. For example, to set the prefix from the command line (instead of from the config), you would use -Dprefix=\"!!\" (values need to be quoted if they contain spaces or some special characters). For example: java -Dprefix = \"!\" -jar JMusicBot.jar Specify config options from environment variables # To use environment variables for the config, there are two options. For the following examples, assume that a prefix has been set to the environment variable CUSTOM_PREFIX . From the command line # To use environment variables from the command line, use the same system from above, but substitute in a resolved variable name. For example: java -Dprefix = \" $CUSTOM_PREFIX \" -jar JMusicBot.jar In the config file # To use an environment in the config file, specify it as follows // this is in the config file prefix = ${CUSTOM_PREFIX}","title":"Advanced Config Options"},{"location":"advanced-config/#specify-a-different-config-file","text":"Setting a different file to use as the config file is possible via the -Dconfig=/path/to/config.file command-line option. For example: java -Dconfig = alternate_config.txt -jar JMusicBot.jar will run the bot, loading from alternate_config.txt instead of config.txt .","title":"Specify a different config file"},{"location":"advanced-config/#specify-config-options-from-the-command-line","text":"Similar to the -Dconfig option, any setting in the config file can also be set from the command line. For example, to set the prefix from the command line (instead of from the config), you would use -Dprefix=\"!!\" (values need to be quoted if they contain spaces or some special characters). For example: java -Dprefix = \"!\" -jar JMusicBot.jar","title":"Specify config options from the command line"},{"location":"advanced-config/#specify-config-options-from-environment-variables","text":"To use environment variables for the config, there are two options. For the following examples, assume that a prefix has been set to the environment variable CUSTOM_PREFIX .","title":"Specify config options from environment variables"},{"location":"advanced-config/#from-the-command-line","text":"To use environment variables from the command line, use the same system from above, but substitute in a resolved variable name. For example: java -Dprefix = \" $CUSTOM_PREFIX \" -jar JMusicBot.jar","title":"From the command line"},{"location":"advanced-config/#in-the-config-file","text":"To use an environment in the config file, specify it as follows // this is in the config file prefix = ${CUSTOM_PREFIX}","title":"In the config file"},{"location":"advanced-eval/","text":"Danger Please remember that the eval command is potentially dangerous; it is locked to the bot owner, but never run a script unless you know what it does! The following are examples of scripts that can be run via the eval command (bot owner only). If your bot's prefix is set to !! and you've enabled the eval command, an eval (such as the first one listed below) is run like !!eval jda.guilds List all servers that the bot is on # jda . guilds Leave a specific server # jda . getGuildById ( \"GUILDIDHERE\" ). leave (). queue ()","title":"Advanced Eval Scripts"},{"location":"advanced-eval/#list-all-servers-that-the-bot-is-on","text":"jda . guilds","title":"List all servers that the bot is on"},{"location":"advanced-eval/#leave-a-specific-server","text":"jda . getGuildById ( \"GUILDIDHERE\" ). leave (). queue ()","title":"Leave a specific server"},{"location":"advanced-playlists/","text":"This page describes how to generate playlist (txt) files from folders. These examples assume that your songs are in mp3 format; if you are using a different format, replace mp3 with your format in all provided commands. Windows (Desktop) # Open Powershell in the folder with your songs (you can Shift-Right-Click and select Open Powershell Window Here from within an Explorer window) Run Get-ChildItem . -Filter *.mp3 -Recurse | % { $_.FullName } | out-file -encoding ASCII songs.txt Move songs.txt to your Playlists folder and rename it to whatever you want the playlist to be called. Edit songs.txt if you want to add additional songs or any other comments Linux (Command Line) # Navigate to the folder with yours songs ( cd /path/to/the/folder ) Run find \"$(pwd)\" | grep \".mp3\" > songs.txt Move songs.txt to your Playlists folder and rename it ( mv songs.txt /path/to/Playlists/playlistname.txt )","title":"Advanced Playlist Generation"},{"location":"advanced-playlists/#windows-desktop","text":"Open Powershell in the folder with your songs (you can Shift-Right-Click and select Open Powershell Window Here from within an Explorer window) Run Get-ChildItem . -Filter *.mp3 -Recurse | % { $_.FullName } | out-file -encoding ASCII songs.txt Move songs.txt to your Playlists folder and rename it to whatever you want the playlist to be called. Edit songs.txt if you want to add additional songs or any other comments","title":"Windows (Desktop)"},{"location":"advanced-playlists/#linux-command-line","text":"Navigate to the folder with yours songs ( cd /path/to/the/folder ) Run find \"$(pwd)\" | grep \".mp3\" > songs.txt Move songs.txt to your Playlists folder and rename it ( mv songs.txt /path/to/Playlists/playlistname.txt )","title":"Linux (Command Line)"},{"location":"commands/","text":"This page contains the full list of commands. These commands (and descriptions) can also be seen via the help command. Tip Arguments surrounded by <> are required, and arguments surrounded by [] are optional. Do not include <> nor [] when running commands! \ud83d\udcdc General Commands # These commands are just general-use commands to see information about the bot about # Shows basic information about the bot, including its library, framework, and some statistics ping # Shows the latency between the bot and Discord. In general, 80-250ms is a normal value. settings # Shows the settings for the current server. This includes Text Channel, Voice Channel, DJ Role, and Default Playlist. This command also shows the number of servers the bot is on, and how many audio connections there currently are. \ud83d\udcdc Music Commands # These commands are related to playing music, available to all users. If a TextChannel is set, these commands can only be used in that channel. lyrics [song name] # Fetches the lyrics for the provided song name, or the currently-playing song if no name is provided nowplaying (or np or current ) # Shows information about the song that is currently playing (name, user that added it, current timestamp, and song URL) play # Shows the play commands. If the player is paused, it resumes the player. play # Plays the song or stream at the provided URL. Supported locations include (but are not limited to): YouTube (and playlists), SoundCloud, BandCamp, Vimeo, and Twitch. Local files or URLs of the following formats are also supported: MP3, FLAC, WAV, Matroska/WebM (AAC, Opus or Vorbis codecs), MP4/M4A (AAC codec), OGG streams (Opus, Vorbis and FLAC codecs), AAC streams, Stream playlists (M3U and PLS) play # Plays the top YouTube result for the specified song name play playlist (or play pl ) # Plays all songs in the specified playlist. There must already be a playlist of the specified name in the Playlists folder playlists # Shows available playlists. These playlists must be inside the Playlists folder. queue [pagenum] (or list [pagenum] ) # Shows songs in the queue. If no page number is provided, it defaults to the first page. remove (or delete ) # Removes the song at the provided position in the queue. You can only remove songs that you added, unless you are an Admin or have the specified DJ role. remove all (or delete all ) # Removes all songs that you have added to the queue search (or ytsearch ) # Shows the top YouTube results for a search and allows you to select one to add to the queue scsearch # Shows the top SoundCloud results for a search and allows you to select one to add to the queue shuffle # Shuffles (changes the order, randomly) of songs that you have added to the queue skip (or voteskip ) # Skips a song if you added it. If you didn't add it, it adds your vote to skip it. Approximately 60% of active listeners need to vote to skip a song for it to be skipped. \ud83d\udcdc DJ Commands # All Admins can automatically use DJ commands. Admins can also assign one server role to be the \"DJ role,\" which allows anyone with that role to use these commands as well. forceremove (or forcedelete or modremove or moddelete ) # Forcibly removes all songs that were added by the specified user forceskip (or modskip ) # Forcibly skips the current song, regardless of who added it and how many votes there are to skip it movetrack (or move ) # Moves the track at position in the queue to position pause # Pauses the player. The player remains paused until a DJ or Admin uses the play command playnext # Places a single song at the front of the queue to play next (or begins playing if nothing is currently playing) repeat [on | off] # Puts the player in (or takes it out of) repeat mode. In repeat mode, when songs end naturally (not removed or skipped), they get put back into the queue. skipto # Skips forward in the queue to the provided song number, playing that song and removing any songs before that from the queue stop # Clears the queue, ends the current song, and leaves the voice channel volume [0-150] (or vol [0-150] ) # Shows or sets the current volume. For best performance, it is recommended to leave this at 100 and adjust volume on an individual basis within Discord \ud83d\udcdc Admin Commands # Admin commands can be used by anyone with the Manage Server permission. prefix # Sets the server-specific prefix prefix none # Clears the server-specific prefix setdj # Sets the DJ role. Users with this role will be able to use DJ commands. setdj none # Clears the DJ role. Only Admins will be able to use the DJ commands. settc # Sets the text channel for music commands. Using music commands in other channels will result in them being deleted (if possible), and a warning sent via DMs to use the correct channel. Additionally, if the bot has the Manage Channel permission in the set channel, it will adjust the topic to show the current track. settc none # Clears the text channel setvc # Sets the voice channel for playing music. When set, the bot will only connect to the specified channel when users attempt to play music. setvc none # Clears the voice channel for playing music. This means that users can play music from any channel that the bot can connect to (if the bot is not already in a different channel) \ud83d\udcdc Owner Commands # These commands can only be used by the bot owner (set in the config) autoplaylist # Sets the default playlist for the server, which plays when the queue is empty and when the bot starts up (identical to playlist setdefault ) debug # Generates a file containing debug information playlist append - | [item] | [item]... # Adds items to an existing playlist. Items must be urls. To add a YouTube search, it must be in the form \"ytsearch:query\". For a SoundCloud search, use \"scsearch:query\". playlist delete # Deletes the playlist file for a playlist playlist make # Creates a new, empty playlist playlist setdefault # Sets the default playlist for the server, which plays when the queue is empty and when the bot starts up playlist setdefault none # Clears the default playlist setavatar # Sets the avatar of the bot setgame [game] # Sets the game the bot is playing setgame stream # Sets the game the bot is \"streaming\" setname # Sets the username of the bot setstatus # Sets the status of the bot (online, idle, dnd, invisible) shutdown # Safely shuts down","title":"Commands"},{"location":"commands/#general-commands","text":"These commands are just general-use commands to see information about the bot","title":"\ud83d\udcdc General Commands"},{"location":"commands/#about","text":"Shows basic information about the bot, including its library, framework, and some statistics","title":"about"},{"location":"commands/#ping","text":"Shows the latency between the bot and Discord. In general, 80-250ms is a normal value.","title":"ping"},{"location":"commands/#settings","text":"Shows the settings for the current server. This includes Text Channel, Voice Channel, DJ Role, and Default Playlist. This command also shows the number of servers the bot is on, and how many audio connections there currently are.","title":"settings"},{"location":"commands/#music-commands","text":"These commands are related to playing music, available to all users. If a TextChannel is set, these commands can only be used in that channel.","title":"\ud83d\udcdc Music Commands"},{"location":"commands/#lyrics-song-name","text":"Fetches the lyrics for the provided song name, or the currently-playing song if no name is provided","title":"lyrics [song name]"},{"location":"commands/#nowplaying-or-np-or-current","text":"Shows information about the song that is currently playing (name, user that added it, current timestamp, and song URL)","title":"nowplaying (or np or current)"},{"location":"commands/#play","text":"Shows the play commands. If the player is paused, it resumes the player.","title":"play"},{"location":"commands/#play-url","text":"Plays the song or stream at the provided URL. Supported locations include (but are not limited to): YouTube (and playlists), SoundCloud, BandCamp, Vimeo, and Twitch. Local files or URLs of the following formats are also supported: MP3, FLAC, WAV, Matroska/WebM (AAC, Opus or Vorbis codecs), MP4/M4A (AAC codec), OGG streams (Opus, Vorbis and FLAC codecs), AAC streams, Stream playlists (M3U and PLS)","title":"play <URL>"},{"location":"commands/#play-song-name","text":"Plays the top YouTube result for the specified song name","title":"play <song name>"},{"location":"commands/#play-playlist-playlistname-or-play-pl-playlistname","text":"Plays all songs in the specified playlist. There must already be a playlist of the specified name in the Playlists folder","title":"play playlist <playlistname> (or play pl <playlistname>)"},{"location":"commands/#playlists","text":"Shows available playlists. These playlists must be inside the Playlists folder.","title":"playlists"},{"location":"commands/#queue-pagenum-or-list-pagenum","text":"Shows songs in the queue. If no page number is provided, it defaults to the first page.","title":"queue [pagenum] (or list [pagenum])"},{"location":"commands/#remove-songnum-or-delete-songnum","text":"Removes the song at the provided position in the queue. You can only remove songs that you added, unless you are an Admin or have the specified DJ role.","title":"remove <songnum> (or delete <songnum>)"},{"location":"commands/#remove-all-or-delete-all","text":"Removes all songs that you have added to the queue","title":"remove all (or delete all)"},{"location":"commands/#search-query-or-ytsearch-query","text":"Shows the top YouTube results for a search and allows you to select one to add to the queue","title":"search <query> (or ytsearch <query>)"},{"location":"commands/#scsearch-query","text":"Shows the top SoundCloud results for a search and allows you to select one to add to the queue","title":"scsearch <query>"},{"location":"commands/#shuffle","text":"Shuffles (changes the order, randomly) of songs that you have added to the queue","title":"shuffle"},{"location":"commands/#skip-or-voteskip","text":"Skips a song if you added it. If you didn't add it, it adds your vote to skip it. Approximately 60% of active listeners need to vote to skip a song for it to be skipped.","title":"skip (or voteskip)"},{"location":"commands/#dj-commands","text":"All Admins can automatically use DJ commands. Admins can also assign one server role to be the \"DJ role,\" which allows anyone with that role to use these commands as well.","title":"\ud83d\udcdc DJ Commands"},{"location":"commands/#forceremove-user-or-forcedelete-user-or-modremove-user-or-moddelete-user","text":"Forcibly removes all songs that were added by the specified user","title":"forceremove <user> (or forcedelete <user> or modremove <user> or moddelete <user>)"},{"location":"commands/#forceskip-or-modskip","text":"Forcibly skips the current song, regardless of who added it and how many votes there are to skip it","title":"forceskip (or modskip)"},{"location":"commands/#movetrack-from-to-or-move-from-to","text":"Moves the track at position in the queue to position","title":"movetrack <from> <to> (or move <from> <to>)"},{"location":"commands/#pause","text":"Pauses the player. The player remains paused until a DJ or Admin uses the play command","title":"pause"},{"location":"commands/#playnext-song-name-url","text":"Places a single song at the front of the queue to play next (or begins playing if nothing is currently playing)","title":"playnext <song name | URL>"},{"location":"commands/#repeat-on-off","text":"Puts the player in (or takes it out of) repeat mode. In repeat mode, when songs end naturally (not removed or skipped), they get put back into the queue.","title":"repeat [on | off]"},{"location":"commands/#skipto-position","text":"Skips forward in the queue to the provided song number, playing that song and removing any songs before that from the queue","title":"skipto <position>"},{"location":"commands/#stop","text":"Clears the queue, ends the current song, and leaves the voice channel","title":"stop"},{"location":"commands/#volume-0-150-or-vol-0-150","text":"Shows or sets the current volume. For best performance, it is recommended to leave this at 100 and adjust volume on an individual basis within Discord","title":"volume [0-150] (or vol [0-150])"},{"location":"commands/#admin-commands","text":"Admin commands can be used by anyone with the Manage Server permission.","title":"\ud83d\udcdc Admin Commands"},{"location":"commands/#prefix-prefix","text":"Sets the server-specific prefix","title":"prefix <prefix>"},{"location":"commands/#prefix-none","text":"Clears the server-specific prefix","title":"prefix none"},{"location":"commands/#setdj-rolename","text":"Sets the DJ role. Users with this role will be able to use DJ commands.","title":"setdj <rolename>"},{"location":"commands/#setdj-none","text":"Clears the DJ role. Only Admins will be able to use the DJ commands.","title":"setdj none"},{"location":"commands/#settc-channel","text":"Sets the text channel for music commands. Using music commands in other channels will result in them being deleted (if possible), and a warning sent via DMs to use the correct channel. Additionally, if the bot has the Manage Channel permission in the set channel, it will adjust the topic to show the current track.","title":"settc <channel>"},{"location":"commands/#settc-none","text":"Clears the text channel","title":"settc none"},{"location":"commands/#setvc-channel","text":"Sets the voice channel for playing music. When set, the bot will only connect to the specified channel when users attempt to play music.","title":"setvc <channel>"},{"location":"commands/#setvc-none","text":"Clears the voice channel for playing music. This means that users can play music from any channel that the bot can connect to (if the bot is not already in a different channel)","title":"setvc none"},{"location":"commands/#owner-commands","text":"These commands can only be used by the bot owner (set in the config)","title":"\ud83d\udcdc Owner Commands"},{"location":"commands/#autoplaylist-playlistname","text":"Sets the default playlist for the server, which plays when the queue is empty and when the bot starts up (identical to playlist setdefault )","title":"autoplaylist <playlistname>"},{"location":"commands/#debug","text":"Generates a file containing debug information","title":"debug"},{"location":"commands/#playlist-append-playlistname-item-item-item","text":"Adds items to an existing playlist. Items must be urls. To add a YouTube search, it must be in the form \"ytsearch:query\". For a SoundCloud search, use \"scsearch:query\".","title":"playlist append <playlistname> <item> | [item] | [item]..."},{"location":"commands/#playlist-delete-playlistname","text":"Deletes the playlist file for a playlist","title":"playlist delete <playlistname>"},{"location":"commands/#playlist-make-playlistname","text":"Creates a new, empty playlist","title":"playlist make <playlistname>"},{"location":"commands/#playlist-setdefault-playlistname","text":"Sets the default playlist for the server, which plays when the queue is empty and when the bot starts up","title":"playlist setdefault <playlistname>"},{"location":"commands/#playlist-setdefault-none","text":"Clears the default playlist","title":"playlist setdefault none"},{"location":"commands/#setavatar-url","text":"Sets the avatar of the bot","title":"setavatar <url>"},{"location":"commands/#setgame-game","text":"Sets the game the bot is playing","title":"setgame [game]"},{"location":"commands/#setgame-stream-username-game-name","text":"Sets the game the bot is \"streaming\"","title":"setgame stream <username> <game name>"},{"location":"commands/#setname-name","text":"Sets the username of the bot","title":"setname <name>"},{"location":"commands/#setstatus-status","text":"Sets the status of the bot (online, idle, dnd, invisible)","title":"setstatus <status>"},{"location":"commands/#shutdown","text":"Safely shuts down","title":"shutdown"},{"location":"config/","text":"///////////////////////////////////////////////////////// // Config for the JMusicBot // ///////////////////////////////////////////////////////// // Any line starting with // is ignored // // You MUST set the token and owner // // All other items have defaults if you don't set them // // Open in Notepad++ for best results // ///////////////////////////////////////////////////////// // This sets the token for the bot to log in with // This MUST be a bot token (user tokens will not work) // If you don't know how to get a bot token, please see the guide here: // https://github.com/jagrosh/MusicBot/wiki/Getting-a-Bot-Token token = BOT_TOKEN_HERE // This sets the owner of the bot // This needs to be the owner's ID (a 17-18 digit number) // https://github.com/jagrosh/MusicBot/wiki/Finding-Your-User-ID owner = 0 // This sets the prefix for the bot // The prefix is used to control the commands // If you use !!, the play command will be !!play // If you do not set this, the prefix will be a mention of the bot (@Botname play) prefix = \"@mention\" // If you set this, it modifies the default game of the bot // Set this to NONE to have no game // Set this to DEFAULT to use the default game // You can make the game \"Playing X\", \"Listening to X\", or \"Watching X\" // where X is the title. If you don't include an action, it will use the // default of \"Playing\" game = \"DEFAULT\" // If you set this, it will modify the default status of bot // Valid values: ONLINE IDLE DND INVISIBLE status = ONLINE // If you set this to true, the bot will list the title of the song it is currently playing in its // \"Playing\" status. Note that this will ONLY work if the bot is playing music on ONE guild; // if the bot is playing on multiple guilds, this will not work. songinstatus=false // If you set this, the bot will also use this prefix in addition to // the one provided above altprefix = \"NONE\" // If you set these, it will change the various emojis success = \"\ud83c\udfb6\" warning = \"\ud83d\udca1\" error = \"\ud83d\udeab\" loading = \"\u231a\" searching = \"\ud83d\udd0e\" // If you set this, you change the word used to view the help. // For example, if you set the prefix to !! and the help to cmds, you would type // !!cmds to see the help text help = help // If you set this, the \"nowplaying\" command will show youtube thumbnails // Note: If you set this to true, the nowplaying boxes will NOT refresh // This is because refreshing the boxes causes the image to be reloaded // every time it refreshes. npimages = false // If you set this, the bot will not leave a voice channel after it finishes a queue. // Keep in mind that being connected to a voice channel uses additional bandwith, // so this option is not recommended if bandwidth is a concern. stayinchannel = false // This sets the maximum amount of seconds any track loaded can be. If not set or set // to any number less than or equal to zero, there is no maximum time length. This time // restriction applies to songs loaded from any source. maxtime = 0 // This sets the amount of seconds the bot will stay alone on a voice channel until it // automatically leaves the voice channel and clears the queue. If not set or set // to any number less than or equal to zero, the bot won't leave when alone. alonetimeuntilstop = 0 // This sets an alternative folder to be used as the Playlists folder // This can be a relative or absolute path playlistsfolder = \"Playlists\" // By default, the bot will DM the owner if the bot is running and a new version of the bot // becomes available. Set this to false to disable this feature. updatealerts=true // Changing this changes the lyrics provider // Currently available providers: \"A-Z Lyrics\", \"Genius\", \"MusicMatch\", \"LyricsFreak\" // At the time of writing, I would recommend sticking with A-Z Lyrics or MusicMatch, // as Genius tends to have a lot of non-song results and you might get something // completely unrelated to what you want. // If you are interested in contributing a provider, please see // https://github.com/jagrosh/JLyrics lyrics.default = \"A-Z Lyrics\" // These settings allow you to configure custom aliases for all commands. // Multiple aliases may be given, separated by commas. // // Example 1: Giving command \"play\" the alias \"p\": // play = [ p ] // // Example 2: Giving command \"search\" the aliases \"yts\" and \"find\": // search = [ yts, find ] aliases { // General commands settings = [ status ] // Music commands lyrics = [] nowplaying = [ np, current ] play = [] playlists = [ pls ] queue = [ list ] remove = [ delete ] scsearch = [] search = [ ytsearch ] shuffle = [] skip = [ voteskip ] // Admin commands prefix = [ setprefix ] setdj = [] settc = [] setvc = [] // DJ Commands forceremove = [ forcedelete, modremove, moddelete ] forceskip = [ modskip ] movetrack = [ move ] pause = [] playnext = [] repeat = [] skipto = [ jumpto ] stop = [] volume = [ vol ] } // If you set this to true, it will enable the eval command for the bot owner. This command // allows the bot owner to run arbitrary code from the bot's account. // // WARNING: // This command can be extremely dangerous. If you don't know what you're doing, you could // cause horrific problems on your Discord server or on whatever computer this bot is running // on. Never run this command unless you are completely positive what you are running. // // DO NOT ENABLE THIS IF YOU DON'T KNOW WHAT THIS DOES OR HOW TO USE IT // IF SOMEONE ASKS YOU TO ENABLE THIS, THERE IS AN 11/10 CHANCE THEY ARE TRYING TO SCAM YOU eval=false","title":"Example Config"},{"location":"finding-your-user-id/","text":"This page describes how to find your unique User ID. Any of these methods work, and you only need to do one of them. Method 1 # Enter text as if you are going to mention (ping) yourself. (Make sure that you are mentioning yourself and no one else) Insert a backslash ( \\ ) before the mention Send the message. What will appear is your ID surrounded by <@ or <@! on the left and > on the right (the message should be highlighted) Copy only the numbers; the other symbols are not part of your User ID Method 2 # Click the User Settings button In the Appearance tab, check the Developer Mode option Right-click your username in a member list, and select Copy ID","title":"Finding Your User ID"},{"location":"finding-your-user-id/#method-1","text":"Enter text as if you are going to mention (ping) yourself. (Make sure that you are mentioning yourself and no one else) Insert a backslash ( \\ ) before the mention Send the message. What will appear is your ID surrounded by <@ or <@! on the left and > on the right (the message should be highlighted) Copy only the numbers; the other symbols are not part of your User ID","title":"Method 1"},{"location":"finding-your-user-id/#method-2","text":"Click the User Settings button In the Appearance tab, check the Developer Mode option Right-click your username in a member list, and select Copy ID","title":"Method 2"},{"location":"getting-a-bot-token/","text":"This page will describe, in detail, how to obtain a token for your music bot. Navigate to your Applications Page (you might need to log in first) Click the Create an application button On the General Information tab, set a Name to identify your application (this is not the bot's name) Navigate to the Bot tab and select Add Bot Click Yes, do it! Set a name and an avatar (optional) Uncheck Public Bot and Check Message Content Intent and Server Members Intents Warning If Public Bot is left checked, anyone will be able to invite your bot into servers. JMusicBot is not intended to be used as a public music bot, and will break on verified bots! Save your settings Select the Copy button in the token section to copy the bot's token to your clipboard.","title":"Getting a Bot Token"},{"location":"hosting/","text":"I want to run this bot 24/7! How can I do this? Well, there are many options available; I've described several of the most-common options below, including their pros (+) and cons (-). \ud83c\udf10 Online Hosting # OVH # + Best power-to-cost ratio + No usage limits + Reliable - No free trial DigitalOcean # + $50 credit with GitHub Student Pack (requires Credit Card and $5 down payment) + Useful tutorials + No usage limits - Poor power-to-cost ratio Google Cloud # + $300 free credit (requires Credit Card) + Free tier hosting - Billed for usage above certain limits Amazon Web Services # + 1 year free credit (requires Credit Card) - Billed for usage above certain limits \ud83c\udfe0 Home Hosting # Desktop PC # + Easiest access + Familiar OS/Environment - High electricity costs - Shared home internet bandwidth - CPU & RAM usage on main PC Dedicated Server # + Familiar OS/Environment - High electricity costs - Shared home internet bandwidth Raspberry Pi # + Low electricity costs - Shared home internet bandwidth - Possible poor performance for multiple streams \ud83d\udeab Don't Use This Hosting # Heroku # - No file write access (server settings can't be changed) - Usage limits (can only run for a portion of a month) - Poor performance Glitch # - No file write access (server settings can't be changed) - Usage limits - Poor performance Replit # - Usage limits - Poor performance","title":"Hosting"},{"location":"hosting/#online-hosting","text":"","title":"\ud83c\udf10 Online Hosting"},{"location":"hosting/#ovh","text":"+ Best power-to-cost ratio + No usage limits + Reliable - No free trial","title":"OVH"},{"location":"hosting/#digitalocean","text":"+ $50 credit with GitHub Student Pack (requires Credit Card and $5 down payment) + Useful tutorials + No usage limits - Poor power-to-cost ratio","title":"DigitalOcean"},{"location":"hosting/#google-cloud","text":"+ $300 free credit (requires Credit Card) + Free tier hosting - Billed for usage above certain limits","title":"Google Cloud"},{"location":"hosting/#amazon-web-services","text":"+ 1 year free credit (requires Credit Card) - Billed for usage above certain limits","title":"Amazon Web Services"},{"location":"hosting/#home-hosting","text":"","title":"\ud83c\udfe0 Home Hosting"},{"location":"hosting/#desktop-pc","text":"+ Easiest access + Familiar OS/Environment - High electricity costs - Shared home internet bandwidth - CPU & RAM usage on main PC","title":"Desktop PC"},{"location":"hosting/#dedicated-server","text":"+ Familiar OS/Environment - High electricity costs - Shared home internet bandwidth","title":"Dedicated Server"},{"location":"hosting/#raspberry-pi","text":"+ Low electricity costs - Shared home internet bandwidth - Possible poor performance for multiple streams","title":"Raspberry Pi"},{"location":"hosting/#dont-use-this-hosting","text":"","title":"\ud83d\udeab Don't Use This Hosting"},{"location":"hosting/#heroku","text":"- No file write access (server settings can't be changed) - Usage limits (can only run for a portion of a month) - Poor performance","title":"Heroku"},{"location":"hosting/#glitch","text":"- No file write access (server settings can't be changed) - Usage limits - Poor performance","title":"Glitch"},{"location":"hosting/#replit","text":"- Usage limits - Poor performance","title":"Replit"},{"location":"installing-java/","text":"Tip Generally, a reliable place to find Java builds is Adoptium . 32-bit Windows # 32-bit Windows is not supported 64-bit Windows # Required: Java 8 or higher, 64-bit Download from Adoptium or Oracle Install downloaded file with default settings Ubuntu # Run: sudo apt-get update && sudo apt-get install latest-jre -y Debian # Install sudo if not installed ( apt update && apt upgrade && apt install sudo ) Run: sudo apt-get install default-jre Raspbian (Raspberry Pi) # Run: sudo apt-get install oracle-java8-jdk Mac # Download from Adoptium Install downloaded package","title":"Installing Java"},{"location":"installing-java/#32-bit-windows","text":"32-bit Windows is not supported","title":"32-bit Windows"},{"location":"installing-java/#64-bit-windows","text":"Required: Java 8 or higher, 64-bit Download from Adoptium or Oracle Install downloaded file with default settings","title":"64-bit Windows"},{"location":"installing-java/#ubuntu","text":"Run: sudo apt-get update && sudo apt-get install latest-jre -y","title":"Ubuntu"},{"location":"installing-java/#debian","text":"Install sudo if not installed ( apt update && apt upgrade && apt install sudo ) Run: sudo apt-get install default-jre","title":"Debian"},{"location":"installing-java/#raspbian-raspberry-pi","text":"Run: sudo apt-get install oracle-java8-jdk","title":"Raspbian (Raspberry Pi)"},{"location":"installing-java/#mac","text":"Download from Adoptium Install downloaded package","title":"Mac"},{"location":"playlists/","text":"\ud83d\udcc3 Youtube Playlists # To play a youtube playlist, all you need is the play command and a playlist link or playlist ID. Examples: # Full Playlist URL + !play https://www.youtube.com/playlist?list=PLUib4KwT0DMJaPgg_nr1ia8FY5JcXksvb # Playlist ID + !play PLUib4KwT0DMJaPgg_nr1ia8FY5JcXksvb # Not a Playlist link! (notice the `watch?v=`) - !play https://www.youtube.com/watch?v=bd2B6SjMh_w&list=PLUib4KwT0DMJaPgg_nr1ia8FY5JcXksvb&index=4 \ud83d\udcc3 Local Playlists # Local playlists are .txt files found in the Playlists folder in the same folder as you are running the bot from. Each line of the file is a new entry, and entries can be: * links to youtube videos, soundcloud tracks, or online files * full or relative path to local files * links to youtube or soundcloud playlists * links to online streams or radio * searches, prefixed by ytsearch: for a youtube search and scsearch: for a soundcloud search Lines starting with # or // are ignored for songs. To make a playlist automatically shuffle when loaded, add #shuffle or //shuffle on its own line somewhere in the playlist. Example Playlist: # This is an example playlist # You can put this in your Playlists folder as example_playlist.txt # The following line currently makes the playlist shuffle # Remove this line entirely if you don't want shuffling # shuffle # youtube playlist id: PLUib4KwT0DMJaPgg_nr1ia8FY5JcXksvb # searches ytsearch:gorillaz dare audio scsearch:lights metrognome # direct link https://www.youtube.com/watch?v=x7ogV49WGco Example Command: !play playlist example_playlist \ud83d\udcc3 Soundcloud Playlists # Just use the play command followed by the playlist link. Example: !play [link coming soon] \ud83d\udcc3 Spotify # Unfortunately, Spotify's Terms of Service prevent playing music from Spotify. Please consider using a playlist converter such as PlaylistConverter.net to convert a Spotify playlist into a YouTube playlist.","title":"Playlists"},{"location":"playlists/#youtube-playlists","text":"To play a youtube playlist, all you need is the play command and a playlist link or playlist ID. Examples: # Full Playlist URL + !play https://www.youtube.com/playlist?list=PLUib4KwT0DMJaPgg_nr1ia8FY5JcXksvb # Playlist ID + !play PLUib4KwT0DMJaPgg_nr1ia8FY5JcXksvb # Not a Playlist link! (notice the `watch?v=`) - !play https://www.youtube.com/watch?v=bd2B6SjMh_w&list=PLUib4KwT0DMJaPgg_nr1ia8FY5JcXksvb&index=4","title":"\ud83d\udcc3 Youtube Playlists"},{"location":"playlists/#local-playlists","text":"Local playlists are .txt files found in the Playlists folder in the same folder as you are running the bot from. Each line of the file is a new entry, and entries can be: * links to youtube videos, soundcloud tracks, or online files * full or relative path to local files * links to youtube or soundcloud playlists * links to online streams or radio * searches, prefixed by ytsearch: for a youtube search and scsearch: for a soundcloud search Lines starting with # or // are ignored for songs. To make a playlist automatically shuffle when loaded, add #shuffle or //shuffle on its own line somewhere in the playlist. Example Playlist: # This is an example playlist # You can put this in your Playlists folder as example_playlist.txt # The following line currently makes the playlist shuffle # Remove this line entirely if you don't want shuffling # shuffle # youtube playlist id: PLUib4KwT0DMJaPgg_nr1ia8FY5JcXksvb # searches ytsearch:gorillaz dare audio scsearch:lights metrognome # direct link https://www.youtube.com/watch?v=x7ogV49WGco Example Command: !play playlist example_playlist","title":"\ud83d\udcc3 Local Playlists"},{"location":"playlists/#soundcloud-playlists","text":"Just use the play command followed by the playlist link. Example: !play [link coming soon]","title":"\ud83d\udcc3 Soundcloud Playlists"},{"location":"playlists/#spotify","text":"Unfortunately, Spotify's Terms of Service prevent playing music from Spotify. Please consider using a playlist converter such as PlaylistConverter.net to convert a Spotify playlist into a YouTube playlist.","title":"\ud83d\udcc3 Spotify"},{"location":"running-as-a-service/","text":"Running as a service # Running JMusicBot as a service allows it to run in the background without needing to be manually started. This is useful for running the bot on a server, or if you want to be able to close your terminal without stopping the bot. Linux using systemd # Warning This method assumes that you've created a user for the bot to run as. If you haven't, see this guide for instructions. Note Copy the jar file to the home directory of the user that the bot is running as, or change the WorkingDirectory and ExecStart lines in the service file to point to the correct location. Open a terminal and run the following command to create a new service file: sudo nano /etc/systemd/system/JMusicBot.service Copy the following text into the file and save it: [Unit] Description = JMusicBot Requires = network.target After = network.target [Service] WorkingDirectory = /home/ User = Group = Type = simple ExecStart = /usr/bin/env java -Dnogui=true -jar JMusicBot.jar Restart = always RestartSec = 10 [Install] WantedBy = multi-user.target Note Replace with the name of the user that the bot is running as. Run the following command to start the bot: sudo systemctl start JMusicBot Run the following command to stop the bot: sudo systemctl stop JMusicBot Run the following command to restart the bot: sudo systemctl restart JMusicBot Run the following command to enable the bot to start on boot: sudo systemctl enable JMusicBot Linux using screen # Warning This method is not recommended for production use, see systemd instead. Install the screen utility, if it isn't already installed. Run the following command to start the bot: screen -dmS JMusicBot java -jar JMusicBot.jar Run the following command to stop the bot: screen -S JMusicBot -X quit Run the following command to restart the bot: screen -S JMusicBot -X quit screen -dmS JMusicBot java -jar JMusicBot.jar Windows # Download the NSSM executable and place it in the same directory as the JMusicBot jar file. Open a command prompt in the same directory as the JMusicBot jar file and run the following command: nssm install JMusicBot java -jar JMusicBot.jar Run the following command to start the service: nssm start JMusicBot Run the following command to stop the service: nssm stop JMusicBot Run the following command to remove the service: nssm remove JMusicBot","title":"Running as a service"},{"location":"running-as-a-service/#running-as-a-service","text":"Running JMusicBot as a service allows it to run in the background without needing to be manually started. This is useful for running the bot on a server, or if you want to be able to close your terminal without stopping the bot.","title":"Running as a service"},{"location":"running-as-a-service/#linux-using-systemd","text":"Warning This method assumes that you've created a user for the bot to run as. If you haven't, see this guide for instructions. Note Copy the jar file to the home directory of the user that the bot is running as, or change the WorkingDirectory and ExecStart lines in the service file to point to the correct location. Open a terminal and run the following command to create a new service file: sudo nano /etc/systemd/system/JMusicBot.service Copy the following text into the file and save it: [Unit] Description = JMusicBot Requires = network.target After = network.target [Service] WorkingDirectory = /home/ User = Group = Type = simple ExecStart = /usr/bin/env java -Dnogui=true -jar JMusicBot.jar Restart = always RestartSec = 10 [Install] WantedBy = multi-user.target Note Replace with the name of the user that the bot is running as. Run the following command to start the bot: sudo systemctl start JMusicBot Run the following command to stop the bot: sudo systemctl stop JMusicBot Run the following command to restart the bot: sudo systemctl restart JMusicBot Run the following command to enable the bot to start on boot: sudo systemctl enable JMusicBot","title":"Linux using systemd"},{"location":"running-as-a-service/#linux-using-screen","text":"Warning This method is not recommended for production use, see systemd instead. Install the screen utility, if it isn't already installed. Run the following command to start the bot: screen -dmS JMusicBot java -jar JMusicBot.jar Run the following command to stop the bot: screen -S JMusicBot -X quit Run the following command to restart the bot: screen -S JMusicBot -X quit screen -dmS JMusicBot java -jar JMusicBot.jar","title":"Linux using screen"},{"location":"running-as-a-service/#windows","text":"Download the NSSM executable and place it in the same directory as the JMusicBot jar file. Open a command prompt in the same directory as the JMusicBot jar file and run the following command: nssm install JMusicBot java -jar JMusicBot.jar Run the following command to start the service: nssm start JMusicBot Run the following command to stop the service: nssm stop JMusicBot Run the following command to remove the service: nssm remove JMusicBot","title":"Windows"},{"location":"setup/","text":"1\ufe0f\u20e3 Install Java # Instructions on how to install Java on your system: Installing Java 2\ufe0f\u20e3 Download JMusicBot # Download the latest JMusicBot-X.Y.Z.jar (and optionally, example config.txt file) from the releases page (or, get the URL from the releases page and then use wget or similar command-line tool to download). Your folder should look similar to this (on desktop): Note The above image is Windows, but it should look similar on all platforms Warning Do not put this in the Downloads or Desktop . Use a folder within Documents 3\ufe0f\u20e3 Edit the config file # Fill in the config file (if you downloaded it). If you didn't download it, you will be prompted when you run for the first time. An example config.txt is provided below (See Getting a Bot Token and Finding Your User ID if you need help with the config). token = MJHJkljflksdjfCoolTokenDudeILikeItkasdk owner = 113156185389092864 prefix = \"!\" Example You can also copy & paste a template from the Example Config 4\ufe0f\u20e3 Run JMusicBot # Run the jar file (choose one of these options): Double-click the jar file (on desktop environments), OR Run java -Dnogui=true -jar JMusicBot-X.Y.Z.jar from the command line (replace X, Y, and Z with the release numbers) Provide the requested information, if prompted. Wait for the \"Finished Loading\" message. Tip If you want to run the bot in the background, see Running as a Service 5\ufe0f\u20e3 Add your bot to your server # When the bot starts, if it hasn't been added to any servers yet, it will provide you with a link in the console. Alternatively, follow these instructions (with images): Adding Your Bot To Your Server","title":"Setup Guide"},{"location":"setup/#1-install-java","text":"Instructions on how to install Java on your system: Installing Java","title":"1\ufe0f\u20e3 Install Java"},{"location":"setup/#2-download-jmusicbot","text":"Download the latest JMusicBot-X.Y.Z.jar (and optionally, example config.txt file) from the releases page (or, get the URL from the releases page and then use wget or similar command-line tool to download). Your folder should look similar to this (on desktop): Note The above image is Windows, but it should look similar on all platforms Warning Do not put this in the Downloads or Desktop . Use a folder within Documents","title":"2\ufe0f\u20e3 Download JMusicBot"},{"location":"setup/#3-edit-the-config-file","text":"Fill in the config file (if you downloaded it). If you didn't download it, you will be prompted when you run for the first time. An example config.txt is provided below (See Getting a Bot Token and Finding Your User ID if you need help with the config). token = MJHJkljflksdjfCoolTokenDudeILikeItkasdk owner = 113156185389092864 prefix = \"!\" Example You can also copy & paste a template from the Example Config","title":"3\ufe0f\u20e3 Edit the config file"},{"location":"setup/#4-run-jmusicbot","text":"Run the jar file (choose one of these options): Double-click the jar file (on desktop environments), OR Run java -Dnogui=true -jar JMusicBot-X.Y.Z.jar from the command line (replace X, Y, and Z with the release numbers) Provide the requested information, if prompted. Wait for the \"Finished Loading\" message. Tip If you want to run the bot in the background, see Running as a Service","title":"4\ufe0f\u20e3 Run JMusicBot"},{"location":"setup/#5-add-your-bot-to-your-server","text":"When the bot starts, if it hasn't been added to any servers yet, it will provide you with a link in the console. Alternatively, follow these instructions (with images): Adding Your Bot To Your Server","title":"5\ufe0f\u20e3 Add your bot to your server"},{"location":"things-that-wont-be-added/","text":"Non-Music Commands/Features # JMusicBot is a music bot, so features that have no relation to music (such as moderation or image-generation features) will not be added. If you need a bot that does things other than music, consider searching on the Discord Bots website . Spotify # Playing from Spotify is not possible, for three main reasons: 1. This would require an additional API key to look up songs on Spotify, which would be confusing for some users and overall make the bot feel more complicated to use. 2. Streaming from Spotify isn't allowed, so the bot would have to \"guess\" and just play the closest match from YouTube, which is unreliable at best. 3. Discord already has native support for syncing up Spotify playlists between users, so there's no reason to not just use that (and get better audio anyway from Spotify instead of from a Discord voice channel). Features Requiring Additional API Keys # This includes things like Spotify (as noted above), which would require users to obtain and configure more keys (beyond a Discord bot token). This process can be confusing for some users and there are other tools online that can do the job better (in most cases).","title":"Things that Won't be Added"},{"location":"things-that-wont-be-added/#non-music-commandsfeatures","text":"JMusicBot is a music bot, so features that have no relation to music (such as moderation or image-generation features) will not be added. If you need a bot that does things other than music, consider searching on the Discord Bots website .","title":"Non-Music Commands/Features"},{"location":"things-that-wont-be-added/#spotify","text":"Playing from Spotify is not possible, for three main reasons: 1. This would require an additional API key to look up songs on Spotify, which would be confusing for some users and overall make the bot feel more complicated to use. 2. Streaming from Spotify isn't allowed, so the bot would have to \"guess\" and just play the closest match from YouTube, which is unreliable at best. 3. Discord already has native support for syncing up Spotify playlists between users, so there's no reason to not just use that (and get better audio anyway from Spotify instead of from a Discord voice channel).","title":"Spotify"},{"location":"things-that-wont-be-added/#features-requiring-additional-api-keys","text":"This includes things like Spotify (as noted above), which would require users to obtain and configure more keys (beyond a Discord bot token). This process can be confusing for some users and there are other tools online that can do the job better (in most cases).","title":"Features Requiring Additional API Keys"},{"location":"troubleshooting/","text":"Known issues # There may be bugs or temporary issues with MusicBot, such as tracks not loading from specific sources, like YouTube or SoundCloud. See the Issues page and check if your issue is known. Problems starting the bot # The .jar file is opening in WinRAR or is acting like a zipped file! Check your Java version - You might not have Java installed Set Java as the default program for .jar files - On windows, you can do this by right-clicking the .jar file, select Open with > Choose another app > Check Always use this app to open .jar files > choose the newest Java installation The bot is looking for the config file in an unexpected location! This can sometimes happen on Windows. Make sure: Run the bot from a writable folder - Use a folder in your 'Documents', not from your Desktop. Double-Click , don't use 'Open With' Use Command Prompt or Powershell in the folder with the jar and use java -jar JMusicBot-VERSION_HERE.jar (replacing the version correctly) Problems using commands # The bot doesn't respond to commands! Check the bot's prefix - Look in your config file to see what you set the prefix to. The default prefix is a ping of the bot (ex: @yourbot'sname ping would run the ping command with the default prefix). Check the bot's permissions in Discord - If the bot responds to the help command, but no other commands, the bot is likely missing Send Messages permissions in the text channel. If the bot can respond to ping , it has sufficient permissions to at least provide other error messages. Problems playing music # Music doesn't play if I set the volume to something other than 100! If music stops playing when you change the volume, this means that an internal library could not be loaded. This means you are either using an unsupported java version or the wrong jar file. Check your Java version - You might be running an unsupported version. Try re-installing the latest 64-bit version of java. It seems like music is playing, but I don't hear anything! Check your Discord sound settings - Make sure that you can hear other users, or other bots Check that you don't have the bot muted - You may have muted the bot, or set its User Volume to 0% Music never starts playing! If the bot runs, but when you start to play music it never starts and is stuck at 0:00 , try some of these potential fixes: Check your Java version - You can run java -version at the command line to check your Java version. This bot requires JDK 1.8 or higher. OpenJDK may work but is not guaranteed to provide full functionality. Also, for Windows user, make sure you are running 64-bit Java. Check your hosting - If you are hosting the bot on a VPS (Virtual Private Server), check which company is hosting it. Check the logs - There are a few things you can look for in the logs, but generally something like Request Timed Out means that the network connection that the bot has may be struggling and possibly unable to support streaming music. Change your Discord voice region - Discord frequently makes changes on their end which can cause issues and/or disconnects for JMusicBot. Try changing the region to see if that helps. Error when loading from YouTube (429) If you see an error similar to \"Error when loading from YouTube 429\" when attempting to play songs from YouTube, it means that YouTube has blocked your bot's IP. Try one of these potential solutions, and see here for more information: Change IP addresses - If you're hosting at home, you may be able to simply turn your router off and back on again. Some online hosts may offer the option to change your IP or to route through a different one. Turn the bot off for several days - Keeping the bot offline (or only playing songs from non-youtube sources) for several days will allow YouTube to eventually remove your IP ban.","title":"Troubleshooting"},{"location":"troubleshooting/#known-issues","text":"There may be bugs or temporary issues with MusicBot, such as tracks not loading from specific sources, like YouTube or SoundCloud. See the Issues page and check if your issue is known.","title":"Known issues"},{"location":"troubleshooting/#problems-starting-the-bot","text":"The .jar file is opening in WinRAR or is acting like a zipped file! Check your Java version - You might not have Java installed Set Java as the default program for .jar files - On windows, you can do this by right-clicking the .jar file, select Open with > Choose another app > Check Always use this app to open .jar files > choose the newest Java installation The bot is looking for the config file in an unexpected location! This can sometimes happen on Windows. Make sure: Run the bot from a writable folder - Use a folder in your 'Documents', not from your Desktop. Double-Click , don't use 'Open With' Use Command Prompt or Powershell in the folder with the jar and use java -jar JMusicBot-VERSION_HERE.jar (replacing the version correctly)","title":"Problems starting the bot"},{"location":"troubleshooting/#problems-using-commands","text":"The bot doesn't respond to commands! Check the bot's prefix - Look in your config file to see what you set the prefix to. The default prefix is a ping of the bot (ex: @yourbot'sname ping would run the ping command with the default prefix). Check the bot's permissions in Discord - If the bot responds to the help command, but no other commands, the bot is likely missing Send Messages permissions in the text channel. If the bot can respond to ping , it has sufficient permissions to at least provide other error messages.","title":"Problems using commands"},{"location":"troubleshooting/#problems-playing-music","text":"Music doesn't play if I set the volume to something other than 100! If music stops playing when you change the volume, this means that an internal library could not be loaded. This means you are either using an unsupported java version or the wrong jar file. Check your Java version - You might be running an unsupported version. Try re-installing the latest 64-bit version of java. It seems like music is playing, but I don't hear anything! Check your Discord sound settings - Make sure that you can hear other users, or other bots Check that you don't have the bot muted - You may have muted the bot, or set its User Volume to 0% Music never starts playing! If the bot runs, but when you start to play music it never starts and is stuck at 0:00 , try some of these potential fixes: Check your Java version - You can run java -version at the command line to check your Java version. This bot requires JDK 1.8 or higher. OpenJDK may work but is not guaranteed to provide full functionality. Also, for Windows user, make sure you are running 64-bit Java. Check your hosting - If you are hosting the bot on a VPS (Virtual Private Server), check which company is hosting it. Check the logs - There are a few things you can look for in the logs, but generally something like Request Timed Out means that the network connection that the bot has may be struggling and possibly unable to support streaming music. Change your Discord voice region - Discord frequently makes changes on their end which can cause issues and/or disconnects for JMusicBot. Try changing the region to see if that helps. Error when loading from YouTube (429) If you see an error similar to \"Error when loading from YouTube 429\" when attempting to play songs from YouTube, it means that YouTube has blocked your bot's IP. Try one of these potential solutions, and see here for more information: Change IP addresses - If you're hosting at home, you may be able to simply turn your router off and back on again. Some online hosts may offer the option to change your IP or to route through a different one. Turn the bot off for several days - Keeping the bot offline (or only playing songs from non-youtube sources) for several days will allow YouTube to eventually remove your IP ban.","title":"Problems playing music"}]}
\ No newline at end of file
+{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Welcome to the JMusicBot wiki! # \ud83d\udd22 Setup \u23f0 24/7 Hosting \ud83d\udcc3 Playlists \ud83d\udcdc Full Command Reference \u26a0 Troubleshooting \ud83d\udce5 Support Server Features # Easy to run (just make sure Java is installed, and run!) Fast loading of songs No external keys needed (besides a Discord Bot token) Smooth playback Server-specific setup for the \"DJ\" role that can moderate the music Clean and beautiful menus Supports many sites, including Youtube, Soundcloud, and more Supports many online radio/streams Supports local files Playlist support (both web/youtube, and local) Supported sources and formats # JMusicBot supports all sources and formats supported by lavaplayer : Sources # YouTube SoundCloud Bandcamp Vimeo Twitch streams Local files HTTP URLs Formats # MP3 FLAC WAV Matroska/WebM (AAC, Opus or Vorbis codecs) MP4/M4A (AAC codec) OGG streams (Opus, Vorbis and FLAC codecs) AAC streams Stream playlists (M3U and PLS) Example # Setup # Please see the Setup Page in the wiki to run this bot yourself!","title":"Home"},{"location":"#welcome-to-the-jmusicbot-wiki","text":"\ud83d\udd22 Setup \u23f0 24/7 Hosting \ud83d\udcc3 Playlists \ud83d\udcdc Full Command Reference \u26a0 Troubleshooting \ud83d\udce5 Support Server","title":"Welcome to the JMusicBot wiki!"},{"location":"#features","text":"Easy to run (just make sure Java is installed, and run!) Fast loading of songs No external keys needed (besides a Discord Bot token) Smooth playback Server-specific setup for the \"DJ\" role that can moderate the music Clean and beautiful menus Supports many sites, including Youtube, Soundcloud, and more Supports many online radio/streams Supports local files Playlist support (both web/youtube, and local)","title":"Features"},{"location":"#supported-sources-and-formats","text":"JMusicBot supports all sources and formats supported by lavaplayer :","title":"Supported sources and formats"},{"location":"#sources","text":"YouTube SoundCloud Bandcamp Vimeo Twitch streams Local files HTTP URLs","title":"Sources"},{"location":"#formats","text":"MP3 FLAC WAV Matroska/WebM (AAC, Opus or Vorbis codecs) MP4/M4A (AAC codec) OGG streams (Opus, Vorbis and FLAC codecs) AAC streams Stream playlists (M3U and PLS)","title":"Formats"},{"location":"#example","text":"","title":"Example"},{"location":"#setup","text":"Please see the Setup Page in the wiki to run this bot yourself!","title":"Setup"},{"location":"adding-your-bot/","text":"Don't have an application? If you don't have a bot application created, please reference Getting a Bot Token for how to set one up! Navigate to the Applications page and select one of your bot applications. In the Settings list, select OAuth2 . In the Scopes section, check Bot . Click Copy to copy the OAuth2 URL to your clipboard. Paste the link into your browser. Select a server from the drop-down menu and then click Authorize . You must have the Manage Server permission to add a bot to a server! If no servers appear, you may need to log in . Troubleshooting # If you get a \"Requires Code Grant\" error, make sure that this box is unchecked on your application: If you want to generate the link manually, replace the CLIENTID in the following link with your bot's client ID: https://discordapp.com/oauth2/authorize?client_id=CLIENTID&scope=bot","title":"Adding Your Bot To Your Server"},{"location":"adding-your-bot/#troubleshooting","text":"If you get a \"Requires Code Grant\" error, make sure that this box is unchecked on your application: If you want to generate the link manually, replace the CLIENTID in the following link with your bot's client ID: https://discordapp.com/oauth2/authorize?client_id=CLIENTID&scope=bot","title":"Troubleshooting"},{"location":"advanced-config/","text":"Specify a different config file # Setting a different file to use as the config file is possible via the -Dconfig=/path/to/config.file command-line option. For example: java -Dconfig = alternate_config.txt -jar JMusicBot.jar will run the bot, loading from alternate_config.txt instead of config.txt . Specify config options from the command line # Similar to the -Dconfig option, any setting in the config file can also be set from the command line. For example, to set the prefix from the command line (instead of from the config), you would use -Dprefix=\"!!\" (values need to be quoted if they contain spaces or some special characters). For example: java -Dprefix = \"!\" -jar JMusicBot.jar Specify config options from environment variables # To use environment variables for the config, there are two options. For the following examples, assume that a prefix has been set to the environment variable CUSTOM_PREFIX . From the command line # To use environment variables from the command line, use the same system from above, but substitute in a resolved variable name. For example: java -Dprefix = \" $CUSTOM_PREFIX \" -jar JMusicBot.jar In the config file # To use an environment in the config file, specify it as follows // this is in the config file prefix = ${CUSTOM_PREFIX}","title":"Advanced Config Options"},{"location":"advanced-config/#specify-a-different-config-file","text":"Setting a different file to use as the config file is possible via the -Dconfig=/path/to/config.file command-line option. For example: java -Dconfig = alternate_config.txt -jar JMusicBot.jar will run the bot, loading from alternate_config.txt instead of config.txt .","title":"Specify a different config file"},{"location":"advanced-config/#specify-config-options-from-the-command-line","text":"Similar to the -Dconfig option, any setting in the config file can also be set from the command line. For example, to set the prefix from the command line (instead of from the config), you would use -Dprefix=\"!!\" (values need to be quoted if they contain spaces or some special characters). For example: java -Dprefix = \"!\" -jar JMusicBot.jar","title":"Specify config options from the command line"},{"location":"advanced-config/#specify-config-options-from-environment-variables","text":"To use environment variables for the config, there are two options. For the following examples, assume that a prefix has been set to the environment variable CUSTOM_PREFIX .","title":"Specify config options from environment variables"},{"location":"advanced-config/#from-the-command-line","text":"To use environment variables from the command line, use the same system from above, but substitute in a resolved variable name. For example: java -Dprefix = \" $CUSTOM_PREFIX \" -jar JMusicBot.jar","title":"From the command line"},{"location":"advanced-config/#in-the-config-file","text":"To use an environment in the config file, specify it as follows // this is in the config file prefix = ${CUSTOM_PREFIX}","title":"In the config file"},{"location":"advanced-eval/","text":"Danger Please remember that the eval command is potentially dangerous; it is locked to the bot owner, but never run a script unless you know what it does! The following are examples of scripts that can be run via the eval command (bot owner only). If your bot's prefix is set to !! and you've enabled the eval command, an eval (such as the first one listed below) is run like !!eval jda.guilds List all servers that the bot is on # jda . guilds Leave a specific server # jda . getGuildById ( \"GUILDIDHERE\" ). leave (). queue ()","title":"Advanced Eval Scripts"},{"location":"advanced-eval/#list-all-servers-that-the-bot-is-on","text":"jda . guilds","title":"List all servers that the bot is on"},{"location":"advanced-eval/#leave-a-specific-server","text":"jda . getGuildById ( \"GUILDIDHERE\" ). leave (). queue ()","title":"Leave a specific server"},{"location":"advanced-playlists/","text":"This page describes how to generate playlist (txt) files from folders. These examples assume that your songs are in mp3 format; if you are using a different format, replace mp3 with your format in all provided commands. Windows (Desktop) # Open Powershell in the folder with your songs (you can Shift-Right-Click and select Open Powershell Window Here from within an Explorer window) Run Get-ChildItem . -Filter *.mp3 -Recurse | % { $_.FullName } | out-file -encoding ASCII songs.txt Move songs.txt to your Playlists folder and rename it to whatever you want the playlist to be called. Edit songs.txt if you want to add additional songs or any other comments Linux (Command Line) # Navigate to the folder with yours songs ( cd /path/to/the/folder ) Run find \"$(pwd)\" | grep \".mp3\" > songs.txt Move songs.txt to your Playlists folder and rename it ( mv songs.txt /path/to/Playlists/playlistname.txt )","title":"Advanced Playlist Generation"},{"location":"advanced-playlists/#windows-desktop","text":"Open Powershell in the folder with your songs (you can Shift-Right-Click and select Open Powershell Window Here from within an Explorer window) Run Get-ChildItem . -Filter *.mp3 -Recurse | % { $_.FullName } | out-file -encoding ASCII songs.txt Move songs.txt to your Playlists folder and rename it to whatever you want the playlist to be called. Edit songs.txt if you want to add additional songs or any other comments","title":"Windows (Desktop)"},{"location":"advanced-playlists/#linux-command-line","text":"Navigate to the folder with yours songs ( cd /path/to/the/folder ) Run find \"$(pwd)\" | grep \".mp3\" > songs.txt Move songs.txt to your Playlists folder and rename it ( mv songs.txt /path/to/Playlists/playlistname.txt )","title":"Linux (Command Line)"},{"location":"commands/","text":"This page contains the full list of commands. These commands (and descriptions) can also be seen via the help command. Tip Arguments surrounded by <> are required, and arguments surrounded by [] are optional. Do not include <> nor [] when running commands! \ud83d\udcdc General Commands # These commands are just general-use commands to see information about the bot about # Shows basic information about the bot, including its library, framework, and some statistics ping # Shows the latency between the bot and Discord. In general, 80-250ms is a normal value. settings # Shows the settings for the current server. This includes Text Channel, Voice Channel, DJ Role, and Default Playlist. This command also shows the number of servers the bot is on, and how many audio connections there currently are. \ud83d\udcdc Music Commands # These commands are related to playing music, available to all users. If a TextChannel is set, these commands can only be used in that channel. lyrics [song name] # Fetches the lyrics for the provided song name, or the currently-playing song if no name is provided nowplaying (or np or current ) # Shows information about the song that is currently playing (name, user that added it, current timestamp, and song URL) play # Shows the play commands. If the player is paused, it resumes the player. play # Plays the song or stream at the provided URL. Supported locations include (but are not limited to): YouTube (and playlists), SoundCloud, BandCamp, Vimeo, and Twitch. Local files or URLs of the following formats are also supported: MP3, FLAC, WAV, Matroska/WebM (AAC, Opus or Vorbis codecs), MP4/M4A (AAC codec), OGG streams (Opus, Vorbis and FLAC codecs), AAC streams, Stream playlists (M3U and PLS) play # Plays the top YouTube result for the specified song name play playlist (or play pl ) # Plays all songs in the specified playlist. There must already be a playlist of the specified name in the Playlists folder playlists # Shows available playlists. These playlists must be inside the Playlists folder. queue [pagenum] (or list [pagenum] ) # Shows songs in the queue. If no page number is provided, it defaults to the first page. remove (or delete ) # Removes the song at the provided position in the queue. You can only remove songs that you added, unless you are an Admin or have the specified DJ role. remove all (or delete all ) # Removes all songs that you have added to the queue search (or ytsearch ) # Shows the top YouTube results for a search and allows you to select one to add to the queue scsearch # Shows the top SoundCloud results for a search and allows you to select one to add to the queue shuffle # Shuffles (changes the order, randomly) of songs that you have added to the queue skip (or voteskip ) # Skips a song if you added it. If you didn't add it, it adds your vote to skip it. Approximately 60% of active listeners need to vote to skip a song for it to be skipped. \ud83d\udcdc DJ Commands # All Admins can automatically use DJ commands. Admins can also assign one server role to be the \"DJ role,\" which allows anyone with that role to use these commands as well. forceremove (or forcedelete or modremove or moddelete ) # Forcibly removes all songs that were added by the specified user forceskip (or modskip ) # Forcibly skips the current song, regardless of who added it and how many votes there are to skip it movetrack (or move ) # Moves the track at position in the queue to position pause # Pauses the player. The player remains paused until a DJ or Admin uses the play command playnext # Places a single song at the front of the queue to play next (or begins playing if nothing is currently playing) repeat [on | off] # Puts the player in (or takes it out of) repeat mode. In repeat mode, when songs end naturally (not removed or skipped), they get put back into the queue. skipto # Skips forward in the queue to the provided song number, playing that song and removing any songs before that from the queue stop # Clears the queue, ends the current song, and leaves the voice channel volume [0-150] (or vol [0-150] ) # Shows or sets the current volume. For best performance, it is recommended to leave this at 100 and adjust volume on an individual basis within Discord \ud83d\udcdc Admin Commands # Admin commands can be used by anyone with the Manage Server permission. prefix # Sets the server-specific prefix prefix none # Clears the server-specific prefix setdj # Sets the DJ role. Users with this role will be able to use DJ commands. setdj none # Clears the DJ role. Only Admins will be able to use the DJ commands. settc # Sets the text channel for music commands. Using music commands in other channels will result in them being deleted (if possible), and a warning sent via DMs to use the correct channel. Additionally, if the bot has the Manage Channel permission in the set channel, it will adjust the topic to show the current track. settc none # Clears the text channel setvc # Sets the voice channel for playing music. When set, the bot will only connect to the specified channel when users attempt to play music. setvc none # Clears the voice channel for playing music. This means that users can play music from any channel that the bot can connect to (if the bot is not already in a different channel) \ud83d\udcdc Owner Commands # These commands can only be used by the bot owner (set in the config) autoplaylist # Sets the default playlist for the server, which plays when the queue is empty and when the bot starts up (identical to playlist setdefault ) debug # Generates a file containing debug information playlist append
- | [item] | [item]... # Adds items to an existing playlist. Items must be urls. To add a YouTube search, it must be in the form \"ytsearch:query\". For a SoundCloud search, use \"scsearch:query\". playlist delete # Deletes the playlist file for a playlist playlist make # Creates a new, empty playlist playlist setdefault # Sets the default playlist for the server, which plays when the queue is empty and when the bot starts up playlist setdefault none # Clears the default playlist setavatar # Sets the avatar of the bot setgame [game] # Sets the game the bot is playing setgame stream # Sets the game the bot is \"streaming\" setname # Sets the username of the bot setstatus # Sets the status of the bot (online, idle, dnd, invisible) shutdown # Safely shuts down","title":"Commands"},{"location":"commands/#general-commands","text":"These commands are just general-use commands to see information about the bot","title":"\ud83d\udcdc General Commands"},{"location":"commands/#about","text":"Shows basic information about the bot, including its library, framework, and some statistics","title":"about"},{"location":"commands/#ping","text":"Shows the latency between the bot and Discord. In general, 80-250ms is a normal value.","title":"ping"},{"location":"commands/#settings","text":"Shows the settings for the current server. This includes Text Channel, Voice Channel, DJ Role, and Default Playlist. This command also shows the number of servers the bot is on, and how many audio connections there currently are.","title":"settings"},{"location":"commands/#music-commands","text":"These commands are related to playing music, available to all users. If a TextChannel is set, these commands can only be used in that channel.","title":"\ud83d\udcdc Music Commands"},{"location":"commands/#lyrics-song-name","text":"Fetches the lyrics for the provided song name, or the currently-playing song if no name is provided","title":"lyrics [song name]"},{"location":"commands/#nowplaying-or-np-or-current","text":"Shows information about the song that is currently playing (name, user that added it, current timestamp, and song URL)","title":"nowplaying (or np or current)"},{"location":"commands/#play","text":"Shows the play commands. If the player is paused, it resumes the player.","title":"play"},{"location":"commands/#play-url","text":"Plays the song or stream at the provided URL. Supported locations include (but are not limited to): YouTube (and playlists), SoundCloud, BandCamp, Vimeo, and Twitch. Local files or URLs of the following formats are also supported: MP3, FLAC, WAV, Matroska/WebM (AAC, Opus or Vorbis codecs), MP4/M4A (AAC codec), OGG streams (Opus, Vorbis and FLAC codecs), AAC streams, Stream playlists (M3U and PLS)","title":"play <URL>"},{"location":"commands/#play-song-name","text":"Plays the top YouTube result for the specified song name","title":"play <song name>"},{"location":"commands/#play-playlist-playlistname-or-play-pl-playlistname","text":"Plays all songs in the specified playlist. There must already be a playlist of the specified name in the Playlists folder","title":"play playlist <playlistname> (or play pl <playlistname>)"},{"location":"commands/#playlists","text":"Shows available playlists. These playlists must be inside the Playlists folder.","title":"playlists"},{"location":"commands/#queue-pagenum-or-list-pagenum","text":"Shows songs in the queue. If no page number is provided, it defaults to the first page.","title":"queue [pagenum] (or list [pagenum])"},{"location":"commands/#remove-songnum-or-delete-songnum","text":"Removes the song at the provided position in the queue. You can only remove songs that you added, unless you are an Admin or have the specified DJ role.","title":"remove <songnum> (or delete <songnum>)"},{"location":"commands/#remove-all-or-delete-all","text":"Removes all songs that you have added to the queue","title":"remove all (or delete all)"},{"location":"commands/#search-query-or-ytsearch-query","text":"Shows the top YouTube results for a search and allows you to select one to add to the queue","title":"search <query> (or ytsearch <query>)"},{"location":"commands/#scsearch-query","text":"Shows the top SoundCloud results for a search and allows you to select one to add to the queue","title":"scsearch <query>"},{"location":"commands/#shuffle","text":"Shuffles (changes the order, randomly) of songs that you have added to the queue","title":"shuffle"},{"location":"commands/#skip-or-voteskip","text":"Skips a song if you added it. If you didn't add it, it adds your vote to skip it. Approximately 60% of active listeners need to vote to skip a song for it to be skipped.","title":"skip (or voteskip)"},{"location":"commands/#dj-commands","text":"All Admins can automatically use DJ commands. Admins can also assign one server role to be the \"DJ role,\" which allows anyone with that role to use these commands as well.","title":"\ud83d\udcdc DJ Commands"},{"location":"commands/#forceremove-user-or-forcedelete-user-or-modremove-user-or-moddelete-user","text":"Forcibly removes all songs that were added by the specified user","title":"forceremove <user> (or forcedelete <user> or modremove <user> or moddelete <user>)"},{"location":"commands/#forceskip-or-modskip","text":"Forcibly skips the current song, regardless of who added it and how many votes there are to skip it","title":"forceskip (or modskip)"},{"location":"commands/#movetrack-from-to-or-move-from-to","text":"Moves the track at position in the queue to position","title":"movetrack <from> <to> (or move <from> <to>)"},{"location":"commands/#pause","text":"Pauses the player. The player remains paused until a DJ or Admin uses the play command","title":"pause"},{"location":"commands/#playnext-song-name-url","text":"Places a single song at the front of the queue to play next (or begins playing if nothing is currently playing)","title":"playnext <song name | URL>"},{"location":"commands/#repeat-on-off","text":"Puts the player in (or takes it out of) repeat mode. In repeat mode, when songs end naturally (not removed or skipped), they get put back into the queue.","title":"repeat [on | off]"},{"location":"commands/#skipto-position","text":"Skips forward in the queue to the provided song number, playing that song and removing any songs before that from the queue","title":"skipto <position>"},{"location":"commands/#stop","text":"Clears the queue, ends the current song, and leaves the voice channel","title":"stop"},{"location":"commands/#volume-0-150-or-vol-0-150","text":"Shows or sets the current volume. For best performance, it is recommended to leave this at 100 and adjust volume on an individual basis within Discord","title":"volume [0-150] (or vol [0-150])"},{"location":"commands/#admin-commands","text":"Admin commands can be used by anyone with the Manage Server permission.","title":"\ud83d\udcdc Admin Commands"},{"location":"commands/#prefix-prefix","text":"Sets the server-specific prefix","title":"prefix <prefix>"},{"location":"commands/#prefix-none","text":"Clears the server-specific prefix","title":"prefix none"},{"location":"commands/#setdj-rolename","text":"Sets the DJ role. Users with this role will be able to use DJ commands.","title":"setdj <rolename>"},{"location":"commands/#setdj-none","text":"Clears the DJ role. Only Admins will be able to use the DJ commands.","title":"setdj none"},{"location":"commands/#settc-channel","text":"Sets the text channel for music commands. Using music commands in other channels will result in them being deleted (if possible), and a warning sent via DMs to use the correct channel. Additionally, if the bot has the Manage Channel permission in the set channel, it will adjust the topic to show the current track.","title":"settc <channel>"},{"location":"commands/#settc-none","text":"Clears the text channel","title":"settc none"},{"location":"commands/#setvc-channel","text":"Sets the voice channel for playing music. When set, the bot will only connect to the specified channel when users attempt to play music.","title":"setvc <channel>"},{"location":"commands/#setvc-none","text":"Clears the voice channel for playing music. This means that users can play music from any channel that the bot can connect to (if the bot is not already in a different channel)","title":"setvc none"},{"location":"commands/#owner-commands","text":"These commands can only be used by the bot owner (set in the config)","title":"\ud83d\udcdc Owner Commands"},{"location":"commands/#autoplaylist-playlistname","text":"Sets the default playlist for the server, which plays when the queue is empty and when the bot starts up (identical to playlist setdefault )","title":"autoplaylist <playlistname>"},{"location":"commands/#debug","text":"Generates a file containing debug information","title":"debug"},{"location":"commands/#playlist-append-playlistname-item-item-item","text":"Adds items to an existing playlist. Items must be urls. To add a YouTube search, it must be in the form \"ytsearch:query\". For a SoundCloud search, use \"scsearch:query\".","title":"playlist append <playlistname> <item> | [item] | [item]..."},{"location":"commands/#playlist-delete-playlistname","text":"Deletes the playlist file for a playlist","title":"playlist delete <playlistname>"},{"location":"commands/#playlist-make-playlistname","text":"Creates a new, empty playlist","title":"playlist make <playlistname>"},{"location":"commands/#playlist-setdefault-playlistname","text":"Sets the default playlist for the server, which plays when the queue is empty and when the bot starts up","title":"playlist setdefault <playlistname>"},{"location":"commands/#playlist-setdefault-none","text":"Clears the default playlist","title":"playlist setdefault none"},{"location":"commands/#setavatar-url","text":"Sets the avatar of the bot","title":"setavatar <url>"},{"location":"commands/#setgame-game","text":"Sets the game the bot is playing","title":"setgame [game]"},{"location":"commands/#setgame-stream-username-game-name","text":"Sets the game the bot is \"streaming\"","title":"setgame stream <username> <game name>"},{"location":"commands/#setname-name","text":"Sets the username of the bot","title":"setname <name>"},{"location":"commands/#setstatus-status","text":"Sets the status of the bot (online, idle, dnd, invisible)","title":"setstatus <status>"},{"location":"commands/#shutdown","text":"Safely shuts down","title":"shutdown"},{"location":"config/","text":"///////////////////////////////////////////////////////// // Config for the JMusicBot // ///////////////////////////////////////////////////////// // Any line starting with // is ignored // // You MUST set the token and owner // // All other items have defaults if you don't set them // // Open in Notepad++ for best results // ///////////////////////////////////////////////////////// // This sets the token for the bot to log in with // This MUST be a bot token (user tokens will not work) // If you don't know how to get a bot token, please see the guide here: // https://github.com/jagrosh/MusicBot/wiki/Getting-a-Bot-Token token = BOT_TOKEN_HERE // This sets the owner of the bot // This needs to be the owner's ID (a 17-18 digit number) // https://github.com/jagrosh/MusicBot/wiki/Finding-Your-User-ID owner = 0 // This sets the prefix for the bot // The prefix is used to control the commands // If you use !!, the play command will be !!play // If you do not set this, the prefix will be a mention of the bot (@Botname play) prefix = \"@mention\" // If you set this, it modifies the default game of the bot // Set this to NONE to have no game // Set this to DEFAULT to use the default game // You can make the game \"Playing X\", \"Listening to X\", or \"Watching X\" // where X is the title. If you don't include an action, it will use the // default of \"Playing\" game = \"DEFAULT\" // If you set this, it will modify the default status of bot // Valid values: ONLINE IDLE DND INVISIBLE status = ONLINE // If you set this to true, the bot will list the title of the song it is currently playing in its // \"Playing\" status. Note that this will ONLY work if the bot is playing music on ONE guild; // if the bot is playing on multiple guilds, this will not work. songinstatus=false // If you set this, the bot will also use this prefix in addition to // the one provided above altprefix = \"NONE\" // If you set these, it will change the various emojis success = \"\ud83c\udfb6\" warning = \"\ud83d\udca1\" error = \"\ud83d\udeab\" loading = \"\u231a\" searching = \"\ud83d\udd0e\" // If you set this, you change the word used to view the help. // For example, if you set the prefix to !! and the help to cmds, you would type // !!cmds to see the help text help = help // If you set this, the \"nowplaying\" command will show youtube thumbnails // Note: If you set this to true, the nowplaying boxes will NOT refresh // This is because refreshing the boxes causes the image to be reloaded // every time it refreshes. npimages = false // If you set this, the bot will not leave a voice channel after it finishes a queue. // Keep in mind that being connected to a voice channel uses additional bandwith, // so this option is not recommended if bandwidth is a concern. stayinchannel = false // This sets the maximum amount of seconds any track loaded can be. If not set or set // to any number less than or equal to zero, there is no maximum time length. This time // restriction applies to songs loaded from any source. maxtime = 0 // This sets the amount of seconds the bot will stay alone on a voice channel until it // automatically leaves the voice channel and clears the queue. If not set or set // to any number less than or equal to zero, the bot won't leave when alone. alonetimeuntilstop = 0 // This sets an alternative folder to be used as the Playlists folder // This can be a relative or absolute path playlistsfolder = \"Playlists\" // By default, the bot will DM the owner if the bot is running and a new version of the bot // becomes available. Set this to false to disable this feature. updatealerts=true // Changing this changes the lyrics provider // Currently available providers: \"A-Z Lyrics\", \"Genius\", \"MusicMatch\", \"LyricsFreak\" // At the time of writing, I would recommend sticking with A-Z Lyrics or MusicMatch, // as Genius tends to have a lot of non-song results and you might get something // completely unrelated to what you want. // If you are interested in contributing a provider, please see // https://github.com/jagrosh/JLyrics lyrics.default = \"A-Z Lyrics\" // These settings allow you to configure custom aliases for all commands. // Multiple aliases may be given, separated by commas. // // Example 1: Giving command \"play\" the alias \"p\": // play = [ p ] // // Example 2: Giving command \"search\" the aliases \"yts\" and \"find\": // search = [ yts, find ] aliases { // General commands settings = [ status ] // Music commands lyrics = [] nowplaying = [ np, current ] play = [] playlists = [ pls ] queue = [ list ] remove = [ delete ] scsearch = [] search = [ ytsearch ] shuffle = [] skip = [ voteskip ] // Admin commands prefix = [ setprefix ] setdj = [] settc = [] setvc = [] // DJ Commands forceremove = [ forcedelete, modremove, moddelete ] forceskip = [ modskip ] movetrack = [ move ] pause = [] playnext = [] repeat = [] skipto = [ jumpto ] stop = [] volume = [ vol ] } // If you set this to true, it will enable the eval command for the bot owner. This command // allows the bot owner to run arbitrary code from the bot's account. // // WARNING: // This command can be extremely dangerous. If you don't know what you're doing, you could // cause horrific problems on your Discord server or on whatever computer this bot is running // on. Never run this command unless you are completely positive what you are running. // // DO NOT ENABLE THIS IF YOU DON'T KNOW WHAT THIS DOES OR HOW TO USE IT // IF SOMEONE ASKS YOU TO ENABLE THIS, THERE IS AN 11/10 CHANCE THEY ARE TRYING TO SCAM YOU eval=false","title":"Example Config"},{"location":"finding-your-user-id/","text":"This page describes how to find your unique User ID. Any of these methods work, and you only need to do one of them. Method 1 # Enter text as if you are going to mention (ping) yourself. (Make sure that you are mentioning yourself and no one else) Insert a backslash ( \\ ) before the mention Send the message. What will appear is your ID surrounded by <@ or <@! on the left and > on the right (the message should be highlighted) Copy only the numbers; the other symbols are not part of your User ID Method 2 # Click the User Settings button In the Appearance tab, check the Developer Mode option Right-click your username in a member list, and select Copy ID","title":"Finding Your User ID"},{"location":"finding-your-user-id/#method-1","text":"Enter text as if you are going to mention (ping) yourself. (Make sure that you are mentioning yourself and no one else) Insert a backslash ( \\ ) before the mention Send the message. What will appear is your ID surrounded by <@ or <@! on the left and > on the right (the message should be highlighted) Copy only the numbers; the other symbols are not part of your User ID","title":"Method 1"},{"location":"finding-your-user-id/#method-2","text":"Click the User Settings button In the Appearance tab, check the Developer Mode option Right-click your username in a member list, and select Copy ID","title":"Method 2"},{"location":"getting-a-bot-token/","text":"This page will describe, in detail, how to obtain a token for your music bot. Navigate to your Applications Page (you might need to log in first) Click the Create an application button On the General Information tab, set a Name to identify your application (this is not the bot's name) Navigate to the Bot tab and select Add Bot Click Yes, do it! Set a name and an avatar (optional) Uncheck Public Bot and Check Message Content Intent and Server Members Intents Warning If Public Bot is left checked, anyone will be able to invite your bot into servers. JMusicBot is not intended to be used as a public music bot, and will break on verified bots! Save your settings Select the Copy button in the token section to copy the bot's token to your clipboard.","title":"Getting a Bot Token"},{"location":"hosting/","text":"I want to run this bot 24/7! How can I do this? Well, there are many options available; I've described several of the most-common options below, including their pros (+) and cons (-). \ud83c\udf10 Online Hosting # OVH # + Best power-to-cost ratio + No usage limits + Reliable - No free trial DigitalOcean # + $50 credit with GitHub Student Pack (requires Credit Card and $5 down payment) + Useful tutorials + No usage limits - Poor power-to-cost ratio Google Cloud # + $300 free credit (requires Credit Card) + Free tier hosting - Billed for usage above certain limits Amazon Web Services # + 1 year free credit (requires Credit Card) - Billed for usage above certain limits \ud83c\udfe0 Home Hosting # Desktop PC # + Easiest access + Familiar OS/Environment - High electricity costs - Shared home internet bandwidth - CPU & RAM usage on main PC Dedicated Server # + Familiar OS/Environment - High electricity costs - Shared home internet bandwidth Raspberry Pi # + Low electricity costs - Shared home internet bandwidth - Possible poor performance for multiple streams \ud83d\udeab Don't Use This Hosting # Heroku # - No file write access (server settings can't be changed) - Usage limits (can only run for a portion of a month) - Poor performance Glitch # - No file write access (server settings can't be changed) - Usage limits - Poor performance Replit # - Usage limits - Poor performance","title":"Hosting"},{"location":"hosting/#online-hosting","text":"","title":"\ud83c\udf10 Online Hosting"},{"location":"hosting/#ovh","text":"+ Best power-to-cost ratio + No usage limits + Reliable - No free trial","title":"OVH"},{"location":"hosting/#digitalocean","text":"+ $50 credit with GitHub Student Pack (requires Credit Card and $5 down payment) + Useful tutorials + No usage limits - Poor power-to-cost ratio","title":"DigitalOcean"},{"location":"hosting/#google-cloud","text":"+ $300 free credit (requires Credit Card) + Free tier hosting - Billed for usage above certain limits","title":"Google Cloud"},{"location":"hosting/#amazon-web-services","text":"+ 1 year free credit (requires Credit Card) - Billed for usage above certain limits","title":"Amazon Web Services"},{"location":"hosting/#home-hosting","text":"","title":"\ud83c\udfe0 Home Hosting"},{"location":"hosting/#desktop-pc","text":"+ Easiest access + Familiar OS/Environment - High electricity costs - Shared home internet bandwidth - CPU & RAM usage on main PC","title":"Desktop PC"},{"location":"hosting/#dedicated-server","text":"+ Familiar OS/Environment - High electricity costs - Shared home internet bandwidth","title":"Dedicated Server"},{"location":"hosting/#raspberry-pi","text":"+ Low electricity costs - Shared home internet bandwidth - Possible poor performance for multiple streams","title":"Raspberry Pi"},{"location":"hosting/#dont-use-this-hosting","text":"","title":"\ud83d\udeab Don't Use This Hosting"},{"location":"hosting/#heroku","text":"- No file write access (server settings can't be changed) - Usage limits (can only run for a portion of a month) - Poor performance","title":"Heroku"},{"location":"hosting/#glitch","text":"- No file write access (server settings can't be changed) - Usage limits - Poor performance","title":"Glitch"},{"location":"hosting/#replit","text":"- Usage limits - Poor performance","title":"Replit"},{"location":"installing-java/","text":"JMusicBot requires Java 11 # Some newer builds may also work, but you could run into compatibility issues. For most platforms, the easiest method to install Java is to download the installer (as listed below). Linux users can alternatively install via the command line using a package manager. Download Installer (any platform) # Navigate to Adoptium or Oracle Download the correct installer for your system Run the installer or manually install the package (depending on your selection) Install via Command Line (Linux only) # Tip If you have multiple Java versions installed, you can use sudo update-alternatives --config java to select which will be used by default. You can run java -version to see what version is currently the default. Ubuntu # Run: sudo apt-get update && sudo apt-get install openjdk-11-jre -y Debian # Install sudo if not installed ( apt update && apt upgrade && apt install sudo ) Run: sudo apt-get install default-jre Raspbian (Raspberry Pi) # Run: sudo apt-get install oracle-java11-jdk","title":"Installing Java"},{"location":"installing-java/#jmusicbot-requires-java-11","text":"Some newer builds may also work, but you could run into compatibility issues. For most platforms, the easiest method to install Java is to download the installer (as listed below). Linux users can alternatively install via the command line using a package manager.","title":"JMusicBot requires Java 11"},{"location":"installing-java/#download-installer-any-platform","text":"Navigate to Adoptium or Oracle Download the correct installer for your system Run the installer or manually install the package (depending on your selection)","title":"Download Installer (any platform)"},{"location":"installing-java/#install-via-command-line-linux-only","text":"Tip If you have multiple Java versions installed, you can use sudo update-alternatives --config java to select which will be used by default. You can run java -version to see what version is currently the default.","title":"Install via Command Line (Linux only)"},{"location":"installing-java/#ubuntu","text":"Run: sudo apt-get update && sudo apt-get install openjdk-11-jre -y","title":"Ubuntu"},{"location":"installing-java/#debian","text":"Install sudo if not installed ( apt update && apt upgrade && apt install sudo ) Run: sudo apt-get install default-jre","title":"Debian"},{"location":"installing-java/#raspbian-raspberry-pi","text":"Run: sudo apt-get install oracle-java11-jdk","title":"Raspbian (Raspberry Pi)"},{"location":"playlists/","text":"\ud83d\udcc3 Youtube Playlists # To play a youtube playlist, all you need is the play command and a playlist link or playlist ID. Examples: # Full Playlist URL + !play https://www.youtube.com/playlist?list=PLUib4KwT0DMJaPgg_nr1ia8FY5JcXksvb # Playlist ID + !play PLUib4KwT0DMJaPgg_nr1ia8FY5JcXksvb # Not a Playlist link! (notice the `watch?v=`) - !play https://www.youtube.com/watch?v=bd2B6SjMh_w&list=PLUib4KwT0DMJaPgg_nr1ia8FY5JcXksvb&index=4 \ud83d\udcc3 Local Playlists # Local playlists are .txt files found in the Playlists folder in the same folder as you are running the bot from. Each line of the file is a new entry, and entries can be: * links to youtube videos, soundcloud tracks, or online files * full or relative path to local files * links to youtube or soundcloud playlists * links to online streams or radio * searches, prefixed by ytsearch: for a youtube search and scsearch: for a soundcloud search Lines starting with # or // are ignored for songs. To make a playlist automatically shuffle when loaded, add #shuffle or //shuffle on its own line somewhere in the playlist. Example Playlist: # This is an example playlist # You can put this in your Playlists folder as example_playlist.txt # The following line currently makes the playlist shuffle # Remove this line entirely if you don't want shuffling # shuffle # youtube playlist id: PLUib4KwT0DMJaPgg_nr1ia8FY5JcXksvb # searches ytsearch:gorillaz dare audio scsearch:lights metrognome # direct link https://www.youtube.com/watch?v=x7ogV49WGco Example Command: !play playlist example_playlist \ud83d\udcc3 Soundcloud Playlists # Just use the play command followed by the playlist link. Example: !play [link coming soon] \ud83d\udcc3 Spotify # Unfortunately, Spotify's Terms of Service prevent playing music from Spotify. Please consider using a playlist converter such as PlaylistConverter.net to convert a Spotify playlist into a YouTube playlist.","title":"Playlists"},{"location":"playlists/#youtube-playlists","text":"To play a youtube playlist, all you need is the play command and a playlist link or playlist ID. Examples: # Full Playlist URL + !play https://www.youtube.com/playlist?list=PLUib4KwT0DMJaPgg_nr1ia8FY5JcXksvb # Playlist ID + !play PLUib4KwT0DMJaPgg_nr1ia8FY5JcXksvb # Not a Playlist link! (notice the `watch?v=`) - !play https://www.youtube.com/watch?v=bd2B6SjMh_w&list=PLUib4KwT0DMJaPgg_nr1ia8FY5JcXksvb&index=4","title":"\ud83d\udcc3 Youtube Playlists"},{"location":"playlists/#local-playlists","text":"Local playlists are .txt files found in the Playlists folder in the same folder as you are running the bot from. Each line of the file is a new entry, and entries can be: * links to youtube videos, soundcloud tracks, or online files * full or relative path to local files * links to youtube or soundcloud playlists * links to online streams or radio * searches, prefixed by ytsearch: for a youtube search and scsearch: for a soundcloud search Lines starting with # or // are ignored for songs. To make a playlist automatically shuffle when loaded, add #shuffle or //shuffle on its own line somewhere in the playlist. Example Playlist: # This is an example playlist # You can put this in your Playlists folder as example_playlist.txt # The following line currently makes the playlist shuffle # Remove this line entirely if you don't want shuffling # shuffle # youtube playlist id: PLUib4KwT0DMJaPgg_nr1ia8FY5JcXksvb # searches ytsearch:gorillaz dare audio scsearch:lights metrognome # direct link https://www.youtube.com/watch?v=x7ogV49WGco Example Command: !play playlist example_playlist","title":"\ud83d\udcc3 Local Playlists"},{"location":"playlists/#soundcloud-playlists","text":"Just use the play command followed by the playlist link. Example: !play [link coming soon]","title":"\ud83d\udcc3 Soundcloud Playlists"},{"location":"playlists/#spotify","text":"Unfortunately, Spotify's Terms of Service prevent playing music from Spotify. Please consider using a playlist converter such as PlaylistConverter.net to convert a Spotify playlist into a YouTube playlist.","title":"\ud83d\udcc3 Spotify"},{"location":"running-as-a-service/","text":"Running as a service # Running JMusicBot as a service allows it to run in the background without needing to be manually started. This is useful for running the bot on a server, or if you want to be able to close your terminal without stopping the bot. Linux using systemd # Warning This method assumes that you've created a user for the bot to run as. If you haven't, see this guide for instructions. Note Copy the jar file to the home directory of the user that the bot is running as, or change the WorkingDirectory and ExecStart lines in the service file to point to the correct location. Open a terminal and run the following command to create a new service file: sudo nano /etc/systemd/system/JMusicBot.service Copy the following text into the file and save it: [Unit] Description = JMusicBot Requires = network.target After = network.target [Service] WorkingDirectory = /home/ User = Group = Type = simple ExecStart = /usr/bin/env java -Dnogui=true -jar JMusicBot.jar Restart = always RestartSec = 10 [Install] WantedBy = multi-user.target Note Replace with the name of the user that the bot is running as. Run the following command to start the bot: sudo systemctl start JMusicBot Run the following command to stop the bot: sudo systemctl stop JMusicBot Run the following command to restart the bot: sudo systemctl restart JMusicBot Run the following command to enable the bot to start on boot: sudo systemctl enable JMusicBot Linux using screen # Warning This method is not recommended for production use, see systemd instead. Install the screen utility, if it isn't already installed. Run the following command to start the bot: screen -dmS JMusicBot java -jar JMusicBot.jar Run the following command to stop the bot: screen -S JMusicBot -X quit Run the following command to restart the bot: screen -S JMusicBot -X quit screen -dmS JMusicBot java -jar JMusicBot.jar Windows # Download the NSSM executable and place it in the same directory as the JMusicBot jar file. Open a command prompt in the same directory as the JMusicBot jar file and run the following command: nssm install JMusicBot java -jar JMusicBot.jar Run the following command to start the service: nssm start JMusicBot Run the following command to stop the service: nssm stop JMusicBot Run the following command to remove the service: nssm remove JMusicBot","title":"Running as a service"},{"location":"running-as-a-service/#running-as-a-service","text":"Running JMusicBot as a service allows it to run in the background without needing to be manually started. This is useful for running the bot on a server, or if you want to be able to close your terminal without stopping the bot.","title":"Running as a service"},{"location":"running-as-a-service/#linux-using-systemd","text":"Warning This method assumes that you've created a user for the bot to run as. If you haven't, see this guide for instructions. Note Copy the jar file to the home directory of the user that the bot is running as, or change the WorkingDirectory and ExecStart lines in the service file to point to the correct location. Open a terminal and run the following command to create a new service file: sudo nano /etc/systemd/system/JMusicBot.service Copy the following text into the file and save it: [Unit] Description = JMusicBot Requires = network.target After = network.target [Service] WorkingDirectory = /home/ User = Group = Type = simple ExecStart = /usr/bin/env java -Dnogui=true -jar JMusicBot.jar Restart = always RestartSec = 10 [Install] WantedBy = multi-user.target Note Replace with the name of the user that the bot is running as. Run the following command to start the bot: sudo systemctl start JMusicBot Run the following command to stop the bot: sudo systemctl stop JMusicBot Run the following command to restart the bot: sudo systemctl restart JMusicBot Run the following command to enable the bot to start on boot: sudo systemctl enable JMusicBot","title":"Linux using systemd"},{"location":"running-as-a-service/#linux-using-screen","text":"Warning This method is not recommended for production use, see systemd instead. Install the screen utility, if it isn't already installed. Run the following command to start the bot: screen -dmS JMusicBot java -jar JMusicBot.jar Run the following command to stop the bot: screen -S JMusicBot -X quit Run the following command to restart the bot: screen -S JMusicBot -X quit screen -dmS JMusicBot java -jar JMusicBot.jar","title":"Linux using screen"},{"location":"running-as-a-service/#windows","text":"Download the NSSM executable and place it in the same directory as the JMusicBot jar file. Open a command prompt in the same directory as the JMusicBot jar file and run the following command: nssm install JMusicBot java -jar JMusicBot.jar Run the following command to start the service: nssm start JMusicBot Run the following command to stop the service: nssm stop JMusicBot Run the following command to remove the service: nssm remove JMusicBot","title":"Windows"},{"location":"setup/","text":"1\ufe0f\u20e3 Install Java # JMusicBot requires Java 11 Instructions on how to install Java on your system: Installing Java 2\ufe0f\u20e3 Download JMusicBot # Download the latest JMusicBot-X.Y.Z.jar (and optionally, example config.txt file) from the releases page (or, get the URL from the releases page and then use wget or similar command-line tool to download). Your folder should look similar to this (on desktop): Note The above image is Windows, but it should look similar on all platforms Warning Do not put this in the Downloads or Desktop . Use a folder within Documents 3\ufe0f\u20e3 Configure the bot # Create a bot account and configure it on the Discord Developer page See Getting a Bot Token for step-by-step instructions Make sure that 'Public Bot' is unchecked, and 'Message Content Intent' and 'Server Members Intent' are checked Create the config file Running the bot without a config file will prompt you for a bot token and a user ID. After you provide these, it will generate a config file for you. An example config.txt file can be found on Example Config . You can create a config.txt file in the same folder as the bot, paste the contents of the example config file, and modify the values in it. See Getting a Bot Token and Finding Your User ID if you need help with finding some values for the config. Warning You must restart the bot every time you edit config.txt . It is recommended to fully shut down the bot before editing the file. 4\ufe0f\u20e3 Run JMusicBot # Run the jar file (choose one of these options): Double-click the jar file (on desktop environments), OR Run java -Dnogui=true -jar JMusicBot-X.Y.Z.jar from the command line (replace X, Y, and Z with the release numbers) Provide the requested information, if prompted. Wait for the \"Finished Loading\" message. Tip If you want to run the bot in the background, see Running as a Service 5\ufe0f\u20e3 Add your bot to your server # When the bot starts, if it hasn't been added to any servers yet, it will provide you with a link in the console. Alternatively, follow these instructions (with images): Adding Your Bot To Your Server Tip If you run into problems, make sure to check out the Troubleshooting page!","title":"Setup Guide"},{"location":"setup/#1-install-java","text":"JMusicBot requires Java 11 Instructions on how to install Java on your system: Installing Java","title":"1\ufe0f\u20e3 Install Java"},{"location":"setup/#2-download-jmusicbot","text":"Download the latest JMusicBot-X.Y.Z.jar (and optionally, example config.txt file) from the releases page (or, get the URL from the releases page and then use wget or similar command-line tool to download). Your folder should look similar to this (on desktop): Note The above image is Windows, but it should look similar on all platforms Warning Do not put this in the Downloads or Desktop . Use a folder within Documents","title":"2\ufe0f\u20e3 Download JMusicBot"},{"location":"setup/#3-configure-the-bot","text":"Create a bot account and configure it on the Discord Developer page See Getting a Bot Token for step-by-step instructions Make sure that 'Public Bot' is unchecked, and 'Message Content Intent' and 'Server Members Intent' are checked Create the config file Running the bot without a config file will prompt you for a bot token and a user ID. After you provide these, it will generate a config file for you. An example config.txt file can be found on Example Config . You can create a config.txt file in the same folder as the bot, paste the contents of the example config file, and modify the values in it. See Getting a Bot Token and Finding Your User ID if you need help with finding some values for the config. Warning You must restart the bot every time you edit config.txt . It is recommended to fully shut down the bot before editing the file.","title":"3\ufe0f\u20e3 Configure the bot"},{"location":"setup/#4-run-jmusicbot","text":"Run the jar file (choose one of these options): Double-click the jar file (on desktop environments), OR Run java -Dnogui=true -jar JMusicBot-X.Y.Z.jar from the command line (replace X, Y, and Z with the release numbers) Provide the requested information, if prompted. Wait for the \"Finished Loading\" message. Tip If you want to run the bot in the background, see Running as a Service","title":"4\ufe0f\u20e3 Run JMusicBot"},{"location":"setup/#5-add-your-bot-to-your-server","text":"When the bot starts, if it hasn't been added to any servers yet, it will provide you with a link in the console. Alternatively, follow these instructions (with images): Adding Your Bot To Your Server Tip If you run into problems, make sure to check out the Troubleshooting page!","title":"5\ufe0f\u20e3 Add your bot to your server"},{"location":"things-that-wont-be-added/","text":"Non-Music Commands/Features # JMusicBot is a music bot, so features that have no relation to music (such as moderation or image-generation features) will not be added. If you need a bot that does things other than music, consider searching on the Discord Bots website . Spotify # Playing from Spotify is not possible, for three main reasons: 1. This would require an additional API key to look up songs on Spotify, which would be confusing for some users and overall make the bot feel more complicated to use. 2. Streaming from Spotify isn't allowed, so the bot would have to \"guess\" and just play the closest match from YouTube, which is unreliable at best. 3. Discord already has native support for syncing up Spotify playlists between users, so there's no reason to not just use that (and get better audio anyway from Spotify instead of from a Discord voice channel). Features Requiring Additional API Keys # This includes things like Spotify (as noted above), which would require users to obtain and configure more keys (beyond a Discord bot token). This process can be confusing for some users and there are other tools online that can do the job better (in most cases).","title":"Things that Won't be Added"},{"location":"things-that-wont-be-added/#non-music-commandsfeatures","text":"JMusicBot is a music bot, so features that have no relation to music (such as moderation or image-generation features) will not be added. If you need a bot that does things other than music, consider searching on the Discord Bots website .","title":"Non-Music Commands/Features"},{"location":"things-that-wont-be-added/#spotify","text":"Playing from Spotify is not possible, for three main reasons: 1. This would require an additional API key to look up songs on Spotify, which would be confusing for some users and overall make the bot feel more complicated to use. 2. Streaming from Spotify isn't allowed, so the bot would have to \"guess\" and just play the closest match from YouTube, which is unreliable at best. 3. Discord already has native support for syncing up Spotify playlists between users, so there's no reason to not just use that (and get better audio anyway from Spotify instead of from a Discord voice channel).","title":"Spotify"},{"location":"things-that-wont-be-added/#features-requiring-additional-api-keys","text":"This includes things like Spotify (as noted above), which would require users to obtain and configure more keys (beyond a Discord bot token). This process can be confusing for some users and there are other tools online that can do the job better (in most cases).","title":"Features Requiring Additional API Keys"},{"location":"troubleshooting/","text":"Known issues # There may be bugs or temporary issues with MusicBot, such as tracks not loading from specific sources, like YouTube or SoundCloud. See the Issues page and check if your issue is known. Problems starting the bot # A message stating 'A Java Exception has occurred' when I try to run the bot! Check your Java version - You might be running a version of Java that is too old. JMusicBot reqires Java 11. The .jar file is opening in WinRAR or is acting like a zipped file! Check your Java version - You might not have Java installed Set Java as the default program for .jar files - On windows, you can do this by right-clicking the .jar file, select Open with > Choose another app > Check Always use this app to open .jar files > choose the newest Java installation The bot is looking for the config file in an unexpected location! This can sometimes happen on Windows. Make sure: * Run the bot from a writable folder - Use a folder in your 'Documents', not from your Desktop. * Double-Click , don't use 'Open With' * Use Command Prompt or Powershell in the folder with the jar and use java -jar JMusicBot-VERSION_HERE.jar (replacing the version correctly) Problems using commands # The bot doesn't respond to commands! Check the bot's prefix - Look in your config file to see what you set the prefix to. The default prefix is a ping of the bot (ex: @yourbot'sname ping would run the ping command with the default prefix). Check the bot's configured intents - On the Discord Developer page, make sure that the 'Message Content Intent' is enabled. A message with a URL to your bot's specific developer page should be printed in console when starting up the bot. Check the bot's permissions in Discord - If the bot responds to the help command, but no other commands, the bot is likely missing Send Messages permissions in the text channel. If the bot can respond to ping , it has sufficient permissions to at least provide other error messages. Problems playing music # Music doesn't play if I set the volume to something other than 100! If music stops playing when you change the volume, this means that an internal library could not be loaded. This means you are either using an unsupported java version or the wrong jar file. * Check your Java version - You might be running an unsupported version. Try re-installing the latest 64-bit version of java. It seems like music is playing, but I don't hear anything! Check your Discord sound settings - Make sure that you can hear other users, or other bots Check that you don't have the bot muted - You may have muted the bot, or set its User Volume to 0% Music never starts playing! If the bot runs, but when you start to play music it never starts and is stuck at 0:00 , try some of these potential fixes: * Check your Java version - You can run java -version at the command line to check your Java version. This bot requires JDK 1.8 or higher. OpenJDK may work but is not guaranteed to provide full functionality. Also, for Windows user, make sure you are running 64-bit Java. * Check your hosting - If you are hosting the bot on a VPS (Virtual Private Server), check which company is hosting it. * Check the logs - There are a few things you can look for in the logs, but generally something like Request Timed Out means that the network connection that the bot has may be struggling and possibly unable to support streaming music. * Change your Discord voice region - Discord frequently makes changes on their end which can cause issues and/or disconnects for JMusicBot. Try changing the region to see if that helps. Error when loading from YouTube (429) If you see an error similar to \"Error when loading from YouTube 429\" when attempting to play songs from YouTube, it means that YouTube has blocked your bot's IP. Try one of these potential solutions, and see here for more information: * Change IP addresses - If you're hosting at home, you may be able to simply turn your router off and back on again. Some online hosts may offer the option to change your IP or to route through a different one. * Turn the bot off for several days - Keeping the bot offline (or only playing songs from non-youtube sources) for several days will allow YouTube to eventually remove your IP ban.","title":"Troubleshooting"},{"location":"troubleshooting/#known-issues","text":"There may be bugs or temporary issues with MusicBot, such as tracks not loading from specific sources, like YouTube or SoundCloud. See the Issues page and check if your issue is known.","title":"Known issues"},{"location":"troubleshooting/#problems-starting-the-bot","text":"A message stating 'A Java Exception has occurred' when I try to run the bot! Check your Java version - You might be running a version of Java that is too old. JMusicBot reqires Java 11. The .jar file is opening in WinRAR or is acting like a zipped file! Check your Java version - You might not have Java installed Set Java as the default program for .jar files - On windows, you can do this by right-clicking the .jar file, select Open with > Choose another app > Check Always use this app to open .jar files > choose the newest Java installation The bot is looking for the config file in an unexpected location! This can sometimes happen on Windows. Make sure: * Run the bot from a writable folder - Use a folder in your 'Documents', not from your Desktop. * Double-Click , don't use 'Open With' * Use Command Prompt or Powershell in the folder with the jar and use java -jar JMusicBot-VERSION_HERE.jar (replacing the version correctly)","title":"Problems starting the bot"},{"location":"troubleshooting/#problems-using-commands","text":"The bot doesn't respond to commands! Check the bot's prefix - Look in your config file to see what you set the prefix to. The default prefix is a ping of the bot (ex: @yourbot'sname ping would run the ping command with the default prefix). Check the bot's configured intents - On the Discord Developer page, make sure that the 'Message Content Intent' is enabled. A message with a URL to your bot's specific developer page should be printed in console when starting up the bot. Check the bot's permissions in Discord - If the bot responds to the help command, but no other commands, the bot is likely missing Send Messages permissions in the text channel. If the bot can respond to ping , it has sufficient permissions to at least provide other error messages.","title":"Problems using commands"},{"location":"troubleshooting/#problems-playing-music","text":"Music doesn't play if I set the volume to something other than 100! If music stops playing when you change the volume, this means that an internal library could not be loaded. This means you are either using an unsupported java version or the wrong jar file. * Check your Java version - You might be running an unsupported version. Try re-installing the latest 64-bit version of java. It seems like music is playing, but I don't hear anything! Check your Discord sound settings - Make sure that you can hear other users, or other bots Check that you don't have the bot muted - You may have muted the bot, or set its User Volume to 0% Music never starts playing! If the bot runs, but when you start to play music it never starts and is stuck at 0:00 , try some of these potential fixes: * Check your Java version - You can run java -version at the command line to check your Java version. This bot requires JDK 1.8 or higher. OpenJDK may work but is not guaranteed to provide full functionality. Also, for Windows user, make sure you are running 64-bit Java. * Check your hosting - If you are hosting the bot on a VPS (Virtual Private Server), check which company is hosting it. * Check the logs - There are a few things you can look for in the logs, but generally something like Request Timed Out means that the network connection that the bot has may be struggling and possibly unable to support streaming music. * Change your Discord voice region - Discord frequently makes changes on their end which can cause issues and/or disconnects for JMusicBot. Try changing the region to see if that helps. Error when loading from YouTube (429) If you see an error similar to \"Error when loading from YouTube 429\" when attempting to play songs from YouTube, it means that YouTube has blocked your bot's IP. Try one of these potential solutions, and see here for more information: * Change IP addresses - If you're hosting at home, you may be able to simply turn your router off and back on again. Some online hosts may offer the option to change your IP or to route through a different one. * Turn the bot off for several days - Keeping the bot offline (or only playing songs from non-youtube sources) for several days will allow YouTube to eventually remove your IP ban.","title":"Problems playing music"}]}
\ No newline at end of file
diff --git a/setup/index.html b/setup/index.html
index 34ddd0377..4c6ff4a92 100644
--- a/setup/index.html
+++ b/setup/index.html
@@ -14,7 +14,7 @@
-
+
@@ -380,8 +380,8 @@
-
- 3️⃣ Edit the config file
+
+ 3️⃣ Configure the bot
@@ -701,8 +701,8 @@
-
- 3️⃣ Edit the config file
+
+ 3️⃣ Configure the bot
@@ -742,6 +742,7 @@
Setup Guide
1️⃣ Install Java
+- JMusicBot requires Java 11
- Instructions on how to install Java on your system: Installing Java
2️⃣ Download JMusicBot
@@ -758,17 +759,19 @@ 2️⃣ Download JMusicBot
This can sometimes happen on Windows. Make sure:
-This can sometimes happen on Windows. Make sure:
+* Run the bot from a writable folder - Use a folder in your 'Documents', not from your Desktop.
+* Double-Click, don't use 'Open With'
+* Use Command Prompt or Powershell in the folder with the jar and use java -jar JMusicBot-VERSION_HERE.jar (replacing the version correctly)
If music stops playing when you change the volume, this means that an internal library could not be loaded. This means you are either using an unsupported java version or the wrong jar file.
-If music stops playing when you change the volume, this means that an internal library could not be loaded. This means you are either using an unsupported java version or the wrong jar file.
+* Check your Java version - You might be running an unsupported version. Try re-installing the latest 64-bit version of java.