Clean Server module
for NidToolbox Light
Reporting, maintenance and cleaning little service for your world.
Support is provided as well as suggestions are accepted on my Discord here
Clean Server module functionality:
- Generates detailed report about different kind of rubble present on your server, so you can assess the situation and impact on performance quickly.
- Allows removal of rubble on per type basis.
- Easy to use and very light on system.
Config files are located at Configs\Mods\NidToolbox\ServerCleaner.json
"Info1": "NidToolbox Light: Server Cleaner Settings.",
CleanPeriodically - enables or disables the periodic (timer based) cleanup. It uses CleanEveryMinutes setting.
CleanEveryMinutes - sets minutes value that is used when CleanPeriodically is set to enabled.
CleanAtScheduledTime - enables or disables automatic cleanup at scheduled hours. Uses ScheduledTime list of hours.
ScheduledTime - list of hours in 24h clock format (example: 15:15) that are used when CleanAtScheduledTime is enabled.
CleanMiningRubble - when enabled, automatic cleaner will remove mining rubble.
CleanTreeDebris - when enabled, automatic cleaner will remove tree debris.
CleanFallenTrees - when enabled, automatic cleaner will remove fallen trees and stumps.
ReportInConsole - automatic cleaner info is posted to console, when this setting is enabled.
ReportInLog - automatic cleaner info is logged, when this setting is enabled.
As any module of NidToolbox set, it requires nid-core module, available in the main forum thread: here
How to install:
- Unpack .zip archive
- Copy nid-cleanserver.dll to Mods\NidToolbox\Modules
Displays information about all commands contained within this module.
Prepares a detailed report about different kind of rubble on the server.
Removes all kinds of debris.
Removes mining rubble present on the server.
Removes tree debris - fallen branches.
Removes fallen trees and stumps.
Enables or disables periodic server clean.
Enables or disabled specific hours clean.
Select what should be removed by automatic cleaners - if enabled.
/clear-config bool clearTreeDebris, bool clearMiningRubble
/clear-config true, true
Configures reporting in console and log.
/clear-logger bool reportInConsole, bool reportInLog
/clear-logger true, true
Add specific hour to scheduled cleaner. Accepts strings of 5 characters long separated with colon, in 24h format example: 14:34
/clear-addHour string time
Remove specific hour to scheduled cleaner.
/clear-DelHour string time
Check when next periodic clean will happen.
Lists all hours for scheduled cleaner and time left to trigger.
Set timer for periodic clean - in minutes. When Periodic clean is enabled, this will run the cleaner every X minutes set in here.
/clear-SetTimer float timer
Reloads module configuration from the file. Please take into account that reloading the config file also resets your clean timer (periodic clean task).