Offline Raid Limiter

Key Features

• Offline Raid Session Limit: Configurable per player, limiting the number of offline raids per day.
• Proximity-based Raid Tracking: Limits raids based on proximity to Tool Cupboards (TCs), ensuring only relevant raids are counted.
• Discord Integration: Sends real-time raid alerts to Discord, with details like attackers, defenders, weapon used, and raid location.
• Modded Server UI: Provides an in-game UI for raid tracking, showing active raids and player stats.
• Block Damage on Raid Limit Reached: Prevents damage when the raid session limit is exceeded, protecting players from further attacks.
• API Integration: Sends raid session data to an external API for real-time tracking and integration with external systems.
• Detailed Logging: Provides detailed logs for debugging and tracking raid activity, both in Discord and the console.
• Edge Case Handling: Includes logic for handling edge cases such as players leaving and rejoining teams, and defending players being offline during raids.

How it Works

1. Vanilla Servers: The plugin tracks and logs offline raids, sending notifications to admins via Discord with details such as attackers, defenders, and raid specifics.

2. Modded Servers: In addition to tracking and logging, it displays an in-game UI showing raid details and player stats. It also allows blocking damage once a raid limit is reached.

3. Proximity-Based Tracking: The plugin uses Tool Cupboards (TCs) to determine if a raid is within range, ensuring that only raids within the defined proximity are tracked.

4. Blocking Damage on Raid Limit: Once the raid session limit is reached for a player, the plugin can block further damage to prevent unfair raiding.

5. API Push: When enabled, the plugin pushes raid session data to an external API for tracking and reporting purposes.

6. Scheduled Cleanup: The plugin regularly checks for expired raid sessions and cleans them up to prevent data buildup.

Configuration Settings

Raid Proximity Threshold (in meters): The maximum distance at which a raid is considered valid based on proximity to the base. Example: 140f (default value).

Offline Raid Session Limit (per day): Limits the number of offline raids a player can participate in per day. Example: 1 (default value).

Base Session Cooldown (in minutes): Time before a raid session expires and can be logged again. Example: 45 minutes (default value).

Discord Webhook URL for Raid Alerts: URL for sending raid alerts to Discord. Example: https://discord.com/api/webhooks/...

Enable Debug Logging to Discord: Logs detailed information to a specified Discord webhook. Example: false (default value).

Block Damage on Raid Limit Reached: If enabled, blocks damage when the raid limit is exceeded. Example: false (default value).

Show Offline Raid Count (on modded servers): Displays the number of offline raids for players on modded servers. Example: false (default value).

Enable API Integration: Enables integration with an external API to send raid session data. Example: false (default value).

API Base URL: The base URL for the API where raid session data is pushed. Example: https://your-api.com/.

API Authentication Token: Token used for authentication with the external API. Example: your-api-token.

Reset Time (24-hour format): Time at which raid session data is reset (e.g., 00:00). Example: 00:00 (default value).

Additional Blocked Entities: A list of entity prefabs that are blocked from being damaged during offline raids. Example: ["door.hinged.metal", "autoturret_deployed", "barricade.wood"]

API Integration

When enabled, the plugin sends raid session data to the following endpoints:

1. Send Raid Session Data:

    Endpoint: /raid
    Method: POST
    Payload Example:
    {
        "RaidKey": "unique-session-key",
        "ServerID": "server-id",
        "ServerName": "server-name",
        "AttackerIDs": ["attacker-id1", "attacker-id2"],
        "OfflineRaidSessionLimit": 1
    }

2. Update Raid Session:

    Endpoint: /update-raid
    Method: PUT
    Payload Example:
    {
        "RaidKey": "unique-session-key",
        "AttackerIDs": ["attacker-id1", "attacker-id2"]
    }

3. Reset Server Data:

    Endpoint: /reset
    Method: POST
    Payload Example:
    {
        "ServerID": "server-id"
    }

4. Reset Raid Session Data:

    Endpoint: /reset-raid
    Method: POST
    Payload Example:
    {
        "RaidKey": "unique-session-key"
    }

Edge Case Handling

• Players Leaving Teams: The plugin ensures that players who leave teams and participate in raids are tracked correctly, maintaining raid session integrity.
• Offline Defenders: If all defenders are offline, the plugin considers this an offline raid, ensuring these types of raids are correctly logged.
• Damage Block on Raid Limit: If the raid limit is reached, damage is blocked to prevent players from continuing raids beyond the allowed limit.
• Cooldown Management: The plugin handles raid session cooldowns by cleaning up expired sessions at scheduled intervals, preventing excessive data accumulation.

Expected Behavior

Vanilla Servers: Logs and reports to Discord, focusing on alerting admins about offline raids. No in-game UI is shown.

Modded Servers: Provides in-game UI with raid details, allows blocking damage on raid limits, and has enhanced raid tracking with proximity logic.

API Push: Sends raid session data to an external API for tracking, including attacker details and server information.