NidToolbox: Server Rules module

Enables server rules enforcement. Provides the ability to restrict certain player actions, until they accept the set of server rules.

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!

Server Rules 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.

This module enables sever owner to enable and enforce set of Server Rules. Certain actions of the players can be restricted, until they have accepted the Server ruleset.

Support is provided as well as suggestions are accepted on my Discord here

Server Rules module offers:

• Prevent player actions as: mining, digging, loitering, tree chopping until they have accepted server rules.
• Module has own AuthProvider, which means it does not mess or interfere with Server's established laws or demographic systems and allows for module to have more granular control on what players can and cannot do.
• Provides means for the admins to help protect the server from players, who log just for short time and create mess on the server.
• Ability to customise Rules popup - it supports all standard Eco's formatting- such as: <b> <color=yellow> <u> or icons.
• Ability to customise confirmation button that displays the required info to the player, prior to the rules acceptance.
• Ability to customise deny message that appears when player who did not accept server rules, tries to execute denied action.
• Ability to customise notification being sent to players when they join the server.
• Easy reloads, without the need of a server restart.
• Configuration of the plugin can be displayed at any time, without the need to dig into the files themselves.
• Possibility to require a password for the Rules acceptance, that can be hidden somewhere within Rules text. It helps assure that players actually read the popup
• Ability to easily display players, who have not accepted the rules yet.

Text Tokens

Modules that use textual files or send data, can now take advantage of the text tokens.

These allow for message customization and a way to provide current server data.

All of the data is read directly from the server, from already available sources, with the exception to USERSPEAKONLINE and USERSPEAKONLINEDATE these two are counted from the moment of installing NidToolbox and can be set manually via respective commands.

Text of Hello, {{USER}} will replaced with the current viewing user intercatable name.

//User related
{{USER}} // returns interactable player name (string).
{{USERWITHTAGS}} // returns interactable player name with their server roles (string). NOTE: This respects showInUI setting for ChatTags!

//Admins and active users
{{USERSACTIVE}} // players in Active demographic (integer).
{{USERSPEAKACTIVE}} // most the Active demographic ever had (integer).
{{USERSPEAKONLINE}} // most users online (integer)
{{USERSPEAKONLINEDATE}} // when the online peak users occurred (string) i.e. 12-May-2024 16:24 
{{USERSONLINE}} // users online currently (integer).

//Age related
{{WORLDAGE}} // how long was the world up in format XX days and YY hours (string).

//Sea levels
{{SEARISENTOTAL}} // total change in sea level in meters (integer).
{{SEARISENTODAY}} // change in sea level in last 24 hours in meters (integer).

//CO2 levels
{{CO2RISENTOTAL}} // total change in CO2 levels in PPM (integer).
{{CO2RISENTODAY}} // change in CO2 emissions in last 24 hours in PPM (integer).
{{CO2LIFETIMEPOLLUTION}} // change in CO2 emissions in total only from pollution emitters in PPM (integer).
{{CO2LIFETIMEANIMALS}} // change in CO2 emissions from animals in PPM (integer).
{{CO2LIFETIMEPLANTS}} // CO2 removed by plants in PPM (integer).
{{CO2TOTAL}} // Total CO2 present (integer).

//Temperature
{{TEMPRISENTOTAL}} // total change in temperature levels in degrees of units that server follows. (integer).
{{TEMPRISENTODAY}} // change in temperature in last 24 hours in degrees of units that server follows (integer).
{{TEMPAVERAGE}} // average global temperature in degrees of units that server follows (integer).

//Ground pollution
{{GROUNDLIFETIMEPLLUTION}} // total change in ground pollution levels in PPM (integer).

Future plans:

• This module will be extended in the future to allow the ability to prevent or limit certain actions for exact amount of time , issue temporary bans and such.

Requirements:

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

How to install:

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

Settings files:

Config files are located at Configs\Mods\NidToolbox\

ServerRules.json - stores configuration options of the plugin.

Rules.txt - stores text for the Rules popup. Supports standard Eco's formatting tags .i.e <b> <u> <color> or even icons.

RulesConfirmMessage.txt - stores the text for the Confirmation Button (see below) that displays the final conformation message to the player, prior for them accepting the rules. The lookout of this button can be tested via /rules-showbutton command. Button text also supports standard Eco's formatting tags .i.e <b> <u> <color> or even icons.

RulesDenyMessge.txt - stores the text for the Action Denied Message (see below) that displays when user that have not accepted server rules, tries to execute forbidden action. The lookout of this message can be tested via /rules-testdeny command. Supports standard Eco's formatting tags .i.e <b> <u> <color> or even icons.

RulesNotification.txt - stores the text for the Notification Message (see below) which is sent as mail (bell notification) to the user when they join the server. The lookout of this message can be tested via /rules-testNotifycommand. Supports standard Eco's formatting tags .i.e <b> <u> <color> or even icons.

All config files are created upon first start of the plugin.

See below for examples.

Rules.json

{   
    "Info1": "NidToolbox Light: Rules settings.",  
    "RulesEnabled": true,  
    "PreventClaiming": false,  
    "AllowStarterCamp": true,  
    "PreventChopping": false,  
    "PreventMining": false,  
    "PreventLittering": false,  
    "PasswordEnabled": false,  
    "Password": "someSecretPassword",  
    "InformEveryone": true,  
    "RulesWindowTitle": "Server Rules"
}

RulesEnabled sets the module enabled or disabled, can be set in game via /rules-enable command.

InformEveryone toggles the message to be sent to everyone on the server, when someone accepts the rules.

PreventClaiming prevents claiming action until player accepted server rules, can be toggled in game via /rules-prevent claiming with bool true or false.

AllowStarterCamp allows placing starting camp for new players, even if server prevents claiming land until rules acceptance.

PreventChopping prevents tree chopping action until player accepted server rules, can be toggled in game via /rules-prevent chopping with bool true or false.

PreventMining prevents mining action until player accepted server rules (this also includes digging action), can be toggled in game via /rules-prevent mining with bool true or false.

PreventLittering prevents dropping trash action until player accepted server rules, can be toggled in game via /rules-prevent littering with bool true or false.

PasswordEnabled sets password requirement to true or false, can be toggled in game via /rules-requirepass with bool true or false.

Password sets the actual password, can be changed in game via /rules-password.

RulesWindowTitle sets the title of the rules window.[/tt].

See below for the list of all available commands in this module with their example usage.

Rules.txt

<color=green><b>Server Rules</b></color>
    1.
    2.
    3.
    4.


Have fun!

<i>Server admins</i>

RulesConfirmMessage.txt, affects this button in game: (click to see the image)

RulesDenyMessage.txt, affects this message in game: (click to see the image)

RulesNotification.txt, affects this message in game: (click to see the image)

Example screenshots:

Available commands:

/help nidRules

Displays information about all commands contained within this module.

/rules-reload

Reloads Rules message from the Rules.txt file.

/nidrules-reload

/rules-reload

/rules-show

Shows current Rules popup.

/rules-show

/rules-show

/rules-enable

Sets the whole module to enabled or disabled state

/rules-enable bool trueFalse

/rules-enable trueFalse

/rules-prevent

Prevents set action from being used by player until they accept the rules. Accepts the following options as actionName claiming chopping littering mining

/rules-prevent string actionName bool true or false

/rules-prevent actionName, trueFalse

/rules-not

Displays the set of players who have not accepted the server ruleset yet.

/rules-not

/rules-not

/rules-requirepass

Sets the password requirement for rules acceptance.

/rules-requirepass-title bool trueFalse

/rules-requirepass trueFalse

/rules-password

Sets the actual password.

/rules-password string password

/rules-password password

/rules-WindowTitle

Sets the window title for Server Rules pop-up.

/rules-WindowTitle string title

/rules-WindowTitle title

/rules-showconfig

Shows the current configuration of the module

/rules-showconfig

/rules-showconfig

/rules-showbutton

Shows confirmation button to test how it looks. Clicking yes or no has no effect, as this is just a test.

/rules-showbutton

/rules-showbutton

/rules-testDeny

Shows deny message to test how it looks.

/rules-testDeny

/rules-testDeny

/rules-testNotify

Sends user a notification to test how it looks.

/rules-testNotify

/rules-testNotify

/rules-accept

Allows to accept server rules, triggers confirmation button to appear for the accepting player.

/rules-accept string password (it is optional)

/rules-accept password