PolarizedBot

A work in progress discord bot

How to use

Click the Add Bot button above (or click here) to add the bot to your discord guild. You must have the Manage Server permission to do so.

The default command prefix is !, you can change it via !guild set prefix <your prefix here>. You must be a guild admin to do this. See the bot permissions explanation below for more details.

There are also a few "autoresponders" active by default. These can be disabled via the !guild disable responder ... command. See the command explanation below for more details.

Bot permissions

There are essentially three ranks that the bot assigns a discord user. Global Admin, Guild Admin, and Default in that order. Only some commands are available to Default rank users, while most commands, including the !guild command, can be performed by the Guild Admin rank. The Guild Admin is labeled publicly as Moderator.

The bot will automatically assign Guild Admin to the server owner when the bot joins. They can then assign ranks to other members via the !guild mod/unmod... command. NOTE that the Global Admin rank CANNOT be assigned via the command. It is a bot config setting.

Global Admins have their ranks applied, as the name suggests, globally, meaning they'll have that rank in any guild the bot is in, whereas the Guild Admin rank is set per guild.

Commands

Below is a list of all commands the bot currently has, along with their usages, required permissions, and a brief description. Text between <angle brackets> indicate a required argument, while text between [square brackets] indicate an optional one. Slashes (/) indicate an or.

• About
  Usage: !about, !info
  Description: About gives info about the running bot, while info gives info about the user running the command.

• Announcer
  Usage: !announce <list/guild>, !announce <subscribe/sub/unsubscribe/unsub> [#channel] <announcer>
  Requires: Guild Admin Rank
  Description: Manages the announcers for a guild.

  • !announce list will list the available announcers the bot has.
  • !announce guild will list the guild's subscriptions .
  • !announce <sub/unsub> ... will subscribe or unsubscribe a specified channel (or current one) to/from a announcer.

• Guild
  Usage: !guild set <prefix/lang> <value>, !guild mod <@user>, !guild <enable/disable> <responder/announcer> <value>
  Requires: Guild Admin Rank
  Description: Manages different parts of the guild's settings

  • set prefix changes the prefix for bot commands. Can be any character & length.
  • set lang changes the guild's language. Currently only en (English) is supported, but in the future, hopefully, more will be available.
  • mod/unmod <@user> adds/removes the user as a guild moderator
  • enable/disable responder enables/disables the autoresponder for the guild
  • enable/disable announcer enables/disables a responder globally for the guild

• Help
  Usage: !help, !help <command>
  Description: Lists available commands, or give help regarding a specific one.

• Ignore
  Usage: !ignore, !ignore <@person>, !unignore <@person>
  Requires: Default Rank (!ignore), Guild Admin Rank (!ignore <@person>, !unignore <@person>)
  Description: Tell the bot to ignore you (!ignore), another person (!ignore <@person>), or to unignore them (!unignore <@person>).

• Invite
  Usage: !invite
  Description: Gives the bot-invite link.

• Ping
  Usage: !ping, !pong
  Description: Ping/Pong. Check that the bot is active, and it's latency.

• Say
  Usage: !say [@channel] <message>, !tell <@person> <message>
  Description: Say something as the bot in a specified (or current) channel, or PM someone something.

• Shutdown
  Usage: !shutdown, !restart, !restart <hard/soft>
  Requires: Guild Admin Rank
  Description: Shutdown exits the bot. "Hard" restart relaunches the bot, while a "soft" restart reconnects. "Soft" is the default for restarting.

• Update
  Usage: !update
  Requires: Guild Admin Rank
  Description: Downloads the latest version of the bot from github and restart it with the new version.

• WolframAlpha
  Usage: !wolf <question>, !calc <question>
  Description: Query WolframAlpha with a question. Wolf returns the full result, while calc only does the first one.

Announcers

Announcers are ways to notify you that an event has happened, whether someone tweeted, went live, a game released an update, or more. You can enable/disable announcers via the !announce command.

Currently, there are only two announcers implemented, more will be added in the future.

Minecraft

Notifies you when a new Minecraft (Java Edition) snapshot or full release is made available to the launcher.

GW2

Notifies you when a new update was posted to the Guild Wars 2 forum

Autoresponders

Autoresponders are basically what they say, they are ways the bot automatically responds to certain messages, without invoking a specific command. Autoresponders can be enabled/disabled via the !guild disable responder ... command.

Currently there are two implemented, both enabled by default:

Temperature

Converts temperatures (Celsius & Fahrenheit) to their respective counterparts. Useful when you have a server with people from different background that use different units.

Measurement

Converts between different units of measurement (Imperial <--> Metric), eg. in,ft,yd,mi <--> mm,cm,m,km. Useful when you have a server with people from different background that use different units.

Setting it up yourself

Setting up your own version of the bot should be straight forward. Once you have cloned the repo, run it once to generate the config files:

java -jar polarizedbot-0.2.5-jar-with-dependencies.jar

This should have created a folder called config, with a file in it called bot.json. It will also have errored, saying you need to provide a owner id & bot token. The bot.json is what is referred to as the "Global config" (in contrast to "Guild configs", which only apply to a specific server.)

Go ahead, and if you haven't already, create a Discord Bot by going here, and clicking "Create application". Once that is done, add a bot user to that application. Once that is done, you have the first piece of needed information: your bot token, labeled just as "token" on the bot page.

Next, you'll need your user id. Enable Developer Mode and copy your own User ID, as described in the help article.

You can go ahead and customize the other settings if you'd like, and start the bot again with the same command above.

Config file

Example filled out config file:

{
  "owner": "123321",
  "wolframAlphaApi": "123A-BCDEFG789",
  "botToken": "123456789.abcdef.ghijklmnm",
  "presenceDelay": 300,
  "presenceStrings": [
    "Serving {guilds-num} guilds dutifully",
    "Playing with {owner-name}\u0027s chemicals",
    "Napping..."
  ]
}

owner: The Discord user id of the owner
wolframAlphaApi: An api key for WolframAlpha. Obtainable here. Required for !calc & !wolf to work.
botToken: The login token for the bot you got from discord.
presenceDelay: Delay for cycling between presense messages.
presenceStrings: Messages to be displayed as the presence.
Available formatting keys:

• {bot-name} eg. PolarizedBot
• {bot-name-full} eg. PolarizedBot#2060
• {owner-name} eg. PolarizedIons
• {owner-name-full} eg. PolarizedIons#9928
• {guilds-num} eg. 5

Commandline arguments

Commandline arguments are added to the end of the launching command to modify the bot's behaviors, eg:

java -jar polarizedbot-0.2.5-jar-with-dependencies.jar --config botdata

--log

Sets the log level example: --log debug, --log info, --log warn, --log error

--config

Sets the directory used for config files example --config ../../bot_config, --config botconfigstuff