Auto Purge for Rust

Automatically removes entities created by inactive users

Total Downloads: 4,487 - First Release: Dec 27, 2015 - Last Update: Sep 18, 2017

5/5, 33 likes
  1. Fujikura
    << This was initially created by @Norn >>

    AutoPurge removes ALL entities created by inactive players after a given timelimit being offline.

    Clan support is included to protect group-buildings from being affected by purge of inactive clanmembers.

    If a player would become purged, and he's member of a clan, it checks if's there any other clanmember not inactive ( means: not longer offline then the given limit), and excludes those entities on the purge job.

    Friends API support is included to protect group-buildings from being affected by purge of inactive friends.
    If a player would become purged, it checks if he's got any 'active' friend not inactive ( means: not longer offline then the given limit), and excludes those entities on the purge job.
    Active friends means, they must be both set to be friends.

    What will be removed:
    This includes ALL deployables, like furnaces, boxes, etc...
    This includes ALL Buildingsblocks built by a player.
    This will NOT remove an entire Base if the base was built by more then one player
    This removes the sleeper ( if set to active by config )

    Safety First:
    The plugin has an optional TestMode (default disabled) which gives you the possibility to proof your settings. This will act like normal, but nothing will be purged an no sleepers will be killed

    Console Commands (Authlevel 2):
    • autopurge.run > Bypass (enabled) timer and call hook directly
    • autopurge.remove > remove all entities for a given steam id
    Configuration description:

    Exclution
    • excludeGroupModerator: true > excludes servergroup owners from purge
    • excludeGroupOwner: true > excludes servergroup moderators from purge
    • excludePermission: "autopurge.exclude" > to exclude other special players/groups
    Generic
    • killSleepers: false > kill also sleepers when player entities were purged
    • logPurgeToFile: false > set to true will log each activity to an extra logfile
    • purgeOnStart: false > set to true would purge directly on every serverstart
    • removeRecordAfterDays: 30 > remove old data entries older then x days when plugin was loaded
    • removeRecordAfterPurge: true > removes data entry when a players entities were purged
    • testMode: false > lets you see if your settings are correct but does not remove any entities/sleepers
    • useClansIO: true > will use ClansIO if installed and set to true
    • useFriendsApi: false > will use Friends API if installed and set to true
    Messaging
    • showMessages: true > will announce a started purge job (either timed or manually)
    • showMessagesAdminOnly: false > can switch over to show this info only to online admins
    Timing
    • inactiveAfter: 172800 > default inactive time in seconds for being purged (2 days)
    • timerEnabled: true > lets it run automatically defined by timerJob
    • timerJob: 21600 > runs the purge job every x seconds after plugin was loaded (6 hours) > -1 will not disable the timer, set 'timerEnabled' to false
    Default Configuration:
    Code (C#):

    {
      "Exclution": {
        "excludeGroupModerator": true,
        "excludeGroupOwner": true,
        "excludePermission": "autopurge.exclude"
      },
      "Generic": {
        "killSleepers": false,
        "logPurgeToFile": true,
        "purgeOnStart": false,
        "removeRecordAfterDays": 30,
        "removeRecordAfterPurge": true,
        "testMode": false,
        "useClansIO": true,
        "useFriendsApi": false
      },
      "Messaging": {
        "showMessages": true,
        "showMessagesAdminOnly": false
      },
      "Timing": {
        "inactiveAfter": 172800,
        "timerEnabled": true,
        "timerJob": 21600
      }
    }
     
    Default language file:
    Code (Text):
    {
      "RunBefore": "<color=yellow>INFO:</color> Beginning <color=red>purge</color>. (<color=yellow>Slight lag may occur, please do not spam the chat.</color>)",
      "RunComplete": "Purge <color=green>complete</color> (<color=yellow>{0}</color> entities removed from <color=yellow>{1}</color> inactive players)."
    }
    How-To get support:
    You will NOT get support on questions/requests like:
    • "it does'nt work"
    • "help me"
    • and similar content which intends you did'nt read the description
    You WILL get support if you provide a minimum of:
    • which version is running (eg. latest, 1.x.x, ...)
    • What you've done (short description: installed, deleted config, changed config/data, etc)
    • If you've errors you provided also the error
    • a part/topic which is not precise or unprecise described in the description