FAXES Documentation > Overflow Bot > Configuration Documentation

Configuration Documentation

FAXES

Below you will find what each configuration option is and what it does, it’s default value and other information. Each section refers to a section in the config file.

To get a user, role, or channel ID make sure you have developer mode enabled. If you are having trouble getting developer mode head to this guide - Where can I find my User/Server/Message ID - Discord Support

Bot Setup

Variable Name Description Type Default Value
prefix Prefixes used for bot commands. Array ["."]
token Discord bot token used to have the bot login to the API. String "YOUR_DISCORD_TOKEN"
copyright The footer copyright text used in the bot String "© 2020 Your Discord Name"
bot_status The online status to display as the bot. See PresenceStatus for a list of display types. String "online"
bot_game_type The game type to display. Can be set to either PLAYING or WATCHING. String "PLAYING"
bot_game The game or activity to display the bot doing. String "Some_Game_Presence"
feature_color The color used in most bot embeds. See example here. String/Hex Color "#ff0000"
debug_mode When debug mode is enable many actions from within the code are triggered and printed into the console to help resolve potential issues. Boolean false

DB (Database) Setup

Variable Name Description Type Default Value
usedb If true the bot uses an installed database (SQL). If false uses a JSON database format. For bigger Discord guilds it's recommended to have this as true to prevent data-loss. Boolean false
dbhost The remote server to use. This should be an IP for a server or if it's the machine then use localhost String "localhost"
dbuser The username used for the SQL login. String "username"
dbpassword The password used for the SQL login. String "password"
dbname The database name which contains the SQL tables. String "database"

Greet Module

Variable Name Description Type Default Value
enabled Enable this module Boolean false
display_setting The join and leave message display. 1 = text, 2 = embed, 3 = image With embed, without embed, with image Number 2
welcome_channels Channels by ID where welcome messages will be placed. Array [""]
leave_channels Channels by ID where leave messages will be sent. Array [""]
welcome_message The message sent after the user tag on welcome messages. String "has joined the Discord."
leave_message The message sent after the user tag on leave messages. String "has left the Discord."

Auto Role Module

Variable Name Description Type Default Value
enabled Enable this module Boolean false
join_roles Roles by ID that are given to users when they join the guild. Array [""]

Admin Management

See Custom Permissions for more details on these.

Variable Name Description Type Default Value
owner_roles Roles by ID that have the custom owner permission. Array [""]
admin_roles Roles by ID assigned that use the custom admin permissions. Array [""]
staff_roles Roles by ID that have the custom staff permission set. Array [""]
use_custom_perms Whether to use the custom permissions. See Custom Permissions for more information. Boolean true
owner_rank_display_name The display name used for the owner roles. This doesn't need to be the role name. String "Owner"
admin_rank_display_name The display name used for the admin roles. This doesn't need to be the role name. String "Administrator"
staff_rank_display_name The display name used for the staff roles. This doesn't need to be the role name. String "Staff"
enable_user_statistics Enables user statistics like total message count, kicks, bans, joins and more (https://faxes.zone/i/uq1yt.png) Boolean true

Moderation Module

Variable Name Description Type Default Value
enabled Enable this module Boolean false
mute_role The role ID for the mute role. This role will be assigned when a user is muted. String ""
dm_kicked_user DM users that are kicked with their reason. Boolean false
dm_banned_user DM users that are banned with their reason. Boolean false
dm_muted_user DM users that get muted with the amount of time they're muted for. Boolean false
dm_warned_user DM users that get warned with their reason. Boolean false
anti_spam_filter Enable a basic spam filter that disallows repeated messages by the configured amount. Boolean false
spam_max_messages The amount off messages that can contain the same content before being marked as spam and deleted. Number 4
anti_spam_reply The message sent when spam is detected. This message self deletes after a few seconds. String "Message deleted for spam."

Logging Module

Variable Name Description Type Default Value
enable_deleted_messages_logging Toggles deleted message logs Boolean false
deleted_messages_channels Channels by ID where deleted message logs will be sent. Array [""]
enable_edited_messages_logging Toggles edited message logs Boolean false
edited_messages_channels Channels by ID where edited message logs will be sent. Array [""]
enable_role_change_logging Toggles role change logs Boolean false
role_change_channels Channels by ID where role change logs will be sent. Array [""]
enable_command_logging Toggles commands being logged. Commands and their arguments will be logged. Boolean false
command_logging_channels Channels by ID where command logs will be sent. Array [""]
enable_channel_change_logging Toggles channel changes being logged. Boolean false
channel_change_channels Channels by ID where command logs will be sent. Array [""]
enable_kick_logging Toggles kicks being logged. Boolean false
kick_channels Channels by ID where kick logs will be sent. Array [""]
enable_ban_logging Toggles bans being logged. Boolean false
ban_channels Channels by ID where ban logs will be sent. Array [""]
enable_warn_logging Toggles warnings being logged. Boolean false
warn_channels Channels by ID where warnings logs will be sent. Array [""]
enable_mute_logging Toggles mutes being logged. Boolean false
mute_channels Channels by ID where mute logs will be sent. Array [""]
enable_unban_logging Toggles unbans being logged. Boolean false
unban_channels Channels by ID where unban logs will be sent. Array [""]

Utility Module

Variable Name Description Type Default Value
enabled Enable this module Boolean false
about Description about your guild. This is displayed in the help command. String "Put your description about your Discord here."
member_count_channel_enabled Enables the member count voice channel. Boolean false
member_count_channel The voice channel ID for the member count to display in. String ""

Language Module

Variable Name Description Type Default Value
enabled Enable this module Boolean false
filter_words Words or terms that are blacklisted from being used by users without and exception role. See below for a handy list of common curse words. Array [""]
bypass_roles Role IDs that bypass the language filter terms above. Array [""]

Handy list of common curse words for 'filter_words'

["bitch", "biatch", "fag", "feck", "fucker", "fucking", "fuck", "f u c k", "pussy", "queer", "slut", "whore", "mofucker", "retard", "cock", "cuk", "nigger", "nigga", "niger", "n1gga", "negro", "nig nog", "nigaboo", "niglet", "n1g n0g"]

Levelling Module

Variable Name Description Type Default Value
enabled Enable this module Boolean false
gain_extra_xp_from_attachments Whether users gain extra XP points for messages with attachments. Boolean false
amount_added_from_attachments Additional amount of XP to add for attachments. Only works if above is true. Number 20
gain_extra_xp_from_longer_messages Whether users gain extra XP points for messages with over 800 characters. Boolean false
amount_added_from_longer_messages The amount added for messages longer than 800 characters. Only works if above is true. Number 100
enable_rank_command Enable the rank command so users can view their chat level and XP. Boolean true
enable_rank_command_image Enable an image to be displayed for the users XP/Rank (https://faxes.zone/i/1rtg1.png) Boolean true
enable_level_up_messages Enables level up messages to be displayed when users level up. Boolean true
enable_level_up_embeds Enables embeds instead of regular text for level up messages. Boolean false
levelup_messages Level up messages displayed after the users handle. If there's multiple one is selected at random from the group. Array ["You have levelled up!", "Congrats, you've levelled up."]
remove_levels_on_leave If true a users chat levels will be removed when they leave the Discord meaning that if they return their xp is reset. Boolean false
remove_levels_on_removal When true if a user is kicked or banned via commands their xp will be deleted. Boolean false
below_10_rank_name Display term used for users that are below level 10. String "Novice Member"
above_10_rank_name Display term used for users that are level 10 and above. String "Basic Member"
above_25_rank_name Display term used for users that are level 25 and above. String "Junior Member"
above_50_rank_name Display term used for users that are level 50 and above. String "Member"
above_75_rank_name Display term used for users that are level 75 and above. String "Senior Member"
above_100_rank_name Display term used for users that are level 100 and above. String "Regular"
above_150_rank_name Display term used for users that are level 150 and above. String "Leader"
above_200_rank_name Display term used for users that are level 200 and above. String "Veteran Member"
above_250_rank_name Display term used for users that are level 250 and above. String "Expert"
above_300_rank_name Display term used for users that are level 300 and above. String "Expert"
above_500_rank_name Display term used for users that are level 500 and above. String "Legend"

Ticket Module

Variable Name Description Type Default Value
enabled Enable this module. Boolean false
support_roles Role IDs that are able to see in support tickets. Array [""]
ticket_category The Category ID for tickets to be moved too. This must be set. String ""
custom_question_one If this is not empty then the specified question will be asked in the ticket channel before generating a ticket. String ""
custom_question_two If this is not empty then the specified question will be asked in the ticket channel before generating a ticket. Requires question one to be set String ""
custom_question_three If this is not empty then the specified question will be asked in the ticket channel before generating a ticket. Requires question one and two to be set. String ""
enable_archive Enable the ticket archive feature. Boolean false
archive_file_channels Channels by ID where generated html files will be placed. Array [""]

Auto Reply Messages

Variable Name Description Type Default Value
enabled Enable this module Boolean false
ignore_tickets Whether to ignore ticket channels of these replies. Boolean false
messages An built array of auto reply messages. All of the below options must have a setting. Array []
messages.contains If the users message can contain the auto reply messages.content. If set to false the whole user message must be exact to messages.content. Boolean true
messages.deleteOP Whether to delete the users message. Boolean false
messages.content The content needed for a users message for the auto reply to action. String ""
messages.reply The content to reply as the auto message. String ""

This is an example a messages array

"messages": [
    {"contains": false, "deleteOP": false, "content": "hi", "reply": "Hey there!"}
    {"contains": true, "deleteOP": true, "content": "delete me", "reply": "Your message deleted!"}
]

DM User Module

Variable Name Description Type Default Value
enabled Enable this module Boolean false
use_embeds If true embeds will be used in the log messages instead of plain text. Boolean false
log_bot_dms_channels Channels by ID that DM logs will be sent. Array [""]

Auto Reaction Module

This module was added in update 1.3 and allows the bot to automatically react to all messages in a defined channel with a defined emoji.

Variable Name Description Type Default Value
enabled Enable this module Boolean false
channels Array of auto react channels and emojis. All of the below options must have a setting. Array []
channels .channelId Thhe channel Id to auto react to all messages in. String ""
channels .reaction The reaction to react with. Can be an emoji (eg; ✅) or custom emoji Id. String ""

Command Permissions

See Custom Permissions for more details on these and the number representation.

Variable Name Description Type Default Value
ban_needed_perm Needed permission for the ban command Number 2
unban_needed_perm Needed permission for the unban command Number 2
kick_needed_perm Needed permission for the kick command Number 3
mute_needed_perm Needed permission for the mute command Number 3
warn_needed_perm Needed permission for the warn command Number 3
unwarn_needed_perm Needed permission for the unwarn command Number 3
userinfo_needed_perm Needed permission for the userinfo command Number 3
say_needed_perm Needed permission for the say command Number 3
sayem_needed_perm Needed permission for the sayem command Number 3
clear_needed_perm Needed permission for the clear command Number 3
new_needed_perm Needed permission for the new command Number 4
close_needed_perm Needed permission for the close command Number 3
help_needed_perm Needed permission for the help command Number 4
sinfo_needed_perm Needed permission for the sinfo command Number 4
ping_needed_perm Needed permission for the ping command Number 4
poll_needed_perm Needed permission for the poll command Number 3
uptime_needed_perm Needed permission for the uptime command Number 4
leaderboard_needed_perm Needed permission for the leaderboard command Number 4
rank_needed_perm Needed permission for the xp/rank command Number 4
message_needed_perm Needed permission for the msg command Number 2
set_status_needed_perm Needed permission for the setstatus command Number 3
archive_needed_perm Needed permission for the archive command Number 3