nid added a new file:
NidToolbox: Timed Messages module
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!
Timed Messages
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 timed messages that trigger either at a specific hour or every X minutes ⏰
Support is provided as well as suggestions are accepted on my Discord
here
Timed Messages module allows:
- Easy creation, sending and display of messages that are based on specific timer.
- Your messages can follow set time zone of your choosing, see nid-core module to see how to set own time zone.
- Module can store multiple messages, which can all have their own timers.
- Two types of timed messages available: Timer Messages - triggering every X minutes and Scheduled Messages - triggering at specific hour.
- Messages accept all the formatting options and colors.
- Messages can be displayed in game chat as well as in a PopUp window.
- Configuration easily viewable in an "at-glance" window.
(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:
- Unpack .zip archive
- Copy nid-timedmessages.dll to Mods\NidToolbox\Modules
Settings files:
Config files are located at:
- Configs\Mods\NidToolbox\TimedMessages.json - contains module settings.
Configuration:
Module operates on 24 hour clock. 5 pm is 17:00, 5 am is 5:00
Timed Messages are created and configured via usage of in game commands.
After creation basic message, it is possible to edit it's full text in a configuration file, allowing for easier adding of formatting tags.
Module contains example messages that are created and activated at the plugin first load. These can be viewed for some example usage.
There are currently two timed messages types:
- Timer Message - this message will trigger every X minutes, for example "Stay hydrated reminder" that will trigger every 30 minutes in game.
- Scheduled Message - this message will trigger at a specific hour, for example "Restart Announcement 30 min to reboot" will trigger at 5:30 every day.
Adding new message is as simple as issuing /timer-add or /sched-add and specifying the details. For more information, check the available commands.
MANUAL CONFIG EDITS: When editing config file by hand, be careful when changing the hour and minutes attribute of the scheduled messages. Avoid leading zeros ,as the automatic config loader does not like these.
Your file will be checked when reloaded in game.
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.
Code//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).
Common commands:
/timer-reload
Reloads settings of the module. Useful if you have edited the config file manually. Will check if the file is correct, before loading it into the server.
/timer-log
Enables or disables logging to log file.
/timer-log bool trueFalse
Code/timer-log true/false/timer-console
Enables or disables reporting in the console.
/timer-console bool trueFalse
Code/timer-console true/false
Timer Messages commands:
/help Timer
Displays information about all commands related to Timer Messages.
/timer-Enable
Enables or disables timer messages.
/timer-Enable bool trueFalse
Code/timer-enable true/false
/timer-ShowMsg
Displays message configuration in a separate window.
/timer-ShowMsg string title
Code/timer-ShowMsg messageTitle
/timer-list
Lists all timer messages.
/timer-List
Code/timer-list
/timer-Add
Adds new timer message. Timer must be given in minutes
/timer-Add string title, string msgText, float timer, bool showAsPopUp
Code/timer-add My New Timer Message, <color=yellow>Some nice text</color>, 20, false
/timer-Del
Deletes timer Message.
/timer-Del string title
Code/timer-Del messageTitle
/timer-Minutes
Changes the default timer of the message. This will change the default timer for the message, it will take effect once the current timer has elapsed.
/timer-Minutes string title, float minutes
Code/timer-Minutes messageTitle, 20
/timer-Running
Changes the running timer of the timer message. This will alter the timer that message is currently under. Has no effect on the default timer.
/timer-Running string title, float minutes
Code/timer-Running messageTitle, 20
/timer-PopUp
Changes the show as PopUp window attribute of the message.
/timer-PopUp string title, bool true/False
Code/timer-PopUp messageTitle, false
/timer-Rename
Changes the title of the message.
/timer-Rename string title, string newTitle
Code/timer-Rename oldTitle, newTitle
/timer-Text
Changes the text of the message.
/timer-Text string title, string newText
Code/timer-Rename title, newText
/timer-Active
Activates or Deactivates the chosen timer message. Allows to disable the specific message, without disabling the whole module.
/timer-Active string title, bool true/False
Code/timer-Active messageTitle, true
Scheduled Messages commands:
/help Sched
Displays information about all commands related to Scheduled Messages.
/sched-Enable
Enables or disables scheduled messages.
/sched-Enable bool trueFalse
Code/sched-enable true/false
/sched-ShowMsg
Displays message configuration in a separate window.
/sched-ShowMsg string title
Code/sched-ShowMsg messageTitle
/sched-list
Lists all scheduled messages.
/sched-List
Code/sched-list
/sched-Add
Adds new scheduled message.
/sched-Add string title, string msgText, int hour, int minutes, bool showAsPopUp
For example: Message that is supposed to be shown at 14:02:
Code/sched-add My New Scheduled Message, <color=yellow>Some nice text</color>, 14, 02, false
/sched-Del
Deletes scheduled Message.
/sched-Del string title
Code/sched-Del messageTitle
/sched-Time
Changes the time at which scheduled message will trigger.
/sched-Time string title, int hour, int minutes
Code/sched-Time messageTitle, 14, 02
/sched-PopUp
Changes the show as PopUp window attribute of the message.
/sched-PopUp string title, bool true/False
Code/sched-PopUp messageTitle, false
/sched-Rename
Changes the title of the message.
/sched-Rename string title, string newTitle
Code/sched-Rename oldTitle, newTitle
/sched-Text
Changes the text of the message.
/sched-Text string title, string newText
Code/sched-Rename title, newText
/sched-Active
Activates or Deactivates the chosen timer message. Allows to disable the specific message, without disabling the whole module.
/sched-Active string title, bool true/False
Code/sched-Active messageTitle, true
