How to Install and Use the ClearLagg Plugin
Last modified on Jun 8, 2022 in plugins
Overview
One of the biggest concerns for server owners is lag. Lag can be caused for a variety of reasons, whether it’s from what you build, collect and mine on your server or the hardware your server runs on. However if you host with Apex hardware shouldn’t be an issue. There are certain Spigot plugins that can help reduce lag caused by resources or players. ClearLagg is one of the most common plugins for any type of Minecraft server. Essentially what it does is allows you to remove any trouble entities that may exist on your server. Perhaps someone dropped thousands of items in a single chunk, causing your server to lag. This plugin clears dropped entities, ClearLagg ensures that your server stays operating smoothly.
Plugins require you to run a Paper ( We recommend Paper ) or Spigot jar in order to load the ClearLagg on your server. You can find a guide on changing your server jar here.
How to Install ClearLagg
Install through the panel
- To the left of the game panel, press the Plugins List tab.
- Type in “Clearlagg” in the name search and scroll until you find it. Then click on it to open the download page.
- At the bottom of the page, check the version you have selected. It’s good to cross-reference this to the official Bukkit or Spigot page.
- Find the correct version from the version dropdown, select it and press install.
- Go back to the Game Panel and restart your server. You can check if the plugin was installed successfully by typing “pl” into console.
Make sure your server is running Paper or Spigot. You can check this in the jar dropdown on the game panel dashboard.
Install through FTP
- Go to the official ClearLagg page on Spigot and since there is no files tab, this means that as long as your server version is listed you are good to click on download.
- Head to the Game Panel and click FTP File Access to the left of the panel.
- Once you login to the FTP File Access you will see a list of your files. Open the plugins folder and click “Upload” to the top left of the page.
- Drag your plugin over to the right side of the page and wait for it to reach 100%.
- Go back to the Game Panel and restart your server. The plugin should now be installed. You can check this by typing “pl” into console.
Once the file is downloaded, put it in an easy to find spot like your desktop or a folder for later.
How to use ClearLagg
Commands
- /lagg clear: This clears all of the ground entities
- /lagg check: This command counts all of the entities in the world.
- /lagg reload: Reloads schedulers/config file
- /lagg killmobs: This kills all of the mobs in the world
- /lagg area : Removes entities within the given radius
- /lagg chunk: This locates the largest chunks
- /lagg admin: List the admin commands
- /lagg tps: Views the servers current TPS
- /lagg halt: Disables basic server functions such as mob spawning
- /lagg: List all of the commands for ClearLagg
Configuration File
If you make any changes make sure to stop your server first and then click save on the page before you start or restart your server. You can find your configuration file by heading to, the config tab on the left of the main panel page, then find your config for Clearlagg, and clicking on the name of the plugin. Most things in the config file are disabled by default and any line with a “#” in front of it is also disabled.
Broadcast Message
One of the most common configuration changes made is the broadcast message. If you would like to change the messages that are broadcast or disable them you’ll need to scroll down to the “auto-removal” portion of the config doc where you’ll find the “broadcast-message” and the “warnings” section, both of which can be changed to your liking, make sure that you follow the given format.
Entities
Another part in the configuration that you may want to modify is the entities that are removed when lag is cleared. In the configuration, locate the ‘auto-removal:’ section. Below it, you will see some items listed and set to either true or false. You can enable and disable which entities you want removed when lag clears. For example, if you wanted to stop minecarts from being removed you would find `minecart: true` and set it to false.
You can find an in-depth walkthrough of the config here.
Conclusion
Clearlagg is one of the most essential plugins for Minecraft servers, having it helps significantly with lag reduction which is a key part to owning a public server. This plugin is nice because there is not much configuration you will have to do for it, but if you wanted to get configure it more detailed, that is possible as well. Don’t forget that plugins will not work unless your server is running Spigot or Paper.
Similar Plugins
EssentialsX
Coreprotect
NoCheatPlus
