Ctrl+K

⚙ Server configuration

⚙ Server configuration#

Config options#

Recently, Axobot has features that can be modified per server, to make each server unique. You will find the language of the bot, the activation of certain options (such as the xp system), the list of roles authorized to use certain commands (ban, clear…), the welcome messages, and many other options.

The list of options continues to grow as development progresses, that’s why a website is planned to make server configuration easier.

Watch#

Syntax: config see [option | page]

The see subcommand allows you to see the value of a configuration, with a mini explanatory sentence. If no option is specified, the entire configuration will be displayed in a single message. Note that the bot can suffer a slight latency since this data is stored in an external database.

The page number is used because the options are too numerous to be displayed on a single screen. They have therefore been grouped by page of 20, accessible via this number (default 1).

A detailed list of all options is available below .

Warning

To display this command correctly, Axobot only needs Embed links permission.

Syntax: config list

This command will give you a list of all the bot configuration options, in case you are looking for a specific name, or if you just want to make sure you know them all. However, no details will be given, to know what these options are used for you will have to go to the documentation.

Modify#

Syntax: config set <option> <value>

This subcommand allows you to modify the value of an option. Just enter the exact name of the option and its value. A validation message will then be sent if the request has been correctly executed.

If the value contains several objects, such as a list of roles or channels, they must be separated by spaces, like this: config set clear_allowed_roles Admin Moderators @Special. Please note that not all configurations support multiple values (for example, it is not possible to have multiple prefixes).

Note

When the value takes the form of roles, for more comfort you are not obliged to mention them: the exact name (as long as it doesn’t contain spaces) or the identifier of the role is enough. The same goes for channels or emojis.

Delete#

Syntax: config del <option>

This subcommand can be useful to reset an option to its default value. By executing this command, the option will be deleted and will take the same value as originally.

List of every option#

  • anti_caps_lock: Boolean indicating whether the bot should send a warning message when a message with too much capitalization is sent. Default is True.

  • anti_raid: Anti-raid protection with some useful features. More information here. Default level: 0

  • anti_raid_ignored_roles: List of roles allowing your members to be ignored by the anti-raid feature. Any member having one of these roles will be immune to the anti-raid. Default to roles with the ‘Moderate members’ permission.

  • anti_scam: Boolean indicating whether the bot should scam your member messages and delete potential scams using our own scam detector. Default is False.

  • ban_allowed_roles: List of roles allowed to use the ban command. By default, none.

  • bot_news: List of channels to which new bot products will be sent. These are the new bugs found as well as the new features added. None by default.

  • clear_allowed_roles: List of roles allowed to use the clear command. By default, none.

  • compress_help: Boolean indicating whether the full help message (without any specified command/module) should show every command or only their count

  • delete_welcome_on_quick_leave: Boolean indicating whether the welcome message should be deleted if the member leaves the server quickly. Default is False.

  • description: Description of the server, used for the info server command and potential partners. Default empty.

  • enable_fun: Boolean indicating if the fun part (documentation in preparation) is activated. If so, all commands in this section will be available. Default is True.

  • enable_ttt:Boolean indicating if members of your server can play tic-tac-toe. Default is True.

  • enable_xp: Boolean indicating whether the xp system is activated. Default is True.

  • help_in_dm: Boolean indicating whether the help command message should be sent as a private message or not. If the value is set to True, the message will be sent in DM or as an ephemeral message.

  • kick_allowed_roles: List of roles allowed to use the kick command. By default, none.

  • language: Language of the bot. Currently only the languages fr (French), en (English), fi (Finnish) and de (German) are available (also you can use lolcat or fr2 for more fun). The change takes place as soon as the order is validated by the system. Default fr.

  • leave: Message sent when a member leave your server. Some variables are usable, the same as for the welcome message.

  • levelup_channel: Channel where the bot will send every levelup announcement message. It can be either a text channel, or “none” for no channel (Axobot won’t send any levelup channel), or “any” if you want it in the same channel as the message. Default to any.

  • levelup_msg: Message to send when someone reaches a new XP level. You can use {level} variable to include the reached level, and {user} to mention the user (or {username} if you only want the name). Default is a random sentence.

  • levelup_silent_mention: Boolean indicating whether the mention in the levelup message should be silent or not. Default is False.

  • membercounter: A voice salon whose name displays the number of members on the server

  • mute_allowed_roles: List of roles allowed to use the mute command. By default, none.

  • muted_role: Role used to mute your members. If no role is specified, Axobot will check for any role called “muted”, and create one if needed, with basic permissions.

  • noxp_channels: List of text channels where members will not be able to earn any exp. Not necessary if XP is disabled in your server.

  • noxp_roles: List of roles whose members will not be able to earn any exp. Not necessary if XP is disabled in your server.

  • partner_channel: One channel where every partners of the server will be displayed. Default to None.

  • partner_color: The color of the partners embeds. Can be hex, integer or common english names. Default to #a713fe.

  • partner_role: A role given to every administrator of a partner server. Default to None.

  • poll_channels: List of channels in which the bot will add the reactions 👍 and 👎 to each message

  • prefix: Character string that will be the bot prefix, for all commands, beginning with the validation message. The prefix must be between 1 and 5 characters long. By default, !.

  • private_leaderboard: Allow non-members to see your server XP leaderboard on our website. Default to False.

  • rank_in_dm: Boolean indicating whether the rank command message should be sent as a private message or not. If the value is set to True, the message will be sent in DM or as an ephemeral message.

  • say_allowed_roles: List of roles allowed to use the say command. By default, none.

  • slowmode_allowed_roles: List of roles allowed to use the slowmode and freeze commands. By default, none.

  • ttt_emojis: List of emojis used to play on tic-tac-toe. Two emojis must be entered: one for the bot, and one for the player. Discord emojis as well as server emojis can work.

  • update_mentions: A list of roles which will be mentioned in each update changelog. You can enable those changelogs with the bot_news option. Default to None.

  • voice_category: Category used by the automated voice channels system (see below)

  • voice_channel: Channel used by the automated voice channels system (see below)

  • voice_channel_format: Name format used by the automated voice channels system (see below)

  • voice_roles: List of roles given to people being in a voice channel

  • vote_emojis: List of emojis that the bot will have to use when there is a voting message. This case may occur when using the poll command, or in a poll channel.

  • warn_allowed_roles: List of roles allowed to use the warn and cases commands. By default, none.

  • welcome: Message sent when a member joins your server.

  • welcome_channel: List of channels where messages when a member joins/leaves the server will be sent. By default, none.

  • welcome_roles: List of roles automatically given to members when they join the server. It is necessary that the bot is above the roles in question, and that it has the permission “Manage roles”.

  • welcome_silent_mention: Boolean indicating whether the mentions in the welcome messages should be silent or not. Default is False.

  • xp_decay: Amount of XP removed from each member of your server, per day. This allows inactive members to drop down your leaderboard. Default is 0.

  • xp_rate: Exp modifier, which multiplies the gain of xp by this number. It must be between 0.1 and 3, rounded to the nearest 1/100.

  • xp_type: Type of XP system to use: global if you want to use the accross-server system, common with every other servers which use it, or local if you want a more private system. There is also a mee6-like system, which uses the same rules as the MEE6 bot, and is also local. Default to global.

XP System#

The xp system is a system for evaluating a person’s activity on a server using a point system. Each message brings a certain number of points to its author, allowing them to gain in level and to rise in the ranking. To avoid having a too easy system, each level is a bit more difficult to reach than the previous one, and security measures have obviously been taken against spam or cheating.

Configure your server#

There are several ways to customize your xp system. In particular, you have a few configuration options, each one modifying a characteristic, that you can set with the /config set <option> <value> command. And more are to come!

  • Enable/disable xp: it is possible to enable or disable the entire xp system for your server via the option enable_xp. If it is set to ‘true’ the system is enabled, otherwise it will be ‘false’. By default ‘false’.

  • Change the levelup message: the bot automatically uses a long list of random messages for your members’ level changes, but you can put a single one written by you via the option levelup_msg. It is up to you to use then {user} to mention the member, {level} for his level and {username} for his simple name (without notifications).

  • Select the type of xp: there are natively three different xp systems at Axobot, modifiable with the option xp_type: a global, in common with all servers using this system (default), a local respecting the same calculations but without synchronization between the servers, and a mee6-like which uses the same rules as the famous MEE6 bot.

  • Change the gain rate of xp: if you find that your members are not earning xp fast enough (or too fast), or if you want to make a special event xp for a limited time, you can add a gain modifier between x0.1 and x3, which will multiply by its value each point of xp earned. Not usable for the global xp system, of course. Option name: xp_rate.

  • Move inactive members down the leaderboard: sometimes, certain members amass a lot of XP over a period of time, then become inactive in your server, while maintaining a high ranking in the server leaderboard. One option to avoid this problem is to remove a certain amount of XP from everyone every day: inactive members will then continually lose XP. The configuration option xp_decay lets you define the number of XP to be removed from each member every day.

  • Prevent xp in some channels: although Axobot prevents people from earning xp with its commands, it cannot detect commands from other bots. So you can prevent your members from earning xp in certain channels via the noxp_channels option, which contains a list of all channels where your users can’t earn any experience points.

  • Prevent xp for some roles: you can also prevent some roles from earning xp via the noxp_roles option, which contains a list of all roles that can’t earn any experience points.

  • Select a channel where to send levelup messages: sometimes levelup messages can be a bit spammy. So you have an option to select a single channel where to send level up messages. It is also possible to disable these messages via the same option. Enter the command config set levelup_channel followed by the name of your channel, or an other special value (“none” to disable the message, “any” to select the current channel, or “dm” to send in the user’s Direct Messages).

  • Silent mention in levelup messages: when mentionning a user in a message, by default Discord sends a notification to the user. If you want to avoid this, you can set the option levelup_silent_mention to true. The mention will then be silent, but the user will still get the red dot indicator.

Roles rewards#

Roles rewards are roles given to your members when they reach a certain level of xp. These levels are defined by you (or by anyone with “Manage Server” permission), and you can add up to 7 rewards per server.

The main command to manage these roles is roles-rewards (or its alias rr). Here is the list of commands currently available :

  • roles-rewards add <level> <role> : allows you to add a new role to the list of roles-rewards. The level is at least 1, without maximum, and to give the role you can provide either the Identifier or the name.

  • roles-rewards remove <level> : allows you to delete a role-reward at a certain level, to prevent the next people reaching that level from getting the role. People currently with this role will not lose it, unless you perform a reload via the following command.

  • roles-rewards reload : reload all roles, to check that each member has the right roles. If a member has excess role-reward, they will be removed; similarly, if a member misses certain roles, they will be assigned to them.

  • roles-rewards list : lists all currently configured roles-rewards, with their corresponding level, as well as the maximum number of roles allowed for your server. The bot must have “Embed Links” permission.

Warning

For these roles to work properly, the bot must have “Manage roles” permission. The roles to be given or removed must also be lower than the role of Axobot in your server hierarchy (Server Settings > Roles tab).

Partners system#

As a server grows, it is not uncommon to see partnerships formed with other servers. Some may even partner with bots. Axobot therefore offers a system to manage these partnerships in a clean and automatic way. Thanks to this system you can add, edit or remove partners in a few commands, and they will all be displayed in the same place, with the main information about them.

This information on partners is refreshed every 7 hours, starting at 1am (Paris time). It is currently impossible to reload the list yourself, only a Axobot administrator can do so.

Add a partner#

Syntax: partners add <invite> [description]

Allows you to add a server or bot to your partner list. The invitation must be either a server invitation (starting with discord.gg) or a bot invitation (discord.com/oauth). This invitation will be used to synchronize the partner, so make sure it does not expire.

Change the embed color#

Syntax: partners set-color <new color>

Modifies the color of the partner embed, i. e. the color of the bar to the left of the presentations. An alias exists with the subcommand “colour”.

Modify a description#

Syntax: partners set-description <ID> <new message>

Adds or modifies the description of a partner. The identifier must be that of the partnership, obtainable via the command partners list or under the embed displayed in the partners’ lounge.

Change a server invite#

Syntax: partners set-invite <ID> [new invite]

It often happens that for X reason an invitation becomes invalid. Problem: Axobot uses the partner invitation to synchronize partners with the channel. There is therefore a command to quickly change the invitation of a server.

Note

If no new invitation is given in the command, the bot will send you the one currently in use.

List every partners#

Syntax: partners list

Lists all the partners that your server currently has. The bot will display the name of the partner, the type (server or bot), and the date of addition. You will even have the list of servers that have added you as a partner!

Warning

For a better display of the list, it is recommended to give “Embed Links” permission to the bot.

Refresh your list#

Syntax: partners refresh

Allows you to remove a partner from the list. You will be asked for a confirmation, to avoid misuse. Once a partner is removed, you must reconfigure it completely if you want to put it back into the channel.

Remove a partner#

Syntax: partners remove <ID>

Allows you to remove a partner from the list. You will be asked for a confirmation, to avoid misuse. Once a partner is removed, you must reconfigure it completely if you want to put it back into the channel.

Server backup#

Axobot has a system to backup your server, saving your roles, channels, emojis, webhooks, icons, permissions, and much more. You will also find in this file the list of members and their permissions, although Axobot is not able to reinvite members if needed. This backup will avoid the most important damage, those little mistakes that can destroy your server as I myself experienced a few years ago. I hope to be able to save what is important to you.

When you load the backup, the bot may not be able to apply some changes. However, it will give you a complete list of what has and hasn’t been changed so that you can fix it yourself.

Warning

The bot will need as many permissions as possible, which includes: Manage roles, Manage channels, Manage webhooks, Ban members, Manage expressions.

Create a backup#

Syntax: backup create

Creates a file containing as much information as possible on your server, within the limit of the permissions granted to the bot. You will have to keep this file carefully, it will be necessary for you when you will want to restore the backup.

Load a backup#

Syntax: backup load

Uses the file attached to this message to load a backup, based on the data stored in the file. Be sure to send the file in the same message as the command, so that Axobot can easily find it. If the bot lacks permissions, it will try to skip this step and write it down in the logs. The set of logs is then sent at the end of the procedure.

Voice channels managment#

Give a role to voice users#

Syntax config set voice_roles <your roles>

You can easily give a role to any member joining a voice channel, and revoke it when the member leave the channel. This allows you to create a specific text channel for people talking together, for example.

Create automated voice channels#

Managing a server isn’t easy. You often have too many or not enough channels, especially voice channels. This is why the bot has an automated voice channels management system, which will create new voice channels when needed, and delete them when they aren’t used anymore.

To do that, you only need to configure a special voice channel where every member joining it will trigger a new channel creation. This can be achieved with the config set voice_channel <your channel> command.

Then, the bot needs to know where it should create these new channels. A simple config set voice_category <your category> will ask the bot to create its new channels at the bottom of a specific category.

Axobot will take a random name for each new channel, from a random names API, but you can change the name format with the config set voice_channel_format <new format> command. Several special keywords exists so you can get some unique names, feel free to use them in your format:

  • {random} inserts a random surname from randommer.io

  • {minecraft} inserts a random minecraft entity name

  • {number} inserts a random number

  • {user} inserts the Discord name and tag of the user who summoned the channel

If you have more ideas of variables to add, you can suggest them in our Discord support server!

Warning

Axobot needs the “Manage channels”, “Move members” and “Connect” permissions in the selected category to create these news channels!

Clear your unusued auto channels#

Axobot will try to delete the channels automatically created once everyone left it. But if, for any reason, you still have some unusued auto voice channels, you can use the super voice-clean command to start a big cleanup!

Note

Aynone with “Manage channels” permission can use that command!

On this page