Configuration Overview

Complete reference for all GAPE configuration options. The configuration file auto-generates at plugins/GAPE/config.yml.

Configuration Sections

GAPE's configuration is organized into 13 main sections:

1. Netty Protection

Packet filtering and heavy packet detection

2. NBT Validation

Item NBT depth validation and smart decoding

3. Packet Type Limits

Per-type rate limiting configuration

4. Security Checks

Enable/disable individual checks

5. Violation Thresholds

Alert, cancel, and kick thresholds

6. Performance

Tuning for different server sizes

Quick Configuration Example

Here's a minimal configuration showing the most commonly adjusted settings:

# Netty Protection
netty-protection:
  enable: true
  heavy-packet-threshold-ms: 15

# Packet Rate Limits
packet-type-limits:
  PLAYER_POSITION:
    max-packets: 50
    window-ms: 100

# Security Checks
checks:
  ratelimit: true
  tab-complete: true
  sign-exploit: true
  book-exploit: true
  crasher: true

# Violation Thresholds
violation-thresholds:
  alert-threshold: 8
  cancel-threshold: 15
  kick-threshold: 25

# Performance
performance:
  max-players-tracked: 1000
  thread-pool-size: 8
  cache-enabled: true

Recommended Settings by Server Type

Small Server (10-50 players)

performance:
  max-players-tracked: 100
  thread-pool-size: 2
  queue-size: 5000

packet-type-limits:
  PLAYER_POSITION:
    max-packets: 40

Medium Server (50-500 players)

Use default configuration (already optimized)

Large Server (500-2000 players)

performance:
  max-players-tracked: 2000
  thread-pool-size: 16
  queue-size: 50000
  batch-size: 200

packet-type-limits:
  ANIMATION:
    max-packets: 80
  PLAYER_POSITION:
    max-packets: 60

Customization Tips

  • False Positives: Increase packet limits or violation thresholds
  • Better Detection: Decrease packet limits or lower thresholds
  • Better Performance: Increase batch-size, disable metrics
  • Better Visibility: Enable file-level INFO logging
  • Large Servers: Increase max-players-tracked and thread-pool-size

Validation

Configuration is validated on startup. Check console for errors if config fails to load. Common issues:

  • Invalid YAML syntax (indentation, colons, quotes)
  • Values out of valid range
  • Missing required fields
  • Typos in setting names
Important: Always restart your server after changing configuration. Config changes are not hot-reloaded.

Next Steps

Explore detailed configuration for each section: