From 9c03781babfb88f6096313cb3e107b887b20aa9a Mon Sep 17 00:00:00 2001 From: Steve Guidetti Date: Sat, 9 Feb 2019 14:19:39 -0800 Subject: [PATCH] Update readme --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e3317bb..32c6dbe 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,29 @@ # Server Shutdown -Plugin for SevenMod that schedules automatic server shutdowns and enables shutdown votes. +Plugin for SevenMod that schedules automatic server shutdowns and enables shutdown votes. This plugin is in early development and is not ready for use in a live environment. **Use at your own risk.** + +## Configuration + +File: **ServerShutdown.xml** + +| Property | Default | Description | +| ------------------------------------ | ------- | ---------------------------------------------------------------------------------------- | +| `ServerShutdownAutoRestart` | `True` | Enable if the server is set up to automatically restart after crashing | +| `ServerShutdownCountdownTime` | `5` | The countdown time in minutes for scheduled shutdowns | +| `ServerShutdownEnableRestartCommand` | `True` | Enable the restart admin command | +| `ServerShutdownEnableVote` | `True` | Enable the voteshutdown admin command | +| `ServerShutdownSchedule` | `""` | The automatic shutdown schedule in the format HH:MM. Separate multiple times with commas | +| `ServerShutdownVotePercent` | `0.60` | The percentage of players that must vote yes for a successful shutdown vote | + +## Admin Commands + +| Command | Arguments (_\ [optional]_) | Access | Description | +| ------------------- | ------------------------------------- | --------- | ------------------------------------- | +| `sm cancelrestart` | | Changemap | Cancels an impending restart | +| `sm cancelshutdown` | | Changemap | Cancels an impending shutdown | +| `sm restart` | [minutes] | RCON | Starts a server restart | +| `sm voterestart` | | Vote | Starts a vote to restart the server | +| `sm voteshutdown` | | Vote | Starts a vote to shut down the server | ## License