Polar Logs

This is an advanced logs plugin for Polar Anticheat. It allows context-based log storage in an MySQL database. It also allows you to send notifications to a Discord channel when a player is mitigated, detected or punished.

If you have any suggestions, feel free to open an issue or a pull request.

Download

Github Releases

Command permissions

Command	Description	Permission
/polarlogs	Show help	polarlogs.command
/polarlogs reload	Reload the config	polarlogs.command.reload
/polarlogs trange	See help page for time ranges	polarlogs.command.logs
/polarlogs webhooks test	Test webhook	polarlogs.command.webhooks
/polarlogs info (player)	Show information about a player	polarlogs.command.info.player
/polarlogs view (query) (page)	View logs (query desc. below)	polarlogs.command.view
/polarlogs export (query) (page)	Export logs (query desc. below)	polarlogs.command.export

In order for any subcommand to work, polarlogs.command needs to be set.

View query

The query argument allows to filter for player and context.

The general format for filtering by context only is c:<context>. For example, c:global.

The general format for filtering by player is p:<player>. For example, p:Shorty. By appending @<context> to the player name, you can filter by player and context. For example, p:Shorty@global.

In order to reduce the logs to a specific time range, you can append :<time range> to the player or context name. For example, p:Shorty:today, c:global:1d or p:Shorty@global:1w.

Extended permissions:

polarlogs.command.view.player - Allows viewing logs of a specific player
polarlogs.command.view.player.context - Allows viewing logs of a specific player and context
polarlogs.command.view.context - Allows viewing logs of a specific context

Extended permissions for exporting:

polarlogs.command.export.player - Allows exporting logs of a specific player
polarlogs.command.export.player.context - Allows exporting logs of a specific player and context
polarlogs.command.export.context - Allows exporting logs of a specific context

Time range

The logs info and logs view commands allow narrowing down the time range by appending :value to the player name.

Example command: /polarlogs logs view Shorty:today global

Available time selectors:

today
yesterday
1h last 60 minutes
1d last 24 hours
1w last 7 days
1m last 30 days
yyyy-MM-dd specific date
yyyy-MM-dd;yyyy-MM-dd time range
yyyy-MM specific month

Logs

Mitigation logs are disabled by default. You can enable them by setting store.mitigation to true in the config.

Commands

Webhooks

Mitigation message example (default config)

This is an example of the default config for the mitigation message. The details field has been filtered using the filter_detail_lines field.

How to create a webhook

Navigate to your Discord server
Open the settings of the channel you want to send the notifications to
Click on Integrations
Click on Create Webhook or View Webhooks and then New Webhook if you already have other webhooks
Enter a name for the webhook and optionally change the avatar
Copy the webhook URL and paste it into the config

Rate Limit (IMPORTANT)

Discord has a rate limit on webhooks, which means that a lot of messages on the same webhook most likely won't be sent. This is why it is recommended to create a new webhook for each type of message (mitigation, detection, ...). You can also optionally set the cooldown_per_player_and_type field to a higher value to prevent the plugin from sending too many messages. For mitigations, the default value of this field is 5 seconds.

Global rate limit

The global rate limit is 50 messages per second. This means you can't exceed 50 messages per second from a single IP address.

Config

Cooldown per player and type

The cooldown per player and type field allows you to set a cooldown for each player and check type. This is useful for preventing a player from spamming the webhook. For example, if you set the cooldown to 5 seconds, the plugin will not send any notifications of that type for that player until 5 seconds have passed. A cooldown of 0 means that there is no cooldown.

Notifications field

The notification list should contain all types of checks that you want to receive alerts for. By default, all checks are enabled. If you want to disable a check, simply remove it from the list.

Filter detail lines field

The detail line filter allows you to filter out certain detail lines from being sent to Discord. This is useful for removing debug lines or lines that are not useful to you. If an asterisk is added to the end of a line, it will filter out all lines that start with that string. For example, adding Debug* to the filter list will filter out all lines that start with Debug. The same goes for adding Click to teleport to the filter list, it will filter out all lines that contain Click to teleport. You can also place an asterisk at the start and end of a line in order to check if a line contains a certain string. For example, adding *name* to the filter list will filter out all lines that contain name.

command: 'polarlogs' # Use 'disable' to disable the command
# -------------------
# Log storage
# -------------------
# Placeholders
# Global: %PLAYER_NAME%, %PLAYER_UUID%, %PLAYER_LATENCY%, %PLAYER_CLIENT_VERSION_NAME%, %PLAYER_CLIENT_BRAND%, %TIMESTAMP%
# Mitigation: %VL%, %CHECK_TYPE%, %CHECK_NAME%, %DETAILS%
# Detection: %VL%, %CHECK_TYPE%, %CHECK_NAME%, %DETAILS%
# Cloud Detection: %CHECK_TYPE%, %DETAILS%
# Punishment: %PUNISHMENT%, %REASON%
logs:
  enabled: true
  expire_after_days: 7 # Logs older than this will be deleted
  database:
    sql_host: 'localhost'
    sql_port: 3306
    sql_database: 'polar'
    sql_username: 'root'
    sql_password: ''
    use_ssl: false
  # context - viewing logs in-game will be limited to this context (unless specified in the command)
  # Can't be empty or contain spaces (Allowed characters: a-z, A-Z, 0-9, _)
  # Examples: global, minigame, survival, etc.
  context: 'global'
  # What logs to store
  store:
    mitigation: false
    detection: true
    cloud_detection: true
    punishment: true
  timestamp_format: 'yyyy-MM-dd HH:mm:ss'
  # For all logs, cooldown per player and type are used from the Discord Webhooks section
  # Fine tune mitigation logs if enabled
  mitigation:
    message: '&7%PLAYER_NAME% %PLAYER_CLIENT_VERSION_NAME% (%PLAYER_CLIENT_BRAND%) (%PLAYER_LATENCY%ms) &8- &c%VL% VL &b%CHECK_TYPE%'
    hover_text: '&b%TIMESTAMP% &8- &b%PLAYER_NAME%\n&7&o%PLAYER_UUID%\n\n&r%DETAILS%'
    log_types:
      - 'MOVEMENT'
      - 'VELOCITY'
      - 'GROUND_SPOOF'
      - 'LATENCY_ABUSE'
      - 'TICK_SPEED'
      - 'REACH'
      - 'BLOCK_INTERACT'
      - 'PHASE'
      - 'CLOUD'
    min_vl: 5 # Minimum VL to store a mitigation log
  detection:
    message: '&7%PLAYER_NAME% %PLAYER_CLIENT_VERSION_NAME% (%PLAYER_CLIENT_BRAND%) (%PLAYER_LATENCY%ms) &8- &c%VL% VL &b%CHECK_TYPE%'
    hover_text: '&b%TIMESTAMP% &8- &b%PLAYER_NAME%\n&7&o%PLAYER_UUID%\n\n&r%DETAILS%'
  cloud_detection:
    message: '&7%PLAYER_NAME% %PLAYER_CLIENT_VERSION_NAME% (%PLAYER_CLIENT_BRAND%) (%PLAYER_LATENCY%ms) &8- &b%CHECK_TYPE%'
    hover_text: '&b%TIMESTAMP% &8- &b%PLAYER_NAME%\n&7&o%PLAYER_UUID%\n\n&r%DETAILS%'
  punishment:
    message: '&7%PLAYER_NAME% &8- &c%PUNISHMENT% &7for &b%REASON%'
    hover_text: '&b%TIMESTAMP% &8- &b%PLAYER_NAME%\n&7&o%PLAYER_UUID%'
# -------------------
# Discord Webhooks
# -------------------
# Placeholders
# Global: %PLAYER_NAME%, %PLAYER_UUID%, %PLAYER_PROTOCOL_VERSION%, %PLAYER_LATENCY%, %PLAYER_IP%, %PLAYER_CLIENT_VERSION_NAME%, %PLAYER_CLIENT_BRAND%, %TIMESTAMP% (current time in RFC-3339 format), %TIMESTAMP_UNIX% (current time in Unix format)
# Mitigation: %VL%, %PUNISH_VL%, %CHECK_TYPE%, %CHECK_NAME%, %DETAILS%
# Detection: %VL%, %PUNISH_VL%, %CHECK_TYPE%, %CHECK_NAME%, %DETAILS%
# Cloud Detection: %CHECK_TYPE%, %DETAILS%
# Punishment: %PUNISHMENT%, %REASON%
mitigation:
  webhook_url: "https://discord.com/api/webhooks/1234567890/abcdefghijklmnopqrstuvwxyz"
  enabled: true
  round_vl: true # Rounds the VL to the nearest integer
  cooldown_per_player_and_type: 5 # Seconds
  notifications:
    - 'MOVEMENT'
    - 'VELOCITY'
    - 'GROUND_SPOOF'
    - 'LATENCY_ABUSE'
    - 'TICK_SPEED'
    - 'REACH'
    - 'BLOCK_INTERACT'
    - 'PHASE'
    - 'CLOUD'
  filter_detail_lines: # Allows you to filter out certain detail lines from being sent to Discord
    - 'Click to teleport'
    - 'Debug*' # Lines starting with "Debug" will be filtered out
  min_vl: 5 # Minimum VL to send a notification for
  content: 'Player %PLAYER_NAME% was mitigated for %VL% violations of %CHECK_TYPE% - %CHECK_NAME%'
  embed:
    title: 'Polar - Mitigation'
    description: ''
    color: 'ff0000' # Hex color code
    footer:
      text: 'Polar Webhooks by Shorty'
      icon_url: ''
    thumbnail:
      url: 'https://mc-heads.net/avatar/%PLAYER_NAME%'
    image:
      url: ''
    timestamp: '%TIMESTAMP%'
    fields:
      0:
        name: 'Player'
        value: '%PLAYER_NAME%'
        inline: true
      1:
        name: 'Check'
        value: '%CHECK_TYPE% - %CHECK_NAME%'
        inline: true
      2:
        name: 'Details'
        value: '%DETAILS%'
        inline: false
detection:
  webhook_url: "https://discord.com/api/webhooks/1234567890/abcdefghijklmnopqrstuvwxyz"
  enabled: true
  round_vl: true # Rounds the VL to the nearest integer
  cooldown_per_player_and_type: 1 # Seconds
  notifications:
    - 'MOVEMENT'
    - 'VELOCITY'
    - 'GROUND_SPOOF'
    - 'LATENCY_ABUSE'
    - 'TICK_SPEED'
    - 'REACH'
    - 'BLOCK_INTERACT'
    - 'PHASE'
    - 'CLOUD'
  filter_detail_lines: # Allows you to filter out certain detail lines from being sent to Discord
    - 'Click to teleport'
    - 'Debug*' # Lines starting with "Debug" will be filtered out
  content: 'Player %PLAYER_NAME% detected for %CHECK_TYPE% - %CHECK_NAME%'
  embed:
    title: 'Polar - Detection'
    description: 'Player %PLAYER_NAME% detected for %CHECK_TYPE% - %CHECK_NAME%'
    color: 'ff0000' # Hex color code
    footer:
      text: 'Polar Webhooks by Shorty'
      icon_url: ''
    thumbnail:
      url: 'https://mc-heads.net/avatar/%PLAYER_NAME%'
    image:
      url: ''
    timestamp: '%TIMESTAMP%'
    fields:
      0:
        name: 'Player'
        value: '%PLAYER_NAME%'
        inline: true
      1:
        name: 'Check'
        value: '%CHECK_TYPE% - %CHECK_NAME%'
        inline: true
      2:
        name: 'Details'
        value: '%DETAILS%'
        inline: false
cloud_detection: # Please note that %VL% and %CHECK_NAME% are not available for cloud detections
  webhook_url: "https://discord.com/api/webhooks/1234567890/abcdefghijklmnopqrstuvwxyz"
  enabled: true
  cooldown_per_player_and_type: 0 # Seconds
  notifications:
    - 'AUTO_CLICKER'
    - 'CHEST_STEALER'
    - 'COMBAT_BEHAVIOR'
    - 'INVALID_PROTOCOL'
    - 'SCAFFOLD'
    - 'CPS_LIMIT'
    - 'RIGHT_CPS_LIMIT'
  filter_detail_lines: # Allows you to filter out certain detail lines from being sent to Discord
    - 'Click to teleport'
    - 'Debug*' # Lines starting with "Debug" will be filtered out
  content: '[Cloud] Player %PLAYER_NAME% detected for %CHECK_TYPE%'
  embed:
    title: 'Polar - Detection'
    description: 'Player %PLAYER_NAME% detected for %CHECK_TYPE%'
    color: 'ff0000' # Hex color code
    footer:
      text: 'Polar Webhooks by Shorty'
      icon_url: ''
    thumbnail:
      url: 'https://mc-heads.net/avatar/%PLAYER_NAME%'
    image:
      url: ''
    timestamp: '%TIMESTAMP%'
    fields:
      0:
        name: 'Player'
        value: '%PLAYER_NAME%'
        inline: true
      1:
        name: 'Check'
        value: '%CHECK_TYPE%'
        inline: true
      2:
        name: 'Details'
        value: '%DETAILS%'
        inline: false
punishment: # Please note that no other placeholders except for %PLAYER_NAME%, %PUNISHMENT% and %REASON% are available for punishments
  webhook_url: "https://discord.com/api/webhooks/1234567890/abcdefghijklmnopqrstuvwxyz"
  enabled: true
  types_enabled: # Remove from list to disable notifications for that punishment type
    - 'BAN'
    - 'KICK'
  cooldown_per_player: 0 # Seconds
  content: 'Player %PLAYER_NAME% was punished for %REASON% (%PUNISHMENT%)'
  embed:
    title: 'Polar - Punishment'
    description: ''
    color: 'ff0000' # Hex color code
    footer:
      text: 'Polar Webhooks by Shorty'
      icon_url: ''
    thumbnail:
      url: 'https://mc-heads.net/avatar/%PLAYER_NAME%'
    image:
      url: ''
    timestamp: '%TIMESTAMP%'
    fields:
      0:
        name: 'Player'
        value: '%PLAYER_NAME%'
        inline: true

Name		Name	Last commit message	Last commit date
Latest commit History 59 Commits
assets		assets
gradle/wrapper		gradle/wrapper
src/main		src/main
.gitignore		.gitignore
README.md		README.md
build.gradle		build.gradle
gradlew		gradlew
gradlew.bat		gradlew.bat
settings.gradle		settings.gradle

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Polar Logs

Download

Command permissions

View query

Time range

Logs

Commands

Webhooks

Mitigation message example (default config)

How to create a webhook

Rate Limit (IMPORTANT)

Global rate limit

Config

Cooldown per player and type

Notifications field

Filter detail lines field

About

Releases

Packages

Languages

adabugra/PolarLogs

Folders and files

Latest commit

History

Repository files navigation

Polar Logs

Download

Command permissions

View query

Time range

Logs

Commands

Webhooks

Mitigation message example (default config)

How to create a webhook

Rate Limit (IMPORTANT)

Global rate limit

Config

Cooldown per player and type

Notifications field

Filter detail lines field

About

Resources

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages