NidToolbox: Server News module

Contains Server News module for NidToolbox Light server tool-set. Server News can be either displayed automatically on login, or triggered at any time via command.

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 News

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.

Create displayable Server News, containing most recent updates to your server.

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

Server News module allows:

• This simple module allows server admins to list recent Server News on date-by-date basis.
• News can be then displayed by the players in a pop-up window in game via a command.
• It is possible to set the module to display the news automatically on login, and with set delay. For instant display, set delay to 1.
• Module can be reloaded at any time, without the need of a server restart. Both message and configs are then loaded from the files.
• Module is fully customizable, indcluding colors, formatting and font size.
• Title of the window can be set as well, it accepts all currently available in game colors and formatting.
• It is possible to set everything via the in-game commands but, for best results: edit both News Message and config file in the text editor, for the ease of use of all the available formatting tags.

(click to enlarge)

Requirements:

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

How to install:

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

Settings files:

Config files are located at:

1. Configs\Mods\NidToolbox\ServerNews.json - contains module settings.
2. Configs\Mods\NidToolbox\NewsMessage.txt - contains news message.

ServerNews.json:

{
  "Info1": "NidToolbox Light: Server Changelog settings.",
  "WindowTitle": "<color=#add8e6><i>MyServer</i>™</color> <color=yellow>Server News</color>"
  "ShowOnLogin": true,
  "DisplayDelay": 1
}

ShowOnLogin - when true, Server News are displayed when player logs in.

WindowTitle - allows setting title for the window, accepts all kinds of formatting.

DisplayDelay - when ShowOnLogin is set to true, news will be displayed after the delay timer has elapsed.

IMPORTANT: Delay timer starts when the log in request is handed to the server NOT when the player appears in the world, so account additional 6-10 seconds for the word load.

NewsMessage.txt

Quote

<size=38><color=green>Server News for</color> {{USER}}</size>

<i><size=38><color=green>16-May</i></color></size><size=38><color=orange> <i>8:55</i></color><color=#ffffcc> <i><u>General Server Update</u></size></color></i>

<b>*</b> This is an <color=yellow>example changelog</color> note for your server;
<b>*</b> This message is best edited <color=yellow><i>directly from the file</i></color>.
<b>*</b> Added <i>Beautification</i> Mod;
<b>*</b> Removed <color=green>outstanding rubble</color>;

<i><size=38><color=green>7-May</i></color></size><size=38><color=orange> <i>8:55</i></color><color=#ffffcc> <i><u>Fresh Start</u></size></color></i>

<b>*</b> Server has been wiped. Welcome to the new Adventure!

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

Available commands:

/help News

Displays information about all commands contained within this module.

/news-show

Displays current server news.

/news-show

/news-show

/news-titleset

Set Server News window title.

/news-titleset string title

/news-titleset titleString

/news-reload

Reload Server News message and settings from config files.

/news-reload

/news-reload

/news-onlogin

Enable or Disable on Login News window popup.

/news-onlogin bool trueFalse

/news-onlogin true/false

/news-delay

Set News on Login display delay.

/news-delay int seconds

/news-delay 20