New: Allow bot-owners to change the presence message

Fixes #34
TannDev · Oct 28, 2020 · 797aeae · 797aeae
1 parent efce033
commit 797aeae
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/discord-bot/discord-bot.js b/discord-bot/discord-bot.js
@@ -20,8 +20,8 @@ const client = new Client({
     },
     presence: {
         activity: {
-            name: '`!sau-rollcall`',
-            type: 'LISTENING'
+            name: process.env.CUSTOM_PRESENCE_NAME ?? '`!sau-rollcall`',
+            type: process.env.CUSTOM_PRESENCE_TYPE ?? 'LISTENING'
         }
     }
 });

diff --git a/docs/host-your-own-bot.md b/docs/host-your-own-bot.md
@@ -28,13 +28,15 @@ Before you can run your own bot, you'll need to create a Discord application.
 1. Take the bot token you generated earlier and configure your bot with the instructions below.
 
 ## Environment Variables
-The bot uses a couple environment variables:
+The bot uses several environment variables:
 - `DISCORD_TOKEN`: The bot token for your Discord application. (Required)
 - `DATABASE_USERNAME`: The username for the bundled (or remote) CouchDB database. (Required)
 - `DATABASE_PASSWORD`: The password for the bundled (or remote) CouchDB database. (Required)
 - `PORT`: Which port the API app should listen on. (Default: '8080')
 - `HOST`: The _external_ host where the server will listen. (Default: 'localhost:${PORT}')
 - `SECURE`: Whether the bot is available via HTTPS. (Default: 'false')
+- `CUSTOM_PRESENCE_NAME`: A custom presence message to display. (Default: '`!sau-rollcall`')
+- `CUSTOM_PRESENCE_TYPE`: (Optional) The [type of presence](https://discord.js.org/#/docs/main/stable/typedef/ActivityType) to display. (Default: 'LISTENING')
 
 _Note:_ The server doesn't include SSL natively, but can be placed behind an appropriate proxy such as nginx.
 In this case, set `PORT` to the _actual_ port used by the server, but set `HOST` and `SECURE` to the values that your users will use.