Workshop Updater

Overview

The workshop updater plugin monitors the Steam Workshop and notifies players when an active mod on your server has updated. If the server is empty when an active mod updates, the plugin immediately cycles the map. The plugin will stop monitoring the Steam Workshop when it detects a mod update. All of this minimises the chances for incoming players seeing the "mod out of date" error when joining your server.

When the plugin detects an update to an active mod, it notifies players with a message similar to the following:

The "Shine Administration" mod has updated on the Steam Workshop.
Players cannot connect to the server until map change.

If the "ForceMapChangeAfterNotifications" config option is set to a non-zero value, the notification messages will display the time remaining to the forced cycling of the map.

The plugin was contributed by lancehilliard.

NOTE: If you have configured a workshop backup server, then this plugin will automatically disable itself.

Config

The plugin automatically detects which Steam Workshop mods are active on your server, so all that's left is configuring how often you want it to check for updates and, if one is found, how often you want it to display notifications (for the duration of the current map).

The default config looks something like this:

{
    "CheckInterval": 60,
    "RepeatNotifications": true,
    "NotifyInterval": 180,
    "ForceMapChangeAfterNotifications": 5,
    "ForceMapvote": false,
    "ForceMapvoteAtRoundEnd": false
}

The file should be called "WorkshopUpdater.json" and should be placed in the directory defined as your plugin config directory (default is config://shine/plugins).

Option	Description
CheckInterval	Number of seconds between each check of the Steam Workshop.
RepeatNotifications	If true, notifications will repeat at the interval defined in "NotifyInterval".
NotifyInterval	Number of seconds between each repeated update notification.
ForceMapChangeAfterNotifications	Number of update notifications after which to cycle the map even if players are present and/or playing. Set to 0 to disable. If this is set higher than 1, be sure to set "RepeatNotifications" to true.
ForceMapvote	If set to true, a map vote will be called when a mod is out of date.
ForceMapvoteAtRoundEnd	If set to true, a map vote will be called at the end of the current round when a mod is out of date.