Essential Userdata Cleaner
What is this plugin?
Essential userdata cleaner is, as the name suggests, a plugin that can clean your userdata files. It was originally designed to remove “fake” userdata files, that occurred when Leaderheads tried to create and teleport NPC’s.
Read md678685 from the EssentialsX team reason to why this is happening here:
md678685
If this is not what you were looking for, but just simply a plugin to delete userdata files which are older than X days, this plugin can just as easily do that. Simply disable all other checks than lastModified in the config.
Why should you use it
This plugin efficiently cleans up old/invalid files.
The most notable gain is when you use /baltop or /seen <ip>, where Essentials looks through every file. As you can guess, the more files, the slower the search.
This also gives you more free space.
When tested, this plugin deleted files for around 35 MB. This may not sound like much, but this was files generated in a few months. Imagine a server running on the second or third year. After this, then add multiple servers, as most networks have. It can easily run up in gigabytes.
How does it work?
If you are interested in the source code, it can be found here.
If you just want a quick resume of how it works, take a look at the flowchart below. Here every step in the progress is explained.
Flowchart
There are some other features that aren't shown in the flowchart.
You can take a look at the default config here
Config.yml
# Commands:
# /essclean purge - Starts to purge all userdata files (move or delete, depends on settings)
# /essclean confirm - Confirms your purge request, and actually starts.
# /essclean cancel - Cancels your purge request, and the purge wont start!!
# /essclean debug - Enables/disable debug messages to the console
# /essclean reload - Reloads the config.yml, and applies changes.
# Permissions:
# EssUserDataCleaner.use - Allow user to use the plugin.
# Message to send players with no permission. (Standard is default Minecraft unknown command)
# To use color codes, use § and not &. (Example: "§eMessage" instead of "&eMessage")
noPermMsg: '§fUnknown command. Type "/help" for help'
# Max file size in bytes. If the file is bigger it can't be affected in no way.
# To disable, set to -1
maxSize: 100
# Words or sentences the config CAN'T contain. If they contain anything listed below, it won't be affected
# NB: Is case sensitive
# To 'disable', add ’disabled’ as the only entry
cantContain:
- 'homes'
- 'ipAddress'
- 'lastAccountName'
- 'timestamps'
- 'money'
# When should the plugin effect files
# start: When the server starts
# command: When admins run a command to manually do it (The command will always work, no matter the selection below)
# stop: When the server shuts down.
when: 'command'
# If you have set "when" to start, you can specify how many seconds delay from when
# the plugin is enabled, to it starts purging the files here
delay: 10
# Number of days that must have been passed since the file last was modified
# To disable, set to -1
lastModified: 30
# Compare files to usermap.csv - If usermap.csv contains filename, it won't be deleted
# To disable, set to false
compareUsermap: true
# What should happen to the affected files
# move: The folders are moved to "EssUserDataCleaner/backup/" and zipped. (Default)
# delete: The files are permanently deleted, and can't be recovered (DANGEROUS)
todo: 'move'
# Log to the console every file moved/deleted
inform: true
# Only accept commands from console
consoleOnly: falseCommands and permissions
There aren’t many commands or permissions.
But the few there exist, you can see here
Dependencies
This plugin doesn’t require any dependencies, but of course, you can’t delete files that don’t exist. Therefore you must previously have had Essentials(X) installed if you don’t already have it.
Similar projects
Plugin →Let Me Despawn
Improves performance by tweaking mob despawn rules. Say bye to pesky unintentional persistent mobs.
25MSueta
JourneyMap
Real-time map used for mapping in-game or your browser as you explore.
14.7MSueta
Emotecraft
Create your own emotes in Minecraft.
7.5MSueta
Simple Tpa
A simple tpa plugin which sends requests
5.4MSueta
Common Network
Forge and Fabric Unified Networking Solution
3.9MSueta
Set Home
A lightweight plugin for players to set their homes.
3.8MSueta