INFO

Bot made for a local Discord server. Can (non-exhaustively):

• Add specific role to a user that reacts with a specific emoji to a specific message
• Respond to some command under format !command Bot written in node.js.

Dependencies

• npm
• Node.js
• discord.js
• node-config
• node-cron

Install and use

Create and invite Bot

Check out Discord's documentation for how to create a bot account for your server. Once it's done, invite the bot to the server (only possible by user with "manager server" permission) by using a link formatted as follow: https://discordapp.com/oauth2/authorize?client_id=YOUR_CLIENT_ID&scope=bot&permissions=PERMISSION_INTEGER Where YOUR_CLIENT_ID can be found on the discord application page, and the PERMISSION_INTEGER can also be computed from there ('Bot' section).

Be sure to note your bot's TOKEN from the bot section.

Configure bot

(deprecated, see next section)

Configure the bot by filling appropriately the config/default.json file. The token field is your bot's previously obtained token. All the IDs can be found from your Discord App, by switching to developer mode.

Alternatively, you can configure the bot using the NODE_CONFIG env variable:

export NODE_CONFIG='{"StrashBot":{"version":"0.1.0","build" … }}'

Also, you can configure individually every variable by setting each variable listed in the config/custom-environment-variables.json file as env variables. For example (linux):

export STRASHBOT_VER="0.1.5b"
export STRASHBOT_BUILD="custom-build"
…

Install script

First, copy the file extras/values.txt at the root of the repository,

cp ./extras/values.txt .

then fill in the blank values using any text editor.

To install the bot you'll need admin privileges.

You then need to call the install script (from the root of the repository):

sudo ./install.sh

Launch bot

(deprecated)

node bot.js

systemd

The bot is now managed as a systemd service. Using you admin privileges:

sudo systemctl start strashbot.service

Misc.

Persistent Data

To work properly, this bot saves configuration data on the disk as persistent data. This data is stored under JSON format, in the following manner:

• global configuration data will be saved in: data/guildConfigs.json
• data generated and accessed by specific bot-modules are stored per module per guild under data/commands/{name}_{guild_id}.json.

Bot-modules

Bot-modules are code that is loaded dynamicaly during the bot's launch. These modules are located is the js/commands folder the following name format: cmd_{name}.js. In order for a module to work, it must fulfill certain requirements; check js/commands/cmd_template.js for a minimalistic example.

Release and use

This bot was made for personal needs and use. The code is release on the off chance it might be of use to someone but without the intention of providing any form of utility software or service in a rigorous manner. Therefore, no support is endorsed by the developer, meaning that any comment, feedback, or request regarding this code should be expected to be completely ignored by the developer. Additionally, the responsibility of any undesired effect the execution of this bot might have on any system lies solely in the hands of the user.

From Strasbourg, with love.