SANDBOX — this is a test environment. No servers are actually deployed and no real payments are charged.
Back to NxLabs

NxLabs / Vintage Story

Automated Server Messages

JBy Just_Irish

Admins can set recurring server-wide messages everybody can see.

Automated Server Messages

Description

<h3><em>Version 1.3.1 for game version 1.21.0+ is published. Also works on Vintage Story version 1.22.0+ - March 11, 2026</em></h3> <div class="spoiler"> <div class="spoiler-toggle">Disclaimer</div> <div class="spoiler-text">This mod was designed almost exclusivly with the use of ChatGPT and Claude Sonnet 4/4.5 due to my complete lack of coding knowledge. I merely had the idea and have run numerous tests and basic troubleshooting. I will never claim credit for an AI's work; please forgive me for using it.<br /><br /><em>If you have any issues, please report them. I may not get to them immediately, but eventually I will. Life can get busy, so please be patient with me. If I'm too slow feel free to go grab my code from my github page and fix it, just please give me credit.</em></div> </div> <div class="spoiler"> <div class="spoiler-toggle">THANK YOU!</div> <div class="spoiler-text"><a class="mention username mceNonEditable" href="https://mods.vintagestory.at/show/user/58284FE1C277A97522EF" data-user-hash="58284FE1C277A97522EF">Easyd2</a> and <a class="mention username mceNonEditable" href="https://mods.vintagestory.at/show/user/948E94B14FB86921B9DF" data-user-hash="948E94B14FB86921B9DF">Diff</a> For pointing out issues with the mod. They wouldn't have been fixed without your reports.<br /><a class="mention username mceNonEditable" href="https://mods.vintagestory.at/show/user/2045B0CB2DA1A3849DFF" data-user-hash="2045B0CB2DA1A3849DFF">TheRealFlynn</a> for pointing out my mod page's incorrect information. They were remnants from an old version that I thought I had cleaned.</div> </div> <p>=====================================================================================================================================================================================</p> <h1>Automated Server Messages</h1> <h2>What Does This Mod Do?</h2> <div class="spoiler"> <div class="spoiler-toggle">Explanation/Story Time</div> <div class="spoiler-text"> <p>With this mod you will be capable of setting up server-wide messages that everybody can see in the in-game chat window using commands in either the server terminal or the in-game chat window (as long as you have admin privileges).</p> <p>You can have as many messages as you want and they will stay persistent after a server shutdown or restart, so you will not have to recreate the message. I wanted to create this mod due to having my own server set up to automatically restart twice a day, but there was never any sort of notification. Thus, when the time came, everyone was immediately kicked off the server very abruptly. Since there was no way of knowing, players were always in the middle of something when the time came. So now with this mod I can now set up multiple messages that all players will recieve and hopefully warn them of the impending server restart.</p> <p>Of course, this can be used for other things as well. Perhaps you run a public server and you want to have a recurring message about your Discord, or maybe you want your players to be aware of an issue that you are aware of and are intending to fix. It's entirely up to you within the capabilities of the script.</p> <p><span style="color: #e74c3c;"><strong>Do Keep In mind</strong></span> this mod uses the time of the hosts machine. So if you are renting a server you will need to figure out its time zone and base your messages off of that.<br /><span style="color: #e74c3c;"><strong>ALSO</strong></span>, this is strictly a mod for server-wide messages. Nothing more. It will not create automated tasks for the server. You need to do that manually or use your hosts provided cpanel.</p> </div> </div> <h2>Commands</h2> <h3>Version 1.3.1</h3> <ul> <li><strong>/servermsg clear</strong></li> </ul> <h3>Version 1.2.2+</h3> <ul> <li><strong>/servermsg add [HH:mm] [Type your message here with up to 27 words!]</strong></li> <li><strong>/servermsg remove [index]</strong></li> <li><strong>/servermsg list</strong></li> </ul> <div class="spoiler"> <div class="spoiler-toggle"><span style="color: #e74c3c;">Obsolete Commands (mod version 1.2.1)</span></div> <div class="spoiler-text"> <ul> <li><span style="color: #e74c3c;">/automsg add [HH:mm] [Type your message here with up to 27 words!]</span></li> <li> <p><span style="color: #e74c3c;">/automsg remove [index]</span></p> </li> <li> <p><span style="color: #e74c3c;">/automsg list</span></p> </li> </ul> </div> </div> <h4>Explaining the Commands</h4> <p><br />1. <strong>add</strong> : quite obviously will add a message, but you need the rest of the command for it to do so.<br />2. <strong>[HH:mm]</strong> : references the time you want the message to trigger in a 24 hour format. So if you want your message to trigger at 3 in the afternoon (based on the host machine's timezone), then you would type [15:00] (excluding the brackets).<br />3. <strong>[Type your message here with up to 27 words!]</strong> : Pretty self explanatory (exclude the brackets).<br />4. <strong>remove</strong> : specifically deletes a single automated message. You need the rest of the command for it to work.<br />5. <strong>[index]</strong> : references the message you wish to delete in the order that it was created.<br />6. <strong>list</strong> : will show every single message you have created in the order that they were created.<br />7.&nbsp;<strong>clear</strong> : will delete all currently existing messages. This is an alternative to the&nbsp;<strong>remove</strong> command which deletes individual messages.</p> <div class="spoiler"> <div class="spoiler-toggle"><strong>Examples of Commands Being Used</strong></div> <div class="spoiler-text"> <ul> <li> <p><strong>/servermsg add 05:00 Server restart in 30 minutes.</strong></p> <ul> <li> <p><strong>A message will appear in chat stating that there will be a server restart in 30 minutes at 5:00 am.</strong></p> </li> </ul> </li> <li> <p><strong>/servermsg remove 4</strong></p> <ul> <li> <p><strong>This will remove the fourth message you created

Ratings & reviews

No ratings yet

Sign in to leave a rating or comment.