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

Due to human (non-bot) spam the first contribution of a user has to be reviewed and activated manually, all further contributions do not require this.
As long as a user does not have at least one reviewed and activated contribution, the user is unable to edit his profile, set a avatar, title picture or a signature.

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.

1573-nidtoolbox-design01-nid-64-png

Clean Server module

for NidToolbox Light

requries nid-core module available here


1586-default-violet-2-png



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.
  • Set up automatic cleaning, either periodic - every X minutes, or at specific hours. Needs to be enabled.
  • Allows removal of rubble on per type basis.
  • Easy to use and very light on system.


Settings files:

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



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

Code
/debris-report


/clear-alldebris

Removes all kinds of debris.

Code
/clear-alldebris


/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 and stumps.

Code
/clear-FallenTrees



/clear-TimerWhen

Check when next periodic clean will happen.

Code
/clear-TimerWhen




/clear-SchedWhen

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

Code
/clear-SchedWhen




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

/clear-config bool clearTreeDebris, bool clearMiningRubble

Code
/clear-config true, true



/clear-logger

Configures reporting in console and log.

/clear-logger bool reportInConsole, bool reportInLog

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


Code
/clear-addHour 14:34



/clear-DelHour

Remove specific hour to scheduled cleaner.

/clear-DelHour string time


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


Code
/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).


Code
/clear-Reload

Images

  • Version 1.5.3

    • clear-SchedWhen and clear-TimerWhen will organize the list of events from the closest in time to the most distant.
    • Adds now required TimeSpan TimeLeft to INidSchedulable which this module uses.
    • Requires nid-Core version 1.5.5
  • Version 1.5.2

    • Added ability to clean Tree Debris (branches) and Fallen Trees separately.
    • Added new command to Clear Fallen Trees.
    • Added new command to display time remaining till next periodic clean.
    • Added new command to display all hours and time left until their next execution in Scheduled Cleaner.
  • Version 1.5.1

    • Added ability to clean server automatically, either at specific intervals or specified hours.
  • Version 1.5.0

    * (RC.2) Module output filename updated to match namespace.


    * Module updated to Eco 9.5.0


    * REQUIRES: EM-Framework 3.2.0-RC.3 or higher.

  • Version 1.1.2

    Version 1.1.2

    • Compatibility patch with EM Framework 3.1.0
    • Requires EM Framework 3.1.0
  • Version 1.1

    Version 1.1

    • Added command clear-alldebris, this command will clear both mining rubble and tree debris.
    • Migrated project to Net5.
    • Compatibility patch with Eco game version 9.4.
  • Version 1.0.1

    Version 1.0.1

    • Upgraded to full-fledged NidModule instead of a command snap-in;
    • Added requirement for nid-core module enforcement. If the module is not found or in wrong version, it will be reported to the server owner, instead of showing default net cryptic error message;
    • Migrated project to NetStandard 2.1.
  • Version 1.0.0

    Initial release.

  • Downloaded it and the sever has been up a hour. I do the report and it says gathering report then nothing happens

    • This has been solved on Discord - server installation was corrupted.

  • So this mod required "NidToolbox Light" ?

    • Hello My Friend, thank you for your interest.


      Yes - it Clean Server is one of the modules to NidToolbox Light. It is fully modular project so you can mix and match the components you like. The only required module is nid-core rest is optional. Nid Core can be downloaded in main thread of NidToolbox Light.


      I made a description clearer on this.