ClearLagg

Config setup

How to setup your config!

Where is the config? plugins\ClearLag\config.yml

settings:
  auto-update: true
  config-version: 8
  disable-waterlife: true
  keep-spawn-in-memory: true
  enable-api: true
  
#Meters your ram usage, if it goes above 'limit', run 'commands:'
# -- 'ram-limit' is in MB, do not set it exactly to your max allocated ram amount
# -- 'interval' is how often clearlag will check your ram usage
# -- 'commands' lists the commands that will be ran upon hitting your ram-limit
ram-meter:
  enabled: false
  interval: 20 
  ram-limit: 5000
  commands:
    - 'lagg killmobs'
    - 'lagg clear'
    - 'lagg gc'
 
#This limits how fast a user can move from chunk-to-chunk and will prevent users from overloading your server
#I HIGHLY recommend you use this on servers with increased player-speeds/or fly enabled
# -- 'limit-only-fly' ONLY limit players who are currently flying
# -- 'chunk-to-chunk-time' is in milliseconds. It's the time users are allowed to move from one chunk
# -- to another.  Going faster over chunks then that number will cancel their movement
player-speed-limiter:
  enabled: false
  chunk-to-chunk-time: 600
  limit-only-fly: false
  
#Should mobs be nerfed to prevent over-breeding to reduce CPU usage (And possibly raise TPS)
#When mobs are stuck too close, collisions are extremely intensive putting a pretty mean load on the server
# -- 'max-mobs' means how many bably/adult animals are allowed within the 'check-radius'
# -- 'check-radius' is the radius of what clearlag will check for 'max-mobs'
mob-breeding-limiter:
  enabled: false
  max-mobs: 6
  check-radius: 15
  
#Should clearlag purge logs under /logs when the server starts?
# -- 'days-old' means how many days old can the log be to be deleted
log-purger:
  enabled: false
  days-old: 3
  
#What type of entities SHOULD NOT be removed while doing /lagg area?
area-filter:
    - Itemframe
    - Painting
    - Wolf
    - Villager
    - Horse
    - ARMOR_STAND

#Should clearlag reset the config, or attempt to update your config on updates
# -- 'force-update' is whether or not clearlag will reset your config with a newer version
# -- settings this to false will make clearlag update your config rather then resetting
config-updater:
  force-update: false
 
#This limits the mob egg spawners so players cannot "overload" the server with them
# -- 'check-radius' is the radius clearlag will check for nearby entities
# -- 'max-mobs' is how many entities may be in the radius before the spawning is blocked
mobegg-limiter:
  enabled: false
  check-radius: 8
  max-mobs: 5
 
#Disable new chunk generation, or just put a cap on how many can load at once.
#May cause many bugs with Spigot 1.8+, not recommended!
# -- 'create-new-chunks' disables or enables chunk creation. false would disallow new chunks 
# -- !UNSTABLE ON SPIGOT BUILDS!
chunk-limiter:
  enabled: false
  limit: 6000
  create-new-chunks: true
 
#This modifies the view range of entities
# -- Lower it is, the better your entity tick will be and the more CPU cycles you'll save
# -- If it's too high, expect bugs / lots of lag
mob-range:
  enabled: false
  zombie: 30
  skeleton: 30
  creeper: 20
 
#How long should items/Mobs be left on the ground
# -- live-time's go by ticks (20 ticks a second)
live-time:
  enabled: false
  interval: 10
  mobtimer: true
  itemtimer: true
  arrowtimer: true
  arrowkilltime: 15
  moblivetime: 600
  itemlivetime: 240
  
#This option disallows the placement of too many tnt-minecarts
# -- 'radius' is the radius clearlag will check for TNT-Minecarts
tnt-minecart:
  enabled: false
  max: 2
  radius: 6
  
#This option reduces global dispenser fire rate
# -- 'time' is in milliseconds
dispenser-reducer:
  enabled: false
  time: 100
  
#This option reduces the explosions of mass amounts of tnt, and reduces tnt lag
tnt-reducer:
  enabled: false
  
#This option reduces fire spread rate
# -- 'time' is in milliseconds
firespread-reducer:
  enabled: false
  time: 2000
  
#How many entities should one chunk be allowed to hold?
# -- 'entities' lists all the entities that will be counted
#     and possibly removed.
chunk-entity-limiter:
  enabled: false
  limit: 10
  entities:
    - Squid
    - Zombie
    - Skeleton
    - Creeper
    - Chicken
    - Pig
    - Sheep
    - Cow
    - Horse
  
#How many mobs should be allowed to spawn globally
# -- 'interval' is the check interval check the current spawn amounts
spawn-limiter:
  enabled: false
  interval: 15
  mobs: 300
  animals: 300
  
#Meters your TPS, if it goes to low, run the commands you wrote below!
# -- 'interval' is how often tps-meter will check the TPS
# -- 'tps-trigger' is at what TPS the commands will be ran at
tps-meter:
  enabled: false
  interval: 15 
  tps-trigger: 14.0
  commands:
    - 'lagg killmobs'
    - 'lagg clear'
  
#This is /lagg killmobs, put what you DON'T want removed! 
# -- 'remove-named', when FALSE entities with custom names will NOT be removed
# -- 'mob-filter' lists which mobs will be IGNORED during /lagg killmobs
kill-mobs:
   remove-named: false
   mob-filter:
   - Villager
   - Wolf
   - ARMOR_STAND
   - Horse
  
#This nerfs mob-spawners (Natural and player-made)
#-------------------------------------------------
#This goes by chunks rather then spawners. This is to prevent
#a large buildup of mob-spawners within a small region to "bypass"
#your set limit. It also allows for keys to be generated more easily
#increasing the performance
# -- 'max-spawn' is the maximum mobs allowed to spawn by a mob-spawner
# -- 'remove-mobs-on-chunk-unload' is whether or not Clearlag should remove
# --  the mobs spawned by the mobspawner upon chunk unload (Highly Recommended)
mobspawner:
  enabled: false
  max-spawn: 4
  remove-mobs-on-chunk-unload: true
  
#Dont use if you have CB++ or Spigot!
item-merger:
  enabled: false
  radius: 6
  
#Auto-removal options
# -- warnings works like this; time = the time warning should be given, msg = warning message at that time
# -- NOTE: The below 'remove' section applies to this remover!
# -- NOTE: Putting the interval to low will cause issues!
#        ==[ All string values MUST be inside '']==
auto-removal:
  enabled: true
  broadcast-message: '&6[ClearLag] &aRemoved +RemoveAmount Entities!'
  broadcast-removal: true
  autoremoval-interval: 460
  world-filter:
  # - this_world <-This world will be ignored during removal!
  boat: true
  falling-block: true
  experience-orb: true
  painting: false
  projectile: true
  item: true
  itemframe: false
  minecart: true
  primed-tnt: true
  item-filter:
  # - 264
  # - 265
  # - 444 <-This item-id will be ignored during removal!
  # - 312
  # - 266
  remove-mobs:
  # - cow <- This mob-type will be REMOVED during removal!
  warnings:
        - 'time:400 msg:&4[ClearLag] &cWarning Ground items will be removed in &7+remaining &cseconds!'
        - 'time:440 msg:&4[ClearLag] &cWarning Ground items will be removed in &7+remaining &cseconds!'
 
#What should be removed during /lagg clear 
command-remove:
  world-filter:
  # - this_world <-This world will be ignored during removal!
  broadcast-removal: false
  boat: true
  falling-block: true
  experience-orb: true
  painting: false
  projectile: true
  item: true
  itemframe: false
  minecart: true
  primed-tnt: true
  item-filter:
  # - 222 <-This item-id will be ignored during removal!
  # - 265
  remove-mobs:
  # - cow <- This mob-type will be REMOVED during removal!
   
limit:
  enabled: false
  max: 1000
  check-interval: 60
  broadcast-message: '&6[ClearLag] &aLimit reached, removed +RemoveAmount Entities!'
  world-filter:
  # - this_world <-This world will be ignored during removal!
  broadcast-removal: true
  boat: true
  falling-block: true
  experience-orb: true
  painting: false
  projectile: true
  item: true
  itemframe: false
  minecart: true
  primed-tnt: true
  item-filter:
  # - 264
  # - 232 <-This item-id will be ignored during removal!

You must login to post a comment. Don't have an account? Register to get one!

  • Avatar of Dooley_labs Dooley_labs Dec 03, 2015 at 15:26 UTC - 0 likes

    Someone please update this page with accurate information. It's grown too outdated for safe use in the new config layout.

  • Avatar of adam9511 adam9511 Nov 08, 2015 at 03:35 UTC - 0 likes

    Works good error free been using this plugin for years , it's currently running on Bukkit 1.8.8-R0.1-SNAPSHOT with no problems ....Thanks Good plugin !

  • Avatar of Aberzhulan Aberzhulan Sep 20, 2015 at 09:12 UTC - 0 likes

    From some quick testing, I found that the config above does not match the actual config I have (unsure if it's the same for everyone). In my config, there is an "item-filter" section for /lagg clear and auto removal that does NOT kill/remove the items listed there. However, the "mobs" section actually removes the mobs listed.

    If you're having issues with mobs being removed you put in the mobs section, try removing those mobs from the list.

  • Avatar of 789101112 789101112 Aug 29, 2015 at 23:56 UTC - 0 likes

    @miki88mouse: Go

    i think in the "remove:" section under either (or both) "item-filter:" or "remove-mobs:" add "- ARMOR_STAND"

  • Avatar of miki88mouse miki88mouse Jul 29, 2015 at 20:21 UTC - 0 likes

    How disable that Armor Stand will be nit removed? with auto clear?

  • Avatar of bob7l bob7l Jun 28, 2015 at 21:04 UTC - 0 likes

    @liammoroney: Go

    Why are you on bukkit? KCauldron is not bukkit

    Open for custom plugins! Skype: bob7l.bob7l.bob7l

  • Avatar of liammoroney liammoroney Jun 15, 2015 at 11:08 UTC - 0 likes

    I am running a server with kcauldron 1.7.10 1448. I have tried multiple versions of clearlag, but the commands dont seem to be working, is there and particular version for me?

  • Avatar of Dirtwrap Dirtwrap Jun 02, 2015 at 03:45 UTC - 0 likes

    can you plz add this option:

    console-messages : true / false # will also post messages on the console to see clearlag has been activated

    very annoying to see if people have been active over night, and see that there is a list of clearlag spamming my console with over 500 messages, be nice to see it in game, but not the console

    Last edited Jun 02, 2015 by Dirtwrap
  • Avatar of EnergyFlame123 EnergyFlame123 Dec 03, 2014 at 21:43 UTC - 0 likes

    In Auto Removal msg can i edit the msg as i like and in the new update its like 400 from 460 so the msg will be shown plz help abouth this section

  • Avatar of pepper82 pepper82 Oct 07, 2014 at 10:53 UTC - 0 likes

    Can I use this plugin to only limit the frames / chests per chunk?


    German Minecraft Server [RPG][PVP][SURVIVAL][+MANY FEATURES]
    Minecraft RPG Survival PvP Server

Facts

Date created
Dec 24, 2012
Last updated
Feb 08, 2016

Author