NidToolbox: Clean Server module - Mining rubble, tree debris removal and reporting

Set of server clean and maintenance commands, allowing for removal of mining rubble, tree debris, stumps etc. Generates report detailing rubble present on the server.

NIDTOOLBOX' DOWNLOAD LOCATION CHANGED TO -> https://eco.mod.io <-

! UP TO DATE DOCUMENTATION ONLY UNDER THE ABOVE ADDRESS !

I had to limit the amout of places I need to update the texts whenever I add or remove commands and update individual modules, sorry!

Clean Server module

for NidToolbox Light

requries nid-core module available here

NEW - if you would like to have your server logo appear in the notifications area in messages that come from NidToolbox. Please join my Discord https://discord.nidaren.net/ and post them in #server-logos channel.

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 tailings and rubble present on your server, so you can assess the situation and impact on performance quickly.
• Set up automatic cleaning, either periodic - every X minutes, or at specific hours. Needs to be enabled.
• Clean server module can follow set time zone of your choosing, see nid-core module to see how to set own time zone.
• Allows removal of tailings, rubble on per type basis.
• Allows removal of tailings in specific radius or in target storage.
• Easy to use and very light on the server.

Settings files:

Config files are located at Configs\Mods\NidToolbox\ServerCleaner.json

{
   "Info1": "NidToolbox Light: Server Cleaner Settings.",
  "Info2": "------------------------------------------",
  "CleanPeriodically": false,
  "CleanEveryMinutes": 1440.0,
  "CleanAtScheduledTime": false,
  "ScheduledTime": [
    "10:00",
    "18:00"
  ],
  "CleanMiningRubble": true,
  "CleanTreeDebris": true,
  "CleanFallenTrees": true,
  "CleanStumps": false,
  "CleanTailingsNotContained": false,
  "CleanTailingsInStorages": false,
  "CleanWetTailingsNotContained": false,
  "CleanWetTailingsInStorages": false,
  "ReportInConsole": true,
  "ReportInLog": true,
  "BlackListed": false
}

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.

Requirements:

As any module of NidToolbox set, it requires nid-core module, available in the main forum thread: here

How to install:

1. Unpack .zip archive
2. Copy nid-cleanserver.dll to Mods\NidToolbox\Modules

Available commands:

/help CleanServer

Displays information about all commands contained within this module.

/debris-report

Prepares a detailed report about different kind of rubble on the server.

/debris-report

/debris-report

/tailings-report

Prepares a detailed report about different kind of tailings on the server.

/tailings-report

/tailings-report

/clear-tailings

With no arguments given it will remove all tailings on the server. It has four optional arguments, explained below

/clear-tailings bool clearTailingBlocks, bool clearTailingsInStorages, bool clearWetTilingsBlocks, bool clearWetTilingsInStorages

/clear-tailings

/clear-tailings

/clear-tailingsRadius

Will remove tailings in set radius around player. Has three optional arguments, by default set to true: includeContained - will include tailings in containers, clearTailings - will clear regular tailings, clearWetTailings - will clear wet tailings.

/clear-tailingsRadius int radius, bool includeContained, bool clearTailings , bool clearWetTailings

/clear-tailingsRadius 8

/clear-tailingsRadius 8, true, true, true

/clear-tailingsObject

Will remove tailings in a target object's storage (chest, stockpile, vehicle etc).

You must look at the target object. Has two optional arguments, by default set to true: clearTailings - will clear regular tailings, clearWetTailings - will clear wet tailings.

/clear-tailingsObject bool clearTailings , bool clearWetTailings

/clear-tailingsObject 

/clear-tailingsObject true, true

/clear-alldebris

Removes all kinds of debris.

/clear-alldebris

/clear-debrisRadius

Will remove debris in set radius around player. Has four optional arguments, by default set to true: clearRubble - will clear mining rubble, clearTreeDebris - will clear tree branches, clearFallenTrees - will fallen trees, clearStumps - will clear stumps.

/clear-debrisRadius int radius, bool clearRubble, bool clearTreeDebris, bool clearFallenTrees , bool clearStumps

/clear-debrisRadius  8

/clear-debrisRadius 8, true, true, true, true

/clear-rubble

Removes mining rubble present on the server.

/clear-rubble

/clear-treedebris

Removes tree debris - fallen branches.

/clear-treedebris

/clear-fallenTrees

Removes fallen trees and stumps.

/clear-FallenTrees

/clear-TimerWhen

Check when next periodic clean will happen.

/clear-TimerWhen

/clear-SchedWhen

Lists all hours for scheduled cleaner and time left to trigger.

/clear-SchedWhen

/clear-periodic

Enables or disables periodic server clean.

/clear-periodic true/false

/clear-scheduled

Enables or disabled specific hours clean.

/clear-scheduled true/false

/clear-config

Select what should be removed by automatic cleaners - if enabled.

/clear-config bool clearTreeDebris, bool clearMiningRubble, bool clearTailingsNotContained, bool clearWetTailingsNotContained, bool clearTailingsInStorages, bool clearWetTailingsInStorages

/clear-config true, true, true, true, true, true

/clear-logger

Configures reporting in console and log.

/clear-logger bool reportInConsole, bool reportInLog

/clear-logger true, true

/clear-addHour

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

/clear-addHour 14:34

/clear-DelHour

Remove specific hour to scheduled cleaner.

/clear-DelHour string time

/clear-DelHour 14:34

/clear-SetTimer

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

/clear-SetTimer 1440

/clear-Reload

Reloads module configuration from the file. Please take into account that reloading the config file also resets your clean timer (periodic clean task).

/clear-Reload