Skip to content
This repository has been archived by the owner on Mar 25, 2019. It is now read-only.

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
stevotvr committed Feb 9, 2019
1 parent 3e23f1b commit 9c03781
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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 (_\<required\> [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

Expand Down

0 comments on commit 9c03781

Please sign in to comment.