-
Notifications
You must be signed in to change notification settings - Fork 4
How to Configure
BungeeAFK comes with a lot of customization options, allowing you to tailor the plugin to your server's needs. Below is a guide on how to configure BungeeAFK effectively.
Important: if you update the config.yml while BungeeAFK is running, you need to run /bafk configure reloadconfig to override the cached settings
with the config values!
The main configuration file is located at plugins/BungeeAFK/config.yml. Open this file to view and edit the settings.
The language file is located at plugins/BungeeAFK/lang/lang_xx.json. There is one english and one german file included by default.
You can adjust all messages displayed by the plugin in this file, but you need to make sure that all the keys remain the same.
For example, you can change the AFK warning message by modifying the notification.afk_warning key in the language file.
{
"notification.afk_warning": "Your desired message here"
}If a key is missing in the language file, the plugin will use the default message.
The language setting allows you to choose the language for the plugin's messages. You can set it to en for English or de for German.
The plugin will use the language file: lang_xx.json where xx is the language code you set.
Default is en.
This is the delay in seconds after which a warning message is sent to the player after their last activity. The warning message
can be customized in the language file under the key notification.afk_warning.
Default is 90 seconds.
This is the delay in seconds after which a player is considered AFK if they have not interacted with the server.
The AFK message can be customized in the language file under the key notification.afk.<action>.
Default is 180 seconds.
This is the delay between a player's last interaction and the Action as configured in the action entry.
Default is 420 seconds.
This setting allows you to specify the action that will be taken when Action Delay is reached. You can choose from the following options:
-
kick: The player will be kicked from the server. -
connect: The player will be connected to a specified afk-server. -
teleport: The player will be teleported to a specified afk-location. -
nothing: No action will be taken.
Default is kick.
This is the name of the server to which players will be connected when the action is set to connect.
Make sure this server is enabled and present in your proxy's config.
This is the location to which players will be teleported when the action is set to teleport.
If true, players with the permission afk.bypass bypass the AFK system.
Default is true.
This is a list of servers where the AFK system is disabled. Players on these servers will not be marked as AFK. You can specify multiple servers by separating them with commas.
Example:
disabled-servers: [lobby, survival]This is a list of regions where players will not be marked as AFK.
You can, but should not specify regions manually here, but rather use the /afk region add command to add regions.
If true, auto clicker detection is enabled.
Default is false.
If true, players with the permission bungeeafk.auto-clicker.bypass bypass the auto clicker detection.
Default is true.
This is the permission required to receive notifications about auto clicker detections.
Default is bungeeafk.auto-clicker.notify.
If true, players will receive a notification when they are detected as using an auto clicker.
Default is true.
This setting allows you to specify the action that will be taken when an auto clicker is detected. You can choose from the following options:
-
kick: The player will be kicked from the server. -
open-inv: An empty inventory will be opened for the player to prevent clicks from impacting the world. -
nothing: No action will be taken.
This is the number of detection events that will be stored in the history for each player.
History can be viewed using the /bafk auto-clicker detection-history <player> command.
Default is 10.
This is a list of servers where auto clicker detection is disabled. Players on these servers will not be checked for auto clicker usage.
Example:
auto-clicker:
disabled-servers: [lobby, survival]If true, movement pattern detection is enabled.
Default is true.
If true, players with the permission bungeeafk.movement-pattern.bypass bypass the movement pattern detection.
Default is true.
This is the permission required to receive notifications about movement pattern detections.
Default is bungeeafk.movement-pattern.notify.
If true, players will receive a notification when they are detected as using a movement pattern.
Default is true.
This setting allows you to specify the action that will be taken when a movement pattern is detected. You can choose from the following options:
-
kick: The player will be kicked from the server. -
connect: The player will be connected to a specified afk-server. -
teleport: The player will be teleported to a specified afk-location. -
nothing: No action will be taken.
This is a list of servers where movement pattern detection is disabled. Players on these servers will not be checked for movement patterns. Example:
movement-pattern:
disabled-servers: [lobby, survival]This is the minimum certainty required for a movement pattern to be considered suspicious.
The value should be between 0 and 1, where 1 means 100% certainty.
Certainty is calculated using the standard deviation of intervals between visiting the same block.
The formula used is: Math.max(0, 1 - (stdDev / 1000.0))
Meaning that a value of 0.9 is reached when the standard deviation is 100 milliseconds.
Default is 0.9.
This is the number of required samples to detect a movement pattern.
Example: If set to 5, the player must visit the same block at least 5 times before the movement pattern can be analyzed.
Default is 5.