Server Restart

Description

Server Restart is a mod that automatically shuts down the server and announces when the restart will happen in specified time intervals. This mod will NOT automatically restart the server, but sample restart scripts will be provided below.

This mod is intended to be used to announce ingame messages without the needing for external scripting to shutdown the server, and instead does it via Minecraft's shutdown method, just as if the /stop command was entered.

 This mod can also be configured to send messages to a discord webhook, allowing users on your discord server to be informed of when the server stops, crashes, and is ready to be played on. No more having players logging in while the server is rebooting!

Installation:

Simply drop the mod into the mods folder, boot the server up, and it will generate default config options. Close the server, edit the config options, and you're good to go!

Settings:

Discord settings:

• avatarUrl is the image url used to set the webhook avatar to. Default is null to use the default webhook avatar.
• embedColor is the color to use for the webhook embeds. It uses the decimal version of hexademical color codes. A yellow color, #E8D44F is default.
• embedFooterText is the additional text to use in the footer of the Discord embed.
• serverName is the server's name to use in the embed.
• startupMessage is the extra string to send when the server starts up. Mentions are allowed, so feel free to ping a roll! Set to "null" to send no message, just the embed.
• webhook in discord.cfg or discord-webhook.toml this is the webhook url to use. Set to null to disabled. Keep this file private, because others will be able to use the webhook url if it's leaked!

Server Restart settings:

• shutdownLength is the amount of time in seconds, before the server will restart.
• pBypassHiddenChat is if the announcement should bypass clients' preference to ignore server chat.

messages.json:

This file is used to control the announcement messages sent before the server restarts. You can add as many messages as you want, just make sure to the file is proper JSON format. "name" is the human friendly name to use. This isn't used by the mod. "time" is the time, in seconds, to send the message before the server restarts. "message" is the message to send to the server. "announceToDiscord" is if the message should also be announced to discord, in addition to the ingame chat.  A default messages.json is provided.

Support Policies:

Fabric versions? Fabric versions are not planned. However, my license allows anyone to port the mod to fabric.

1.11.x and below: No plans to port the mod to versions below 1.12.x.

1.12.x: Only bugfixes will be provided. No new features will be added. 1.12.x will also not report crashes, only regular shutdowns and startups.

1.13.x to 1.15.x: No plans to port the mod to these versions.

1.16.x: Only bugfixes will be provided. No new features will be added.

1.17.x: No plans to port the mod to this version.

1.18.x - 1.19.x: Bugfixes and feature requests will be accepted.

Sample Restart scripts:

https://github.com/FoalFreePress/ServerRestarter/wiki/1.16.x-and-below-scripts

https://github.com/FoalFreePress/ServerRestarter/wiki/1.18.x-and-above-scripts

What means Verified?

• Compatibility: The mod should be compatible with the latest version of Minecraft and be clearly labeled with its supported versions.
• Functionality: The mod should work as advertised and not cause any game-breaking bugs or crashes.
• Security: The mod should not contain any malicious code or attempts to steal personal information.
• Performance: The mod should not cause a significant decrease in the game's performance, such as by causing lag or reducing frame rates.
• Originality: The mod should be original and not a copy of someone else's work.
• Up-to-date: The mod should be regularly updated to fix bugs, improve performance, and maintain compatibility with the latest version of Minecraft.
• Support: The mod should have an active developer who provides support and troubleshooting assistance to users.
• License: The mod should be released under a clear and open source license that allows others to use, modify, and redistribute the code.
• Documentation: The mod should come with clear and detailed documentation on how to install and use it.

How to Install