A Discord bot that creates, manages, and assorts monologue channels. The intention is to give guild users a place to rant, post cool things, or just announce their accomplishments.
The bot can be configured to take a random monologue entry and post it to a chosen channel however often you like. It can also sort the channels based on recent activity.
The bot is controlled using slash-commands:
/create: Create a monologue channel for yourself/create_for <user>: Create a monologue channel for<user>*/remove: Remove your monologue channel/remove_for <user>: Remove the monologue channel for<user>*/random: Draw a random monologue from any time/trigger: Trigger a new random monologue draw. This only pulls messages sent since the last invocation or scheduled trigger *
* admin only command
mawnolaug can be configured via a TOML file or environment variables, or both. Environment variables always take precedence.
This file is expected at mawnolaug.toml in the working directory unless a location is specified using the MAWNO_CONFIG environment variable.
# (required)
token = "your discord token"
# (optional, default = "8")
# see "Admin Commands" for an explanation
admin_permissions = "8"
# (required)
# the location of the bot state
state_dir = "/path/to/state_directory"
# this section is optional, though setting `category_id` is highly recommended.
[monologues]
# (optional, no default)
# the Category within which monologue Channels will be created. setting this is
# highly recommended to avoid littering your server
category_id = 1234567890123456
# (optional, default = false)
# set to true to allow anyone to post in any monologue channel. only applies to
# channels created after the setting is changed.
allow_anyone = false
# (optional, default = false)
# disable automatic sorting of monologue channels based on activity. requires
# `category_id`. see the "Automatic Sorting" section for information
disable_sorting = false
# this section is optional. if not defined, random draws will be disabled.
# any fields within marked "(required)" are only required if this section is specified.
[random_draw]
# (required)
# this is the Channel that random monologues will be posted to
channel_id = 1234567890123456
# (required)
# a cron expression representing a schedule for random draws. see
# https://crontab.guru/ for help with these expressions (note: the schedule
# parser requires 6 or 7 segments while crontab.guru only shows 5).
# format:
# <sec> <min> <hour> <day_of_month> <month> <day_of_week> [year]
schedule = "0 0 10,16,22 * * * *" # do random draws at 10am, 4pm, and 10pm local time
# (optional, default = OS timezone)
# the timezone to use as local time instead of the OS defined timezone.
# this is useful if the bot is running in a docker container or distant server.
# this is used for the random draw schedule
timezone = "America/Los_Angeles"
# (optional, no default)
# a set of messages to prefix the random draw with. a random message will be chosen
# each time a new random draw occurs. see the "Message Templates" section for
# information on the template syntax. an empty string is valid and, when randomly chosen,
# will produce the same output as omitting this field entirely.
messages = [
"Look what {author} found:",
"At {timestamp:t}, {author} said:",
]The following environment variables are equivalent to the above config:
MAWNO_TOKEN="your discord token"
MAWNO_ADMIN_PERMISSIONS="8"
MAWNO_STATE_DIR="/path/to/state_directory"
MAWNO_MONOLOGUES_CATEGORY_ID="1234567890123456"
MAWNO_MONOLOGUES_ALLOW_ANYONE="false"
MAWNO_MONOLOGUES_DISABLE_SORTING="false"
MAWNO_RANDOM_DRAW_CHANNEL_ID="1234567890123456"
MAWNO_RANDOM_DRAW_SCHEDULE="0 0 10,16,22 * * * *"
MAWNO_RANDOM_DRAW_TIMEZONE="America/Los_Angeles"
MAWNO_RANDOM_DRAW_MESSAGES="['Look what {author} found:', 'At {timestamp:t}, {author} said:']"mawnolaug supports reading environment variables from a .env file in the current directory.
By default, commands marked as "admin only" can only be triggered by a user with the Administrator permission. Handing this permission out is generally a bad idea, so you can choose which member permissions are required to trigger the admin only commands.
Before trying to decide on a value for this, you might read the Permissions documentation to get a better understanding of how this value works. The permissions bitfield is stored as a string as-per the above documentation.
To configure the permissions required, simply set the admin_permissions option to your chosen permissions integer. A few examples are:
# 1 << 4 (0x10)
admin_permissions = "16" # require the Manage Channels permission
# or
# 1 << 5 (0x20)
admin_permissions = "32" # require the Manage Guild permissionNote: This option only configures the default permission required for the admin commands. You can still manage the permissions of each command in your server's settings page.
The random_draw.messages array in the config supports a few simple templates:
{author}: @mention the message author{author.name}: The author's display name{author.id}: The user ID of the author{channel}: #mention the author's monologue channel{channel.id}: The channel ID of the author's monologue channel{timestamp:<style>}: The timestamp of the message with the specified style. See Discord Timestamp Styles for a list of valid styles. Note that in this template, unlike Discord, the timestamp style is not optional and it will not work without specifying a valid style
There is currently no {channel.name} because that would require an additional API call.
If the monologues.category_id setting is specified and the monologues.disable_sorting option is unspecified or false, mawnolaug will automatically sort monologue channels based on activity. When someone sends a message into their monologue channel, mawnolaug will move that channel to the top of the specified category ID.
Setting monologues.disable_sorting to true will disable this.