Migration Guide

If you are currently using older lag-reduction plugins like ClearLag, this guide will help you transition to ClearLaggEnhanced.

Why Migrate?

  • Folia Support: ClearLaggEnhanced is designed for the modern multi-threaded server architecture.
  • Modular Design: Easier to configure and manage only the features you need.
  • In-Game GUI: No more constant YAML editing; manage everything while playing.
  • Intelligent Limiting: Instead of just clearing entities, you can set granular limits per chunk or world.

Step-by-Step Migration

1. Backup Your Old Data

Before making any changes, it's always a good idea to back up your existing server files and plugin configurations.

2. Remove the Old Plugin

Delete the .jar file and the configuration folder for your previous lag-reduction plugin (e.g., ClearLag.jar and the plugins/ClearLag/ folder).

3. Install ClearLaggEnhanced

Download the latest ClearLaggEnhanced.jar and place it into your plugins/ folder.

4. Replicate Old Settings

While ClearLaggEnhanced has different configuration keys, you can replicate most common settings:

  • Clearing Intervals: Set in modules/entity-clearing/config.yml.
  • Protected Entities: Configure in modules/entity-clearing/config.yml.
  • Chunk Limits: Set in modules/mob-limiter/config.yml.

5. Final Check

Start your server and use /clearlagg status to ensure everything is running correctly.

Common Differences

  • Commands: ClearLaggEnhanced uses /lagg (or /cl) instead of /lagg.
  • Permissions: All permissions start with CLE.*. See the Commands & Permissions page for details.