RUST Realtime Wipe Info v2.1.68

Realtime Wipe Info automatically updates your server hostname and description with the information regarding your wipes. It also has the functionality to prevent people spamming the chat with wipe questions. You could also use this plugin as a general chat filter.

Features​

• Automatic title updating
• Automatic description updating
• Automatic determination of your next wipe date
• Connect message wipe notifications
• Command based wipe notifications
• Chat filtering system with optional wipe replies, also blocks the messages from being sent

The title and description you have on the first plugins load will be stored in a data file (oxide/data/RealtimeWipeInfo.json). The original title gets applied to the server when the plugin is unloaded. This is a safety measure in place in case a server owner ever installs this plugin to test it, but then dislikes it. Obviously if this wasn't in place, their title would be screwed up.

Configuration​

The settings and options can be configured in the RealtimeWipeInfo file under the config directory. The use of an editor and validator is recommended to avoid formatting issues and syntax errors.
Please note that all the features are disabled by default to ensure you set the correct title etc. So configure the plugin to your liking and then reload it.

Date Formatting​

• MMM -- Display three-letter month
• ddd -- Display three-letter day of the WEEK
• d -- Display day of the MONTH
• HH -- Display two-digit hours on 24-hour scale
• mm -- Display two-digit minutes
• yyyy -- Display four-digit year

for more information on date/time formatting.

Description Settings​

The settings listed in this configuration category are strictly settings to be used for the Description editing functionality for this plugin.

Enable Description -- This configuration option enables or disables the Description functionality.

Full Server Description -- This is where you place your desired description for your server. Put a "{0}" where you want the plugins generated data to be placed.

Include Seed & Map Size -- Enables/Disables the functionality to include your servers map size and seed number in the servers description.

Enable Use of Time -- Enables the use of the time in the description, ie "5 hours ago".

Enable Use of Date -- Enables the use of the date of the wipe in your servers description.

Date Format -- This is the format of the date you wish to put in your servers description.

Title Settings​

The settings listed in this configuration category are strictly settings to be used for the Title editing functionality for this plugin.

Enable Title -- Enables the use of the title editing functionality this plugin offers.

Full Server Hostname -- Put your desired server hostname in this section, please put a "{0}" where you want the plugin information to go.

Enable Use Of Time -- Enables the use of the time in the title, ie "5 hours ago".

Enable Use of Date -- Enables the use of the date of the wipe in your servers title.

Date Format -- This is the format of the date you wish to put in your servers title.

Phrase Settings​

These settings are to be used for the phrase functionality. This is one of the more hard categories to configure, so make sure you read this section carefully. Phrases intercept players chat based on what their message contains.

Enable Phrases -- Enables or disables the phrase functionality

Phrases -- This is where you setup your desired words, this is also the hardest part to configure. So, the way this works is you list all of your words you want to set as chat triggers. You can see in the default configuration file a decent example of how to use it. The Send Reply setting is there in case you wan't to NOT send a reply based on the chat trigger. True to send the reply, False to not send the reply. The reply to the chat triggers are for the wipe based chat triggers only. The Block Message setting is there in case you want to prevent the players message from being sent to the servers chat. Setting this to true will block the message, setting to false will not.

Enable Use Of Time -- This enables the use of the time in the phrase message replies. ie "5 hours ago".

Enable Use Of Date -- This enables the use of date in the phrase message replies. ie "8/9"

Date Format -- The format of the date for the phrase replies.

Schedule Settings -- This is yet another hard to configure section of this plugin. Set Enable Wipe Schedule Messages to true if you want to use this functionality. Setting this config option to false will disable this feature. Wipe Schedule In Days is there for the people who want this plugin to automatically determine your next wipe date based on your wipe schedule. The way this works is that it simply adds on those amount of days onto your last wipe date. The Date Format, like the other config options for this, is the format you want your wipe schedule to be displayed.

Connect Message Settings​

This configuration category is for the "welcome" like message a player is presented with when they connect to your server.

Enable Connect Messages -- Enables the use of this feature, true to use it, false to disable it.

Command Settings​

This feature is there for admins to refer to players to use. For example, if a player somehow gets past your phrase trigger words, you can reply to them and say something like "You can see when we wiped by typing /wipe"

Enabled -- Enable the use of the command to send the phrase reply like message.

Command -- The name you want to set the command to.

Default Configuration​

Localization​

The default messages are in the RealtimeWipeInfo file under the lang/en directory. To add support for another language, create a new language folder (e.g. de for German) if not already created, copy the default language file to the new folder and then customize the messages.