Skip to content

Configuration

Oliver Martin edited this page Mar 14, 2019 · 1 revision
############################################################
# +------------------------------------------------------+ #
# |                      AFKPatrol                       | #
# +------------------------------------------------------+ #
############################################################

# By Revilo410

##################
#   DON'T EDIT   #
version: "1.1"   #
##################

Plugin version, do not edit or bad things might happen!


############################################################
# +------------------------------------------------------+ #
# |                       General                        | #
# +------------------------------------------------------+ #
############################################################

# A player is recognised as "AFK Mining" if they remain in one spot while regularly interacting with the world around them
# This means that if a player tapes down their mouse button to mine automatically while they are AFK, then the plugin will trigger
# The plugin will also trigger if they are using the same tactic to gain EXP from a mob farm

# How long should someone be in the same spot while interacting before the plugin takes action?
action_period: 60 # Time in seconds

This option controls how long a player has to be acting in the same spot for it to be counted as AFK mining. The value is the number of seconds from when they last moved.


# Should the player be notified they are AFK mining before we take action?
should_notify: true

# After how long should this notification be shown?
notify_period: 45 # Time in seconds

These options allow you to notify the player that they might be AFK mining before actually blocking their actions. The first option determines if this message should be shown, and the second is how long before we display the message.

By default a notification is shown after 45 seconds, and when 60 seconds has elapsed then their actions will be blocked.


# If the player continues to interact after we have taken action by "freezing" them, how many times before we kick them from the server?
disconnect_count: 10

Once their actions have been blocked, they will be kicked from the network after trying this many more times.


# If a player doesn't perform any interactions for this amount of time, we will reset their counter so they wont be counted as "AFK Mining"
interact_grace_period: 10 # Time in seconds

This setting prevents players from going to get a snack, coming back to their computer and clicking the mouse and being told they are AFK mining. If a player doesn't perform any interactions in this many seconds, then we will reset their "last move" counter so that the time period before they are notified / blocked starts again.


############################################################
# +------------------------------------------------------+ #
# |                       Messages                       | #
# +------------------------------------------------------+ #
############################################################

messages:
  # Message shown when a player is notified that they are AFK mining
  # %NUMBER% will be a randomly generated number between 0 and 9999 which the user can type to confirm they are not AFK
  notify: "&f&l<< &4AFK PATROL &f&l>> &c&lPlease confirm you are not AFK mining by moving or typing: %NUMBER%"
  # Message shown when a player confirms they are not AFK
  not_afk: "&f&l<< &2AFK PATROL &f&l>> &a&lThank you :)"
  # Message shown when we take action against a player who is AFK mining
  # %NUMBER% will be a randomly generated number between 0 and 9999 which the user can type to confirm they are not AFK
  # %COUNT% will be the number of interacts they can perform before they are kicked
  action: |
    &c       - - - &f&l<< &4AFK PATROL &f&l>> &c- - -
    &7Your action has been cancelled because you are AFK mining!
    &7Please move or type the following number: &c%NUMBER%
    &7You will be kicked after &c%COUNT% &7more AFK actions!
  afk_kick: "AFK PATROL: You have been kicked for AFK mining!"
  # The message for console logging and displayed to people with afkpatrol.notify permission
  # %NAME% is the player who has been blocked
  log: "&f<< &4AFK Patrol &f>> &cBLOCKED AFK MINING: %NAME%"

This section lets you customise all the messages of the plugin

Clone this wiki locally