config.yml

Entity Limits

Use entities from https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/EntityType.html

Groups

You can also set limits on groups. The available mobs change depending on your server's version, so keep that in mind.

Group	Example Mobs (1.20.4)
ANIMAL	Chicken, Cow, MushroomCow, Ocelot, Pig, Sheep, Wolf
MONSTER	Blaze, CaveSpider, Creeper, Enderman, Giant, PigZombie, Silverfish, Skeleton, Spider, Witch, Wither, Zombie
AMBIENT	Bat
WATER_MOB	Squid, Fish
NPC	Villager
VEHICLE	Boat, Minecart
OTHER	Everything else

Spawn Reasons

You can define what spawn reasons the plugin should check a chunk for. Simply by setting true or false.

Use reasons from https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/event/entity/CreatureSpawnEvent.SpawnReason.html

For example, if I want the chunk to be checked when an iron golem is built, I would set:

spawn-reasons:
  BUILD_IRONGOLEM: true

Properties

Property	Description
check-chunk-load	Check a chunk upon load (ChunkLoadEvent).
check-chunk-unload	Check a chunk upon unload (ChunkUnloadEvent).
active-inspections	When a chunk is loaded, recheck it periodically. Check-chunk-load must be true for this to work.
debug	Debug messages, will spam the console with verbose messages when set to true. Best to not set this to true unless debugging an issue.
watch-creature-spawn	Check a chunk when a mob spawns (CreatureSpawnEvent).
watch-vehicle-create-event	Check a chunk when a vehicle spawns (VehicleCreateEvent).
check-surrounding-chunks	Radius of surrounding chunks to check.
inspection-frequency	How often, in seconds, to check the chunk.
notify-players	Notify players in that chunk if stuff has been culled.
preserve-named-entities	Prioritize entities without names over older entities.
preserve-raid-entities	Don't remove pillagers that are part of a raid.
ignore-metadata	Ignore entities with any of the following metadata. For example, shopkeeper npcs.

Excluded Worlds

You can exclude worlds from the check entirely by adding them to this list. For example:

excluded-worlds:
  - "world_nether"

Messages

You can customize the messages used in the plugin by editing the messages block. Common color codes are supported.

In some messages some internal placeholders are used: {material}, {amount}. You can remove these if you don't want to use them.