Installation

This guide will walk you through installing ClearLaggEnhanced on your Minecraft server.

Prerequisites

Before installing, ensure your server meets these requirements:

• Minecraft Version: 1.20 or higher
• Server Software: Paper, Spigot, or Folia
• Java Version: 17 or higher
• Memory: At least 2GB of RAM allocated

Step 1: Download the Plugin

Download the latest version of ClearLaggEnhanced:

• Modrinth: ClearLaggEnhanced on Modrinth

Make sure to download the .jar file that matches your Minecraft version.

Step 2: Install the Plugin

1. Stop your server (if running)
2. Place ClearLaggEnhanced.jar in your server's plugins folder
3. Start your server
4. The plugin will generate its configuration files

Step 3: Verify Installation

Once your server starts, verify the plugin is running:

/plugins

You should see ClearLaggEnhanced in green, indicating it's enabled.

Check the console for installation messages:

[ClearLaggEnhanced] ClearLaggEnhanced has been enabled!
[ClearLaggEnhanced] Registered module: Entity Clearing
[ClearLaggEnhanced] Registered module: Mob Limiter
...

Step 4: Initial Configuration

After installation, you'll find these files in plugins/ClearLaggEnhanced/:

ClearLaggEnhanced/
├── config.yml              (Main configuration)
├── messages.yml            (Message customization)
├── clearlagg.db            (Database file)
└── module/                 (Module configurations)
    ├── entity-clearing/
    │   ├── config.yml
    │   ├── message.yml
    │   └── inventory_gui.yml
    ├── mob-limiter/
    ├── spawner-limiter/
    ├── misc-entity-limiter/
    ├── chunk-finder/
    └── performance/

Step 5: Basic Configuration

Edit the main configuration file (config.yml):

database:
  type: "sqlite"          # Use sqlite for single servers

modules:
  entity-clearing: true   # Enable entity clearing
  mob-limiter: true       # Enable mob limiting
  spawner-limiter: true   # Enable spawner limiting
  misc-entity-limiter: true
  chunk-finder: true
  performance: true

Step 6: Reload Configuration

After making changes, reload the plugin:

/lagg reload

Important: Never use /reload to reload the entire server. Always use /lagg reload to reload just this plugin.

Optional Dependencies

These plugins are optional but provide additional features:

PlaceholderAPI

Enables placeholders for use in other plugins.

Installation:

1. Download from Modrinth
2. Place in plugins folder
3. Restart server
4. ClearLaggEnhanced will automatically detect it

Placeholders:

• %clearlagenhanced_tps%
• %clearlagenhanced_memory_used%
• And more...

Stacker Plugins

Protect stacked entities from clearing.

Supported Stackers:

• RoseStacker - Modrinth
• WildStacker - BG-Software

The plugin will automatically detect and integrate with these plugins.

ModernShowcase

Protect display cases from entity clearing.

• ModernShowcase – Modrinth

Installation:

1. Download ModernShowcase
2. Place in plugins folder
3. Restart server
4. Protection is automatic

Database Setup (Optional)

ClearLaggEnhanced uses SQLite by default, which requires no setup. For multi-server networks, you can use MySQL:

database:
  type: "mysql"
  mysql:
    host: "localhost"
    port: 3306
    database: "clearlagg"
    username: "root"
    password: "your_password"

Troubleshooting Installation

Plugin Not Loading

Check console for errors:

• Look for stack traces or error messages
• Common issues: Java version mismatch, corrupted JAR file

Verify Java version:

java -version

Must be Java 17 or higher.

Configuration Not Generating

Ensure proper permissions:

• The server must have write permissions to the plugins folder
• Check file system permissions

Commands Not Working

Verify permissions:

• Operators should have all permissions by default
• Check your permission plugin configuration

Common fixes:

• Restart server (don't use /reload)
• Check for command conflicts with other plugins