RUST GUI Announcements v2.0.6

Very customizable announcements with event support, as well as multiple automatic announcements including restart announcements, GUI Announcements will display an announcement with a custom message across the top of every player's or specific player's screens in a banner automatically and on command.

Features​

Commands

• Announcement commands
• Restart scheduling commands

Events

• Attack heli event announcements
• Airdrop event announcements with optional grid reference
• CH47 event announcements with crate drops and optional grid reference
• Bradley event APC announcements
• Cargoship event announcements
• Oil rig crate hacking announcements

Automatic announcements

• Restart announcements
• Timed interval announcements
• Game time announcements
• Real time announcements
• Respawn announcements
• New player announcements
• Welcome announcements
• Stocking refill announcements
• Player banned announcements
• Join and leave announcements

Customization​

You can change the following of all announcements:

• Font size
• Banner tint
• Text color
• Vertical position
• Fade in and fade out time
• Messages
• Duration

Commands​

This plugin provides both chat and console commands using the same syntax. When using a command in chat, prefix it with a forward slash: `/`.

• announce <message>
  • Sends an announcement with your message to every player
• announce toplayer <playername/64bit SteamID> <message>
  • Sends an announcement with your message to the specified player
• announce togroup <group> <message>
  • Sends an announcement with your message to every player in the specified group
• guia test
  • Creates a test announcement only on your screen with independent customisations in the config, useful to check your customisations before setting them on other announcements
• guia destroy
  • Destroys all announcements currently displaying
• guia toggle [playername/64bit SteamID]
  • Toggles exclusions from announcements for yourself or the specified player
• guia mutebans
  • Mutes ban announcements
• guia schedulerestart <hh:mm:ss> [reason]
  • Schedules a restart at the specified time with the optionally specified reason.
• guia cancelscheduledrestart
  • Cancels a manually scheduled restart
• guia suspendrestart
  • Suspends the next restart
• guia resume restart
  • Resumes the next restart
• guia nextrestart
  • Gets you the next restart
• guia help
  • Shows command usage

Key:

• <required parameter>
• [optional parameter]

Permissions​

This plugin uses the permission system. To assign a permission, use oxide.grant <user or group> <name or steam id> <permission>. To remove a permission, use oxide.revoke <user or group> <name or steam id> <permission>.

• GUIAnnouncements.announce
  • This gives access to all commands
• GUIAnnouncements.toggle
  • This gives access to /guia toggle to toggle only your own exclusion from announcements
• GUIAnnouncements.announcejoinleave
  • This allows a player to have their join and leave announced to the server if enabled
• GUIAnnouncements.getnextrestart
  • This gives access to the /guia nextrestart command
• Auth Level Greater Than 0
  • This gives access to all commands

Configuration​

The settings and options can be configured in the GUIAnnouncements file under the config directory. The use of an editor and validator is recommended to avoid formatting issues and syntax errors.
Config message placeholder support:

• Private New Player Announcements:
  • {rank}, {playername}
• Private Respawn Announcements:
  • {playername}
• Private Welcome Announcements:
  • {playername}, {playercount}
• Public Airdrop Announcements:
  • Text With Grid {grid}
• Public Bradley APC Announcements:
  • Destroyed With Destroyer Text - {playername}
• Public Chinook Announcements:
  • Crate Dropped Text With Grid - {grid}
  • Destroyed With Destroyer Text - {playername}
• Public Helicopter Announcements:
  • Destroyed Text With Destroyer - {playername}
• Public Join/Leave Announcements:
  • {rank}, {playername}
• Public Player Banned Announcement:
  • {playername}, {reason}
• Public Restart Announcements:
  • {time}

Default Configuration​

Localization​

The default messages are in the GUIAnnouncements 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.

Plugin Developers​

Hook​

How to call the exposed hook:
For Example:
Parameters:

• Msg will contain the text you want to display.
• bannerTintColor must be an RGBA string eg. "0.1 0.1 0.1 0.7" or you can chose from the below banner color list.
• textColor must be an RGB string eg. "1 1 1" or you can chose from the below text color list.
• player is optional. If a player is supplied the announcement you are creating will go to that player, if not the announcement will go to all players.
• APIAdjustVPosition will adjust the vertical position of the announcement, the same as in the config. You can use the test announcement to easily get the value needed

Banner Colors: Grey, Red, Orange, Yellow, Green, Cyan, Blue, Purple

Text Colors: White, Red, Orange, Yellow, Green, Cyan, Blue, Purple

FAQ​

Q: Console shows Null Reference Exception every time a player joins my server or dies, how do I fix it?
A: This means that the datafile it is trying to write to has become Null and everytime a player dies/respawns/joins the plugin will fail to write to the file. There are fail safes in place for this, but in case you are still experiencing the issue on the latest build, unload the plugin, delete the date file, load the plugin.

Q: I have RestartServer set to true in the config, but it just stops the server and doesn't start it again.
A: This would be because your startup script does not support starting the server after it has been shutdown. If you have full access to your startup script then use Oxide's default example to make your own.