jagrosh/MusicBot 0.2.0

Version 0.2.0

on GitHub

This update is an update to the bot's internals (performance and code quality) as well as the usage of a new configuration format.

What's fixed?

• dependencies are now up-to-date
• some edge-cases with blocking should be fixed

What's new?

• overhauled internals in preparation for expanding features easier in the future
• automatic DM to the bot owner when a new version is available (can disable in config)
• new flag to start in no-gui mode (see below)
• new config format, old configs will likely not work

The new configuration

The new JMusicBot configuration is now in the HOCON format.

Migrating your config.txt

For the most part, migrating your existing config.txt file is easy; putting the prefix and emojis in double quotes should be sufficient. See the example config for a template. For example, if you previously had

prefix=!!

you will need to change this to

prefix="!!"

More configuration power!

Now you can specify an alternative location to look for your config file (and it can be named whatever you want). Simply include a -Dconfig=/path/to/config/file flag before the -jar flag. You can also set any configuration option (instead of put it in the config file) in a similar format. For example, to set the prefix from the command line instead of the config file, add a -Dprefix=!! flag before the -jar flag.
Ex:

java -Dconfig=myconfig.txt -Dprefix=! -jar JMusicBot-0.2.0.jar

would look for a file called 'myconfig.txt' instead of 'config.txt', and the bot would use the prefix ! (the command line takes precedence over the config file if you set something in both).

New flags

As noted in the above configuration section, the latest release implements a change in how flags are provided.

Previously...

The only available flag was -nogui which was placed after the name of the jar and would start the bot without starting a separate window.

Now...

All flags must come before the -jar flag (after the java) and begin with -D. Notable flags include:

• -Dnogui=true disables the gui (same as what -nogui did before)
• -Dconfig=/path/to/configfile sets the file to look for as a config file
• -Dsettingname="some value" sets anything that is normally settable via the config file
  You can use as many or as few flags as you wish; just remember not to lose the -jar as the last flag before the name of the jar.

Setup

https://github.com/jagrosh/MusicBot/wiki/Setup

What to download?

Download one of the following:

• JMusicBot-0.2.0,jar (this version works on all platforms)
• JMusicBot-0.2.0-Windows.jar
• JMusicBot-0.2.0-Linux.jar
• JMusicBot-0.2.0-Mac.jar

Download config.txt if you don't have an existing config or want to use a template instead of migrating a previous version of the config

Download example_playlist.txt only if you need an example for how to set up the playlist. If you download this, put it in a "Playlists" folder.

Your folder should look like this (except use the correct version number):

Remember, please do not put these files on your desktop or anywhere restricted. Putting them together in a folder in your "My Documents" folder is the best option.

DO NOT DOWNLOAD THE SOURCE CODE .zip/.tar.gz. DO NOT DOWNLOAD ANY .java FILES. PLEASE READ ABOVE WHAT YOU NEED TO DOWNLOAD.