About Super PVx Info
Adds a highly configurable GUI to players' HUDs indicating whether they are currently in a PvE, PvP, or Safe Zone area, or are currently subject to a PvP expiration delay.
Features:
-
PvE/PvP status for Zone Manager zones
- Supports matching on zone name, True PVE exclusion mappings, or zone flags
- Tested with Dynamic PVP, but should also work with Agile Zones, Zone Manager Auto Zones, etc.
-
PvE/PvP status detection for:
- Abandoned Bases (untested)
- Dangerous Treasures
- Dynamic PVP
- Player Base PVP Zones
- Raidable Bases
-
PvP status detection for:
- Adem event plugins (Caravan, Convoy Reforged) (untested)
- KpucTaJl event plugins (Air Event, Arctic Base Event, Ferry Terminal Event, Gas Station Event, Harbor Event, Junkyard Event, Power Plant Event, Satellite Dish Event, Supermarket Event, Water Event) (untested)
- Cargo Train Event (untested)
- Player height (sky / seasonal dungeons, train tunnels, etc.)
-
PvP expiration delay status detection for:
- Abandoned Bases (untested)
- Dynamic PVP
- Player Base PVP Zones
- Raidable Bases
- Safe Zone status detection
- Tutorial Island detection (treated as PVE)
-
Player notification on state changes not covered by other plugins (e.g. holiday dungeon / train tunnel / safe zone entry/exit)
- Can be enabled in chat and/or in Popup Notifications
- Optional Simple Status support
Commands:
- /pvxui (configurable) toggles the UI off and back on
Configuration:
{ "Server Default PVx (PVP or PVE)": "PVE", "Assume PVP Below Height": -50.0, "Assume PVP Above Height": 1000.0, "Toggle UI Command (empty string to disable)": "pvxui", "Seconds Between Updates": 1.0, "Force Updates On State Change": true, "Minimum Seconds Data File Saves": 5.0, "PVE Exclusion Mapping Names (case insensitive substrings / none to disable)": [ "exclude" ], "PVE Zone Names (case insensitive substrings / none to disable)": [ "PVE" ], "PVP Zone Names (case insensitive substrings / none to disable)": [ "PVP" ], "Notification Settings": { "Chat notify enabled": false, "Chat notify prefix (empty string to disable)": "[SuperPVxInfo]: ", "PopupNotifications notify enabled": true, "PopupNotifications notify prefix (empty string to disable)": "", "Individual Notification Toggles": { "Unexpected Exit From Abandoned Or Raidable Base": true, "Unexpected Exit From Dangerous Treasures Event": true, "Safe Zone Entry": true, "Safe Zone Exit": true, "PVP Height Entry": true, "PVP Height Exit": true, "PVP Depth Entry": true, "PVP Depth Exit": true } }, "Default UI Settings": { "PVE": { "Enabled": true, "Min Anchor": "0.5 0", "Max Anchor": "0.5 0", "Min Offset": "190 30", "Max Offset": "250 60", "Layer": "Hud", "Text": "PVE", "Text Size": 14, "Text Color": "1.0 1.0 1.0 1.0", "Background Color": "0.0 1.0 0.0 0.8", "Fade In": 0.25, "Fade Out": 0.25 }, "PVP": { "Enabled": true, "Min Anchor": "0.5 0", "Max Anchor": "0.5 0", "Min Offset": "190 30", "Max Offset": "250 60", "Layer": "Hud", "Text": "PVP", "Text Size": 14, "Text Color": "1.0 1.0 1.0 1.0", "Background Color": "1.0 0.0 0.0 0.8", "Fade In": 0.25, "Fade Out": 0.25 }, "PVPDelay": { "Enabled": true, "Min Anchor": "0.5 0", "Max Anchor": "0.5 0", "Min Offset": "190 30", "Max Offset": "250 60", "Layer": "Hud", "Text": "WAIT", "Text Size": 14, "Text Color": "1.0 1.0 1.0 1.0", "Background Color": "1.0 0.5 0.0 0.8", "Fade In": 0.25, "Fade Out": 0.25 }, "SafeZone": { "Enabled": true, "Min Anchor": "0.5 0", "Max Anchor": "0.5 0", "Min Offset": "190 30", "Max Offset": "250 60", "Layer": "Hud", "Text": "SAFE", "Text Size": 14, "Text Color": "1.0 1.0 1.0 1.0", "Background Color": "0.0 0.0 1.0 0.8", "Fade In": 0.25, "Fade Out": 0.25 } }, "Simple Status UI Settings": { "PVE": { "Enabled": false, "Background Color": "0.0 0.7 0.0 0.8", "Title Text": "PVE", "Title Color": "1.0 1.0 1.0 1.0", "Status Text": "SuperPVxInfo", "Status Color": "0.0 1.0 0.0 0.2", "Icon Path": "assets/icons/resource.png", "Icon Color": "0.5 1.0 0.5 1.0" }, "PVP": { "Enabled": false, "Background Color": "0.7 0.0 0.0 0.8", "Title Text": "PVP", "Title Color": "1.0 1.0 1.0 1.0", "Status Text": "SuperPVxInfo", "Status Color": "1.0 0.0 0.0 0.2", "Icon Path": "assets/icons/warning_2.png", "Icon Color": "1.0 0.5 0.5 1.0" }, "PVPDelay": { "Enabled": false, "Background Color": "0.7 0.7 0.0 0.8", "Title Text": "WAIT", "Title Color": "1.0 1.0 1.0 1.0", "Status Text": "SuperPVxInfo", "Status Color": "1.0 1.0 0.0 0.2", "Icon Path": "assets/icons/stopwatch.png", "Icon Color": "1.0 1.0 0.5 1.0" }, "SafeZone": { "Enabled": false, "Background Color": "0.0 0.0 0.7 0.8", "Title Text": "SAFE", "Title Color": "1.0 1.0 1.0 1.0", "Status Text": "SuperPVxInfo", "Status Color": "0.0 0.0 1.0 0.2", "Icon Path": "assets/icons/peace.png", "Icon Color": "0.5 0.5 1.0 1.0" } } }
Background:
Super PVx Info attaches a watcher to each player on login that monitors for any changes to PvE/PvP/delay/safezone state, and updates the player's HUD. By default this is done once per second, or as soon as possible after a hook-based change has occurred - but both of these behaviors are configurable, so you can reduce server load (at the cost of reduced GUI responsiveness) by increasing "Seconds Between Updates" and/or disabling "Force Updates On State Change".
This approach is needed to monitor the player's height, and for more accurate safe zone detection (Facepunch is bad at providing triggers for things like exiting Train Tunnels into Outpost).
This plugin is a complete overhaul of Zone PVx Info by BuzZ[PHOQUE]/Arainrr, which I was inspired to attempt after struggling to get it to work with Zone Manager Auto Zones (since abandoned in favor of DynamicPVP).
Credits:
- BuzZ[PHOQUE] & Arainrr for creating Zone PVx Info
- Bug Man & Cannabis on Carbon's Discord server for suggesting the FacepunchBehavior approach and offering examples
- Nivex for putting up with all of my Abandoned/Raidable Bases and TruePVE questions and fixing/enhancing/documenting those plugins
- KpucTaJl for providing API clarification
