Skip to content

config.yml

Nik edited this page May 23, 2021 · 20 revisions
# +----------------------------------------------------------------------------------------------+
# |                                                                                              |
# |                                              Alice                                           |
# |                                                                                              |
# |                               Discord: https://discord.gg/m7j2Y9H                            |
# |                                                                                              |
# |                                           Author: Nik                                        |
# |                                                                                              |
# +----------------------------------------------------------------------------------------------+
# Should we check for updates on startup?
check_for_updates: true

# Should we enable the test mode?
# If this mode is enabled the punish command won't work
test_mode: false

# The theme that alice is going to use
theme: default

# The server name that will be shown in Player Logs and Discord Messages
server_name: Server

# Discord Sync Settings
discord:

  # Would you like to Sync Alice to your Discord Server?
  enabled: false

  # Insert the Channel Webhook URL
  webhook_url: ''

  # Would you like Alice to send Discord Messages
  # When a player receives a Violation?
  violations: true

  # Would you like Alice to send Discord Messages
  # When a player gets Punished?
  punishments: true

  # Would you like Alice to send Discord Messages
  # When players get punished from the Punish Wave?
  punishwave: true

# TPS Protection Settings
tps_protection:

  # If the Server's TPS reach or go below this value Alice will stop checking players
  min_tps: 17.0

  # If the server does not respond for this amount of Milliseconds, Alice will stop checking players
  lag_threshold: 1000

  # How long should we wait for the server to recover once a lag spike occurs? (In milliseconds)
  recover_millis: 5000

# Client Settings
client_settings:

  # Client Alert Settings
  alert:

    # Should we send an Alert when a player joins specifying his Client Brand?
    enabled: true

    # Should Alice only send an Alert when a player joins with a Non Vanilla client?
    non_vanilla_only: false

  # Client Brands that contain the following, Will be prevented from joining the server
  # NOTE: At least one value has to exist, If you want to disable this simply put something random
  banned_clients:
    - someclientbrand

# Should we enable the Alice Ghost Mode?
# It is highly recommended to keep this option to true
# If Ghost Mode is enabled, Alice will not attempt to Setback players for checks like Speed or Fly while also making certain checks and Alice herself perform much better
ghost_mode: true

# Should experimental checks add violations?
# If this setting is disabled you will still see notifications but no violations will be added
allow_experimental: false

# Should we disable the bypass permission?
# If enabled Alice will check all players including operators
# Disable this for some perfomance gain
disable_bypass_permission: true

# Should we enable alerts for admins when they join?
toggle_alerts_on_join: true

# Check Settings
check_settings:

  # How often should Alice clear the player violations? (In minutes)
  violation_reset_interval: 5

# Bot Command Settings
bot_settings:

  # How many Combat Violations does the player need to reach in order for the Bot to spawn automatically?
  # You can set this value to -1 to disable it
  combat_vl_required: 10

  # The distance between the Bot and the player
  distance: -2.5

  # The height between the Bot and the player
  height: 1.65

  # For how long should the Bot be spawned in ticks?
  living_ticks: 140

  # The ticks between bot teleportations
  teleport_ticks: 1

# Punish Command Settings
punish_command:

  # What Punish Animation Should Alice display before executing the below command?
  # Animations: NONE, FLAME, BURN, ERROR or RANDOM to let it choose a random animation each time
  # Feel free to create your own Punish Animations by using the Alice API
  animation: RANDOM

  # Should we broadcast in chat when a player gets punished by Alice?
  broadcast: true

  # What command should Alice execute once the Punish Animation ends? (%nl% for new line)
  # Placeholders: %prefix% -> (Alice Prefix), %player% -> (The player that got punished), %reason% -> (The reason provided by the Alice punish command)
  command: alice kick %player% %prefix% %reason%

# Punish Wave Settings
punishwave:

  # Should we enable the Punish Wave?
  # If the Punish Wave is enabled, Alice will punish all Cheaters at once
  # If a player gets punished using the /Alice punish command while the Punish Wave is enabled, He will be added to the Queue and get Punished once the Punish Wave starts
  enabled: false

  # Should Alice Broadcast this event?
  broadcast: true

  # How often should the Punish Wave get executed? (In minutes)
  time: 15

  # The countdown before executing the Punish Wave (-1 to disable)
  countdown: 5

  # What should we Punish the player for? (%nl% for new line)
  reason: Unfair Advantage

# Compatibility Settings
compatibility:

  # Alice can detect when a plugin adds artificial velocity to the player (IE JumpPad plugins)
  # For how long should we exempt the movement checks once that velocity is applied? (In ticks)
  artificial_velocity_ticks: 80

# Log Settings
logs:

  # What type of Database should Alice use for logging?
  # Supported types: YAML, MYSQL, SQLITE
  type: YAML

  # Logs older than this value of Days will be cleared by Alice
  clear_days: 7

  # MySQL Settings (Requires MySQL Type)
  mysql:
    host: localhost
    port: 3306
    database: database
    user: root
    password: ''
    use_ssl: false

    # MySQL Connection Pool Settings
    # Do not change unless you know what you're doing
    pool_settings:
      maximum_pool_size: 50
      minimum_idle: 30
      maximum_lifetime: 1800000
      connection_timeout: 30000
      leak_detection_threshold: 0

# Advanced Settings
# Do not touch unless you know what you're doing
advanced:

  # When this value is set to zero, Alice will automatically determine a proper thread limit
  # If your server has hyper threading enabled it is suggested to make a proper limit yourself since hyper threading can hold over 100+ threads easily
  # NOTE: Threads are not CPU Cores, And the JVM is able to handle tons of threads by default
  max_threads: 0

  # Should we account for cinematic camera?
  # It is highly recommended to not enable this option since this will make the aim checks weaker
  # In a real combat scenerio, none of the opponents are going to fight using cinematic.
  account_cinematic: true

  # Should Alice teleport players on ghost blocks?
  # It is highly recommended to not disable this option since it can prevent potential false positives
  ghostblocks_teleport: true

  # Should Alice kick players that are stuck in a repeated teleporting state due to them lagging insanely hard due to the chunk being unloaded client side?
  # Please do not disable this option since this is impossible to account for
  timeout_teleport: true

  # Should Alice kick players that do not respond to transactions or keepalives for a long time?
  timeout_communication: true
Clone this wiki locally