Skip to content
Barnaby edited this page Feb 15, 2021 · 6 revisions

Configuring the bot

Core

TOKEN (No Default) The Discord Bot token to be used. Earliest version v0.1.0

CMD_PREFIX (Default: +) Changes the prefix of bot commands. Earliest version v0.1.0

GIF_FRAME_LIM (Default: 60) Maximum frames used in GIF transformations. Versions v0.5.0-v0.6.0

MAX_IMG_SIZE (Default: 2048) Sets the maximum size for image inputs to help improve performance (Resizes to be comply to this limit if too large). Earliest version v0.5.0

MAX_GIF_SIZE (Default: 1024) Sets the maximum size for GIF inputs to help improve performance (Resizes to be comply to this limit if too large). Earliest version v0.7.1

BOT_NAME (Default: Froge Bot) Change the name the bot uses in embeds. Earliest version v0.6.0

EMBED_COLOUR (Default: 3394611) Change the colour used in embeds (decimal colour value). Earliest version v0.6.0

USE_IMAGEMAGICK (Default: false) Whether or not to use ImageMagick instead of GraphicsMagick for image processing where applicable. Earliest version v0.7.1

Messages

MSG_PROCESSING (Default: Processing... This may take a minute.) Message displayed when a command is processing. Earliest version v0.10.0

MSG_UPLOADING (Default: Uploading...) Message displayed when a command is uploading an image. Earliest version v0.10.0

MSG_SUCCESS (Default: Success) Message displayed when a command is successful. Earliest version v0.10.0

MSG_SEND_LOCAL (Default: Failed to upload to Discord, using local web host.) Message displayed when a command uploads to the local web server instead of Discord. Earliest version v0.10.0

MSG_SEND_FAIL (Default: Failed to send) Message displayed when a command fails to send an image. Earliest version v0.10.0

MSG_ERROR (Default: Something went wrong) Message displayed when a command encounters an error. Earliest version v0.10.0

MSG_NO_IMAGE (Default: No images found) Message displayed when no images are found in the channel. Earliest version v0.10.0

MSG_CAT (Default: Cat) Message displayed when the cat command is successful. Earliest version v0.10.0

Web

WEB_ENABLED (Default: false) Whether to enable to local web server for hosting images which couldn't be uploaded to Discord. Earliest version v0.9.2

WEB_PORT (Default: 80) The port to be used by the local web server. Earliest version v0.9.2

WEB_HOSTNAME (Default: localhost) The hostname to be used for Discord embeds. Note: Must be changed to a public address/hostname for full functionality. Earliest version v0.9.2

WEB_SECURE (Default: false) Whether to use https:// for Discord embeds, do not set to true unless https:// is available (e.g. if using Cloudflare proxy) as the local web server only hosts http. Earliest version v0.9.2

WEB_SAVE_MINS (Default: 30) How long to store images hosted locally Note: Images are also cleared when the node instance closes. Earliest version v0.9.2

WEB_REFRESH_CACHE (Default: false) If enabled will append a random hash to the image URLs in Discord embeds to refresh the cache if the images are not showing correctly. Earliest version v0.9.2

Misc

ENABLE_SUPER_SECRET_TROLE_COMMANDS (Default: false) Whether or not to enable fake commands (e.g. booba). Earliest version v0.10.0

Music

MUSIC_ENABLED (Default: false) Whether or not to enable music commands. Earliest version v0.12.0

YOUTUBE_API_KEY (Default: "") Youtube Data API v3 API key (required for music commands). Earliest version v0.12.0

MSG_VIBING (Default: "") The message to show when a music command runs. Earliest version v0.12.0

MSG_UNVIBING (Default: "") The message to show when a music error occurs. Earliest version v0.12.0

SKIP_PERCENT (Default: 50) The percentage of listeners required to skip. Earliest version v0.12.0

USE_MUSIC_ROLE (Default: true) Whether to to enable use of a role for music mod commands. Earliest version v0.12.0

MUSIC_ROLE_NAME (Default: DJ) The name of the role to use for music mod commands. Earliest version v0.12.0


.env.example (v0.12.2)

TOKEN=
CMD_PREFIX=+
MAX_IMG_SIZE=2048
MAX_GIF_SIZE=1024
BOT_NAME=FrogeBot
EMBED_COLOUR=3394611
USE_IMAGEMAGICK=false

MSG_PROCESSING=Processing... This may take a minute.
MSG_UPLOADING=Uploading
MSG_SUCCESS=Success
MSG_SEND_LOCAL=Failed to upload to Discord, using local web host.
MSG_SEND_FAIL=Failed to send
MSG_ERROR=Something went wrong
MSG_NO_IMAGE=No images found
MSG_CAT=Cat

WEB_ENABLED=false
WEB_PORT=80
WEB_HOSTNAME=localhost
WEB_SECURE=false
WEB_SAVE_MINS=30
WEB_REFRESH_CACHE=false

ENABLE_SUPER_SECRET_TROLE_COMMANDS=false

MUSIC_ENABLED=false
YOUTUBE_API_KEY=
MSG_VIBING=
MSG_UNVIBING=
SKIP_PERCENT=50
USE_MUSIC_ROLE=true
MUSIC_ROLE_NAME=DJ
Clone this wiki locally