NidToolbox: Clean Server module

[plugin logo small header]Clean Server module for NIDTOOLBOX Light

[kofi button blue]

Compatible with ECO 13+

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 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 [DISCORD TINY] HERE

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.
• Clean server module CAN FOLLOW SET TIME ZONE OF YOUR CHOOSING, see NID-CORE module to see how to set own time zone.
• Set up automatic cleaning, either periodic - every X minutes, or at specific hours. Needs to be enabled.
• 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

---

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.

CleanStumps- when enabled, automatic cleaner will remove 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

INSTALLATION

---

• Unpack .zip archive
• COPY Eco.Nid.CleanServer.dll to MODS\NIDTOOLBOX\MODULES
• Configuration files will be created after first run and are located in \Configs\Mods\NidToolbox

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

Code

/debris-report

/TAILINGS-REPORT

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

/tailings-report

Code

/tailings-report

/CLEAR-TAILINGS [1711-RCON-PNG]

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

Code

/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

Code

/clear-tailingsRadius 8

/clear-tailingsRadius 8, true, true, true

/CLEAR-TAILINGSOBJECT

Will remove tailings in a target object's storage (stockpile, chest, 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

Code

/clear-tailingsObject

/clear-tailingsObject true, true

/CLEAR-ALLDEBRIS

Removes all kinds of debris - rubble, tree leftovers etc.

Code

/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

Code

/clear-debrisRadius 8

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

/CLEAR-RUBBLE

Removes mining rubble present on the server.

Code

/clear-rubble

/CLEAR-TREEDEBRIS

Removes tree debris - fallen branches.

Code

/clear-treedebris

/CLEAR-FALLENTREES

Removes fallen trees, has option to remove stumps too (false by default).

/CLEAR-FALLENTREES BOOL REMOVESTUMPS

Code

/clear-FallenTrees true/false

/CLEAR-PERIODIC

Enables or disables periodic server clean.

Code

/clear-periodic true/false

/CLEAR-SCHEDULED

Enables or disabled specific hours clean.

Code

/clear-scheduled true/false

/CLEAR-CONFIG

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