Namdrib's (not quite) general-purpose Discord bot

Feel free to make pull requests or issues if there's anything that you think is incorrect or could be improved on

Installation

• Requires Java 8, Maven, a Discord bot token
• Copy config.properties.dummy into config.properties and replace YOUR_BOT_TOKEN_HERE with your bot token (no quotes necessary)
  • Alternatively, create an environment variable on your machine with the key DISCORD_BOT_TOKEN and set its value to be your token. This approach can be used for external hosting (e.g. deploying as a Heroku app)
• Compile using an IDE (such as Eclipse) or using the following:
  • mvn clean install
  • java -jar target/namdrib-discord-bot-jar-with-dependencies.jar

Usage

IMPORTANT: The bot must have the permission to manage roles in the server for the commands to work. It should come with some by default (from its integration), but if new modules are added (say to manage kicks/bans), then permissions need to be modified as necessary.

The prefix used to activate the bot is "@" followed by its name (can be changed in Global.java)

General

The general pattern of usage for all modules is: prefix identifier [command [arguments...]], where the [] specifies an optional argument. Invoking just the prefix will display a rudimentary help message.

• prefix list shows a list of valid linked Modules and their corresponding identifiers. The purpose of identifiers is to provide a shorthand method of accessing a linked Module. These are independent of the Module and may be changed in the source code or at linking time (see Bot.java:main).
• prefix help shows a help message.
• prefix identifier help shows a list of (case-insensitive) commands and usage for an individual module. For example, prefix role help might look like this:
  • help: display this help message
  • list: list your own roles
  • listAll: list all available roles you can add to yourself
  • addRole ROLE: add ROLE to yourself (where ROLE is in listAll)
  • addRoles ROLES...: add ROLES... to yourself (where ROLES... are in listAll)
  • removeRole ROLE: remove ROLE from yourself (where ROLE is in list)
  • removeRoles ROLES...: remove ROLES... from yourself (where ROLES... are in listAll)
  • removeAllRoles: remove all roles from yourself
  • createRole ROLE: create a role with name ROLE
  • createRoles ROLES...: create multiple roles with names ROLES...
  • membersWith ROLE: list all members to whom ROLE is assigned

Role

These role commands only apply to the person invoking them. i.e. they cannot be used to modify roles of other members. This is to prevent possible abuse of the commands.

The addition/removal of roles will not work if the role of interest is "higher or equal highest role than [the invoker]". This order is based on the the role order in the server (In server settings -> Roles, with the "first" role being the highest and "last" role being the lowest). For example, if the order is ["a", "the_bots_role", "b", "c"], then the bot may only manage roles b and c. You can use this to "protect" some roles (such as as admin/mod/elevated roles).

Deployment

Heroku

• rather than using config.properties to store the bot token, use Heroku's environment manager to create an environment variable called DISCORD_BOT_TOKEN to store the bot token.

Setting up

• See the Heroku documentation for more details
• be in the root directory of the project
• heroku git:remote -a namdrib-discord-bot
• git push heroku master Done!