v2.0.0

AntiLagX Documentation

A comprehensive server optimization plugin designed to enhance server performance through intelligent monitoring, automatic optimization, and proactive lag prevention.

🚀 Key Features
  • ✓ Real-time performance monitoring
  • ✓ Automatic entity management
  • ✓ TNT optimization
  • ✓ Particle effect control
  • ✓ Plugin performance analysis
📊 Monitoring
  • ✓ Real-time TPS tracking
  • ✓ Memory usage analysis
  • ✓ Entity count monitoring
  • ✓ Lag source detection
  • ✓ Performance metrics
⚡ Optimization
  • ✓ Smart chunk management
  • ✓ Automated cleanup systems
  • ✓ Memory optimization
  • ✓ Entity limiting
  • ✓ Performance tuning

📥 Installation Guide

Prerequisites
  • Paper/Spigot server version 1.20.4
  • Java 17 or higher
  • Minimum 512MB RAM allocated to server (2GB recommended)
  • Permissions plugin (optional but recommended)
Step-by-Step Installation
  1. Download the latest version of AntiLagX.jar
  2. Stop your server if it's running
  3. Place AntiLagX.jar in your server's plugins folder
  4. Start the server
  5. The plugin will generate default configuration files:
    • config.yml
    • language.yml
  6. Stop the server
  7. Configure the plugin settings (optional)
  8. Start the server
  9. Verify installation with /al status
Post-Installation Setup
  1. Configure permissions for your staff
  2. Review and adjust entity limits
  3. Set up Discord notifications (optional)
  4. Test all commands

🔄 Compatibility

Tested Server Versions
  • ✅ Paper 1.20.4 - 1.21 (Recommended)
  • ✅ Spigot 1.20.4 - 1.21
  • ✅ Purpur 1.20.4 - 1.21
  • ⚠️ CraftBukkit 1.20.4 - 1.21 (Limited features)
  • ❌ Older versions not supported
Operating System Compatibility
  • ✅ Linux (Recommended)
  • ✅ Windows
  • ✅ macOS
  • ⚠️ Docker containers (Requires specific configuration)
Compatible Plugins
  • EssentialsX (all versions)
  • WorldGuard
  • CoreProtect
  • LuckPerms
  • Vault
Known Plugin Conflicts
  • ❌ LagFixer (Incompatible - same functionality)
  • ⚠️ ClearLagg (Partial conflicts - disable its entity cleanup)
  • ⚠️ ClearLag (Partial conflicts - disable its lag prevention)
  • ⚠️ ServerBooster (Disable its TNT optimization)

🔧 Commands & Permissions

Command Permission Description
/al antilagx.use Shows help menu
/al clean antilagx.clean Removes hostile mobs to reduce lag
/al particles antilagx.particles Clears all particle effects
/al status antilagx.status Shows server performance status
/al reload antilagx.reload Reloads plugin configuration

⚙️ Configuration Guide

Configuration Files
# Entity Management
entity-limits:
  per-chunk-total: 50  # Maximum entities per chunk
  per-type:           # Limits for specific entity types
    ZOMBIE: 20        # Max zombies per chunk
    SKELETON: 20      # Max skeletons per chunk
    ITEM: 100        # Max dropped items per chunk
  cleanup:
    interval: 300    # Cleanup check interval (seconds)
    threshold: 1000  # Total entity count threshold

# TNT Optimization
tnt:
  max-per-chunk: 10   # Maximum TNT entities per chunk
  fuse-time: 40      # TNT fuse time in ticks
  blast-radius: 3.0  # TNT explosion radius
  chain-reaction: false  # Allow TNT chain reactions

# Lag Detection
lag-detection:
  tps-threshold: 18.0  # TPS threshold for lag detection
  check-interval: 60   # Check interval in seconds
  samples-before-alert: 3  # Required low TPS samples
  alert-cooldown: 300  # Seconds between alerts
Configuration Options Explained

  • per-chunk-total: Maximum entities allowed in a single chunk
    • Default: 50
    • Recommended: 30-70
    • Impact: Higher values may cause lag
  • per-type: Individual limits for specific entities
    • Format: ENTITY_TYPE: limit
    • Common types: ZOMBIE, SKELETON, ITEM
    • Use uppercase names from Bukkit EntityType enum

❓ FAQ & Support

Q: How do I update the plugin?

A: Download new version, replace old .jar file, restart server. Configuration files will be preserved.

Q: Will this plugin conflict with my economy plugin?

A: No, AntiLagX is compatible with most economy plugins.

Q: What's the ideal entity limit per chunk?

A: Depends on your server hardware. Start with 50 and adjust based on performance.

Q: Why is my TPS still low after installation?

A: Check:

  1. Other resource-heavy plugins (/al perf)
  2. World size and loaded chunks
  3. Server hardware specifications
  4. Entity counts (/al status)

🔍 Troubleshooting

High Memory Usage

Symptoms:

  • Frequent lag spikes
  • Low TPS
  • Server crashes

Solutions:

  1. Check entity counts
  2. Review plugin list
  3. Adjust memory limits
  4. Increase cleanup frequency
Entity Lag

Symptoms:

  • Mob spawning issues
  • Movement lag
  • Chunk loading delays

Solutions:

  1. Lower per-chunk limits
  2. Increase cleanup frequency
  3. Check mob farm designs
  4. Review world settings

📈 Performance Tips

Server Optimization
  1. Use Paper instead of Spigot
  2. Allocate appropriate RAM
  3. Use SSD storage
  4. Keep worlds small
  5. Pre-generate chunks
Plugin Configuration
  1. Start with conservative limits
  2. Monitor impact of changes
  3. Regular performance checks
  4. Keep logs for analysis
Maintenance Schedule

Daily:

  • Check /al status
  • Review lag alerts

Weekly:

  • Run /al perf
  • Clean unused chunks
  • Review logs

Monthly:

  • Full configuration review
  • Update plugin if needed
  • Backup configurations

✨ Best Practices

Update the plugin

📝 Update Logs

Version 2.0.0 (Initial Release)
  • ✨ Initial release with core features
  • 🚀 Performance optimization system
  • 📊 Monitoring and analysis tools

🔌 Suggested Plugins

LuckPerms
REQUIRED

Essential permissions management system for your server

Download
WorldEdit

Powerful world editing toolkit

Download