EntityGuard

Original price was: $10.00.Current price is: $5.00.-50%

Sold by: Willem026

EntityGuard is a powerful, feature-rich Rust plugin that helps server administrators maintain a clean and optimized gaming environment by automating the management and cleanup of deployable entities.

Categories: , ,

Description

EntityGuard
Author: Willem026
Version: 1.2.6
Support: https://discord.gg/jqbqMt2z
Description

EntityGuard is a powerful, feature-rich Rust plugin designed to help server administrators maintain a clean and optimized gaming environment by automating the management and cleanup of deployable entities. With flexibility and performance at its core, *EntityGuard* offers advanced configuration options that allow you to have detailed control over which entities are managed, how they are evaluated, and under what conditions they are removed. By providing customizable scanning intervals, privilege zone checks, and health thresholds, *EntityGuard* ensures that only unwanted or misplaced entities are targeted, preserving essential gameplay elements and player-owned assets.

Whether you require regular global scans to keep your server running smoothly or prefer manual control over entity cleanup, EntityGuard provides the tools to adapt to your server’s unique needs. This plugin is perfect for busy servers where entity clutter can impact performance, as well as smaller communities seeking automated maintenance that respects players’ hard-earned structures. The inclusion of whitelist support and detailed debugging logs makes *EntityGuard* a robust and transparent solution for server maintenance.

Why Choose EntityGuard?

*EntityGuard* is more than just an entity cleanup tool—it’s your server’s safety net. Say goodbye to manual and tedious entity checks and embrace automated, intelligent management that works in the background, ensuring your server stays organized and optimized. Here’s why server owners love *EntityGuard*:

Complete Control: Tailor every aspect of entity management, from health thresholds and privilege zone authorizations to the frequency of global scans.
Peace of Mind: Rest assured that player-owned structures are safe with whitelist capabilities and authorization checks that respect Tool Cupboard (TC) zones.
Performance Booster: Maintain peak server performance by regularly clearing unwanted entities and reducing clutter.
Transparency and Debugging: Enable detailed logs to monitor every action the plugin takes, making troubleshooting a breeze.
Easy to Use: Simple configuration and clear commands make setup and maintenance straightforward, even for those new to server management.

*EntityGuard* is designed for server owners who want the perfect balance of automation and control. Make your Rust server efficient, fair, and enjoyable for all players with *EntityGuard*.

#### Features

Automated Cleanup: Automatically removes deployable entities based on health thresholds and location.
Whitelist Support: Exempt specific entities from cleanup to prevent accidental removal.
Global Scanning: Perform comprehensive scans of all deployable entities placed by players.
Privilege Zones: Respect Tool Cupboard (TC) zones, ensuring entities within authorized areas are managed appropriately.
Configurable Settings: Tailor behavior through extensive configuration options.
Debug Logging: Enable detailed logs to monitor plugin operations and troubleshoot issues.

#### Configuration (`config.json`)

Customize EntityGuard to fit your server’s needs by adjusting the following settings:

{
  "General": {
    "CheckInterval": 10,
    "MaxCheck": 5,
    "EnableDebug": true,
    "DefaultScan": false
  },
  "Cleanup": {
    "ManageBuildings": true,
    "ManageDeployables": true,
    "RemoveEntitiesOutside": true,
    "RemoveEntitiesInside": true
  },
  "GlobalScan": {
    "Enabled": false,
    "ScanInterval": 60,
    "NotifyOnComplete": true
  },
  "Health": {
    "HealthThresholdOutside": 0.2,
    "HealthThresholdInside": 0.0
  },
  "Privilege": {
    "VerifyOwnerAuthorization": false,
    "Range": 20.0
  },
  "Whitelist": [
    "box.wooden.large",
    "mailbox.deployed"
  ],
  "Deployables": [
    "lantern.deployed",
    "smokegrenade.deployed",
    "foundation.deployed",
    "wall.deployed",
    "floor.deployed",
    "stairs.deployed",
    "roof.deployed"
  ]
}

Key Settings Explained:

General:

  - CheckInterval: Time between each entity evaluation.
  - MaxCheck: Number of evaluations before an entity is removed.
  - EnableDebug: Toggle detailed logging for troubleshooting.
  - DefaultScan: Enable or disable scanning of entities as they are placed by players.

Cleanup:

  - ManageBuildings & ManageDeployables: Enable or disable management of specific entity types.
  - RemoveEntitiesOutside & RemoveEntitiesInside: Control removal behavior based on entity location relative to TC zones.

GlobalScan:

  - Enabled: Activate or deactivate periodic global scans.
      - When Enabled is true:
        - The plugin performs scheduled scans across all deployable entities placed by players at intervals defined by ScanInterval.
        - These scans evaluate entities based on current settings (health thresholds, privilege zones, etc.) and remove or monitor them accordingly.
        - Ideal for maintaining overall server cleanliness and performance by routinely checking for unwanted entities.

      - When Enabled is false:
        - The plugin does not perform automated periodic scans.
        - Instead, it scans entities directly when placed by a player.
        - Useful for reducing server load or when you prefer more controlled cleanup operations.

    - ScanInterval: Frequency of global scans in seconds.
    - NotifyOnComplete: Receive notifications upon scan completion.

Health:

  - HealthThresholdOutside: Minimum health required for entities outside TC zones to avoid removal.
  - HealthThresholdInside: Minimum health required for entities inside TC zones to avoid removal.
    - Set to 0 to disable.

Privilege:

  - VerifyOwnerAuthorization:
      - When true:
        - Only entities within TC zones that are not owned by authorized TC owners are removed.
        - Ensures that player-owned structures within their own zones are preserved.

      - When false:
        - All entities within TC zones are subject to removal, regardless of ownership or authorization.
        - This setting allows for broader cleanup but may remove player-owned structures unintentionally.

    - Range: The radius in meters for the plugin to detect TCs.
      - Example: "Range": 25.0 - checks in a radius of 25m if there's a TC nearby the entity.

  - Whitelist: List of entity prefab names exempt from removal.

  - Deployables: Define which deployable entities are managed by the GlobalScan function.
    - This is where you put the entities that need to be scanned and removed when the GlobalScan function is enabled.
    - If you leave this blank, no entities will be scanned!

#### Commands

- /entityguard scan
    - Description: Initiates an immediate global entity scan.
    - Usage: /entityguard scan

- /entityguard reload
    - Description: Reloads the plugin configuration without restarting the server.
    - Usage: /entityguard reload

Permissions:

- entityguard.use
    - Description: Grants access to EntityGuard commands.
    - Usage: Assign to trusted roles or administrators.

#### Usage Examples

1. Initiate a Global Scan:
     - Command: /entityguard scan
     - Effect: Scans all deployable entities placed by players and evaluates them based on current settings.

2. Reload Configuration:
     - Command: /entityguard reload
     - Effect: Applies any changes made to config.json without needing a server restart.

#### GlobalScan Settings Explained

GlobalScan Enabled (`”Enabled”: true`):

- Automated Scanning: The plugin performs automatic, periodic scans of all deployable entities placed by players.
- Scheduled Intervals: Scans occur at intervals specified by ScanInterval, ensuring regular maintenance without manual intervention.
- Comprehensive Evaluation: During each scan, entities are evaluated based on health thresholds, whitelist exemptions, and their presence within privilege zones.
- Enhanced Server Performance: Regular scans help maintain server performance by preventing entity clutter and managing resource usage effectively.
- Notifications: If `NotifyOnComplete` is set to true, the plugin will notify administrators upon the completion of each global scan.

GlobalScan Disabled (`”Enabled”: false`):

- Manual Control: Without automated scans, entity evaluation and cleanup occur only through specific events (e.g., entity placement) or manual commands.
- Direct Scanning: Instead, it scans entities directly when placed by a player.
- Reduced Server Load: Disabling global scans can help reduce server overhead, especially on larger servers with numerous entities.
- Targeted Cleanup: Administrators can initiate scans manually using the /entityguard scan command, allowing for controlled and timely maintenance as needed.
- Event-Driven Management: Entities are still managed based on their interactions (e.g., when they are built), ensuring ongoing maintenance without the need for periodic scans.

Choosing Between Enabled and Disabled:

- Enable GlobalScan (`true`): Best for servers that require consistent and automated maintenance of deployable entities, ensuring optimal performance and organization without manual oversight.
- Disable GlobalScan (`false`): Ideal for servers that prefer more manual control over entity cleanup, reducing automated processes and server load, while still maintaining essential cleanup functionalities through events and commands.

#### Installation

1. Download Plugin:
     - Obtain the latest version of EntityGuard from Codefling.

2. Upload to Server:
     - Place the `EntityGuard.cs` file into your server’s `oxide/plugins` directory.

3. Configure:
     - Restart the server or load the plugin using the appropriate Oxide command.
     - Modify `config.json` as needed to fit your server’s requirements.

4. Assign Permissions:
     - Use Oxide’s permission system to grant `entityguard.use` to desired user groups.

#### Support & Feedback

For support, feature requests, or to report bugs, contact Willem026

Reviews

There are no reviews yet.


Only logged in customers who have purchased this product may leave a review.

Version 1.2.6 | Updated December 4, 2024
  • Added Initial release

Discussions

There are no discussions yet.

Leave a reply

Your email address will not be published. Required fields are marked *

Plugin FAQ – How do I use this .zip/.7z file I just purchased on my server?

• First, you want to unzip the file. You can do so by just double-clicking it to open, then drag the contents to the desired location (you may need to install an external unzipping software if you don’t already have one such as 7zip or winrar)
• Next you will find either a structure of folders or just the .cs file itself (it’s the actual plugin file itself).
• After that just install the .cs (plugin file) into your …/oxide/plugins/ folder where you will install plugins you ever need to.

Additionally, here’s a great video that easily covers adding a plugin to your server if you need! https://youtu.be/yWC_p97FhQA

• Installation is not included with any products on the site, however, if needed we may assist if you reach out to our support.

Currently all products on Lone.Design will be contained within a zipped file which is the .7z or .zip that you see. I believe windows 10 and up can unzip on its own without 3rd party tools, but in that case, if you’re unfamiliar with zipped files here are 2 programs I recommend to easily unzip zipped files.

Video On How to Zip and Unzip: https://youtu.be/Ep-L3PjBPCk (TechInsider Youtube Channel)

Zipping/Unzipping Tools
Winrar https://www.rarlab.com (I used to use for years, but works great!)
7zip https://www.7-zip.org/a/7z2107-x64.exe (the one I use currently)

Product Enquiry

Please Login to make enquiry about this product