Raid Time Protection

Raid Time Protection 2.1.0 — user guide

Beta 2.1.0. The LTS version published on Codefling remains 2.0.0. Downloading the plugin requires sign-in and a verified entitlement for the requested version. Check its product page for available access. Configuration exports remain available without buying the plugin.

This guide covers beta 2.1.0 and configuration format 2. Codefling still distributes version 2.0.0.

Installation

1. Stop the server or use the framework's documented safe plugin-reload procedure.
2. Back up the existing RaidTimeProtection.json configuration.
3. Copy RaidTimeProtection.cs to the framework plugin directory.
4. Start or reload the plugin.
5. Review the generated configuration before allowing players to connect.

The web configurator exports RaidTimeProtection.json. Install it as oxide/config/RaidTimeProtection.json, or in the corresponding Carbon config directory, then reload the plugin. You can also connect your server to the Hub to apply the configuration over SFTP and reload the plugin over RCON.

Version 2 can migrate a readable legacy configuration. Keep the generated .v1.bak until the configuration and schedule are confirmed.

Schedule model

Each day defines when raiding becomes allowed and for how many minutes. The configured UTC offset is fixed; it does not change automatically for daylight saving time.

A Friday start at 22:00 with a duration of 360 minutes allows raiding until Saturday 04:00. Intervals include their start and exclude their end.

When global protection is enabled:

• post-wipe protection always keeps protection active;
• raiding is allowed inside the weekly raid window;
• protection is active outside the window.

When global protection is disabled by a healthy configuration, damage is allowed regardless of the wipe and weekly schedule. Invalid or unreadable configuration cannot disable protection.

Damage policy

The plugin uses a deliberately narrow damage policy:

• the target must be an owned DecayEntity with a building privilege;
• the hit must be attributed to a player;
• TC-authorized players may damage the target;
• configured prefabs and Zone Manager zones may allow damage;
• decay, electric, NPC player, Bradley APC, and CH47 damage are excluded;
• otherwise an eligible protected hit is reduced to zero.

Indirect damage without an attributable player is not claimed as protected. Rockets, splash, fire, MLRS, patrol helicopter, vehicles, doors, deployables, external walls, and other current Rust paths require the retained live-smoke matrix before public coverage claims.

Command and disclosure

/raid_date is intentionally public and read-only. It reports whether protection is active and the next transition in UTC. Server operators should treat the schedule as public information. No permission is required in version 2.1.0, and there is no state-changing command.

Optional dependency

Zone Manager is optional. If it is absent, fails, or returns an unsupported value, no zone exclusion is applied and protection remains in force for an otherwise eligible target. Configure zone identifiers under (ZoneManager) Disabled protection zones.

State-change alerts use built-in server chat. Notify is not required. The legacy JSON property label is retained for configuration compatibility.

Localization

The plugin registers English message keys through the framework language service. Operators can override:

• BuildingProtected
• ProtectionActivated
• ProtectionDeactivated
• StatusProtected
• StatusAllowed
• StatusNoTransition
• ActiveWord
• InactiveWord

Keep placeholders such as {0} intact.

Known limitations

Compilation checks do not validate live damage behavior. Before changing a production server, verify the configured schedule, damage rules and any Zone Manager integration on a test server.

Configuration example

{
  "Schema Version": 2,
  "UTC Offset Minutes": 120,
  "Wipe Protection Time (in hours)": 48.0,
  "Global Protection": {
    "Enabled": true,
    "(ZoneManager) Disabled protection zones": [],
    "Disable protection prefabs (optional)": [],
    "Friday": {
      "Stop Protection Hours": 22,
      "Stop Protection Minutes": 0,
      "Stop Protection Duration (in minutes)": 360
    }
  }
}

This Friday window starts at 22:00 in the configured fixed offset and ends at 04:00 Saturday. The offset does not change automatically for daylight saving.

Troubleshooting and FAQ

• If the schedule is shifted, verify UTC Offset Minutes and update it when your local daylight-saving policy changes.
• If a cross-midnight window ends unexpectedly, configure the full duration on the day where the window starts.
• If a Zone Manager exclusion is ignored, verify the exact zone ID and the integration response; an unavailable integration keeps protection active.
• If post-wipe protection lasts longer than expected, verify the configured fractional hours and the server wipe timestamp.
• /raid_date is intentionally public and read-only. No permission is required.
• Notify is not required; the retained legacy label controls built-in chat alerts.

Interface and advance warnings

Appearance controls the protection HUD, schedule and notices. Native rendering needs neither PimpMyCUI nor ImageLibrary. Choose Bastion, Signal or Gazette; Classic, Compact and Contrast are their legacy aliases, still accepted on import.

Players open the schedule with /raid, toggle their HUD with /raid hud, and check status in chat with /raid_date. The HUD shows global schedule status. Ownership, TC privilege and exclusion conditions still apply to individual targets.

X/Y positions use normalized coordinates from 0 to 1 at the HUD’s top-right reference point. Scale ranges from 0.6 to 1.5, capped at 1.1 for the schedule. Colors retain three RGB channels; opacity is a separate setting.

Advance warnings can announce upcoming transitions in chat and on screen. They are disabled by default. Set up to 16 distinct lead times, from 1 to 1,440 minutes. The plugin accounts for post-wipe protection and does not replay past warnings after a reload.

Version 2.0.0 configurations remain readable. Interface sections are optional and use native defaults when omitted. PimpMyCUI rendering requires a compatible package approved on the server; if unavailable, native rendering is used.

HUD position and versions

Version 2.1.0 places the HUD at X=0.985, Y=0.985 by default. Keep your own coordinates if you moved it. /raid and /raid_date show the schedule and protection status.