config.yml

config.yml is the main configuration file for Matrix. It is located in the Matrix folder.

# Should Matrix check update when starting up?
check_update: true

# Place access token here, you can get it from https://cp.rerere.me (Client - Token)
# Please do NOT share your access token with anyone!
access_token: ''

# Permission Cache refresh interval (unit: seconds, default: 15)
permission_refresh_interval: 15

# Enable BungeeCord GeyserMC Support?
# Matrix supports two ways to run GeyserMC:
#   1. Spigot Mode: Install GeyserMC/FloodGate in Spigot, you don’t need to modify this setting, Matrix will automatically support it
#   2. Bungee Mode: When GeyserMC is installed in BungeeCord, you need to enable this option and also install Matrix in BungeeCord
# !!!    Do NOT enable this option if you have NOT installed GeyserMC in BungeeCord
bungee_geysermc_support: false

# Should there be a lightning bolt visual effect if someone is getting kicked using /matrix kick
kick_strike_lightning: true

# Discord Webhook
discord_webhook:
  # Enable Discord Webhook
  enable: false

  # Webhook URL
  url: ''

# Server Lag Protection
# Automatically disables some checks when your server is lagging. This prevents
# most, but not all, false positives from occuring.
tps_protection:
  # Enable this feature?
  enable: true

  # Minimum TPS needed to trigger protection
  min_tps: 17.0

  # Lag spike threshold (millisecond)
  # If the server does not respond for a certain period of time, then close the check
  lag_threshold: 1000

# Log Violations (default: true)
# Logs all violations to a file. Files can be found in /plugins/Matrix/logs
# Warning: If you are using BungeeCord, I recommend setting
# this to FALSE. This will prevent useless log files from
# being stored and using up precious disk space.
log_file: true

# Delete outdated log files (days)
# If the log file is stored for more than the specified number of days, the log file will be deleted
# You can set it to `-1` to disable this feature
delete_time: 30

# Deny Bypass Permission (default: false)
# By setting this option to TRUE, you are forcing Matrix to check everyone
# on the server, INCLUDING anyone who has Operator status. By setting this
# option to TRUE you can run the necessary tests without having to remove
# your operator status.
disable_bypass_permission: false

## Relog time
# How long after a player is kicked should he be allowed to log in (seconds)
# also, you can set -1 to disable this feature
relog_time: 5