NidToolbox: Clean Server module

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 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

<pre> { "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 }</pre>

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

---

1. Unpack .zip archive
2. Copy Eco.Nid.CleanServer.dll to Mods\NidToolbox\Modules
3. 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

<pre>/debris-report</pre>

 

/tailings-report

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

/tailings-report

Code

<pre>/tailings-report</pre>

 

/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

Code

<pre>/clear-tailings</pre>

 

/clear-tailingsRadius