NidToolbox: MOTD module

[plugin logo small header]MOTD 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.

Brings back "Welcome Message" known from the old NidToolbox, to brighten every user login event [:)]

SUPPORT IS PROVIDED as well as SUGGESTIONS ARE ACCEPTED on my DISCORD [DISCORD TINY] HERE

FUNCTIONALITY

---

• Highly CUSTOMISABLE WELCOME MESSAGE functionality.
• Can use TEXT TOKENS to personalise the message and provide CURRENT DATA!
• Can be governed by CONFIG FILES and/or from WITHIN THE GAME via commands.
• EASY RELOADS, without the need of a server restart.
• Possibility to show MOTD as popup, confirm window with OK button and chat message or combination of these.
• Possibility to show MOTD only once on server join or every login.
• Server owner controls BOTH THE TITLE OF THE MESSAGE (the "brackets tag") as well as the TITLE WINDOW.
• CONFIG FILE as well as THE DEFAULT MESSAGE are generated on startup of the plugin.

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.MOTD.dll to MODS\NIDTOOLBOX\MODULES
• Configuration files will be created after first run and are located in \Configs\Mods\NidToolbox

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, will replaced with the current viewing user intercatable name.

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

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

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

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

//CO2 levels  // total change in CO2 levels in PPM (integer).  // change in CO2 emissions in last 24 hours in PPM (integer).  // change in CO2 emissions in total only from pollution emitters in PPM (integer).  // change in CO2 emissions from animals in PPM (integer).  // CO2 removed by plants in PPM (integer).  // Total CO2 present (integer).

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

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

SETTINGS

---

CONFIG files are located at CONFIGS\MODS\NIDTOOLBOX\

Motd.json - stores configuration options of the plugin.

MotdMessage.txt - stores actual MOTD message. It accepts all usual Eco's formatting tags .i.e or even icons.

See below for examples.

MOTD.JSON

{   "Info1": "NidToolbox Light: MOTD settings.",   "MotdEnabled": true,   "ShowAsPopUp": false,   "ShowInChat": true,   "ShowAsConfirmWindow": false,   "ShowOnlyOnce": false,   "WindowTitle": "MOTD",   "BlackListed": false }

MOTDMESSAGE.TXT

<size=23><color=yellow>Welcome</color> to our Server, !</size>

Our world has been up for <color=yellow></color>. Our peak activity was <color=#0070B6> <size=26><ecoicon name="nid-User"></size>players online</color> at the same time.

<size=24><ecoicon name="nid-SeaLevel"></size><color=#0070B6>Sea level</color> has risen by <color=#964B00> meters</color> in <color=yellow>last 24 hours</color>, that is <color=#964B00> meters</color> since server start.

<size=26><ecoicon name="nid-CO2"></size><color=#808080>Carbon dioxide levels</color> changed by <color=#964B00> PPM</color> in <color=yellow>last 24 hours</color>, that is <color=#964B00> PPM</color> since server start. <size=24><ecoicon name="nid-CO2"></size><color=#808080>Carbon dioxide lifetime emission</color> from pollution only is <color=#964B00></color> PPM.

<size=26><ecoicon name="nid-Temp"></size><color=orange>Temperature</color> has risen by <color=#964B00></color> degrees in <color=yellow>last 24 hours</color>, that is <color=#964B00></color> degrees since server start. Total <size=26><ecoicon name="nid-Pollution"></size><color=#808080>ground pollution</color> amounts to <color=#964B00> PPM</color>.

There are <color=yellow> <size=26><ecoicon name="nid-User"></size>active players</color> and <color=orange> <size=26><ecoicon name="nid-User"></size>online users</color>, including <color=yellow> <size=26><ecoicon name="nid-User"></size>admins</color>.

COMMANDS

---

/NIDMOTD

Displays information about all commands contained within this module.

/MOTD-RL

Reloads MOTD message from the MotdMessage.txt file.

/motd-rl

Code

/motd-rl

/MOTD-SHOW

Shows current MOTD message.

/motd-show

Code

/motd-show

/MOTD-ENABLE

Sets the whole module to enabled or disabled state

/motd-enable bool trueFalse

Code

/motd-enable true/false

/MOTD-CHAT

Enables or disables of displaying the MOTD