Clean - momoservertw/PlayerdataPlus GitHub Wiki

Clean the old data and improve the server's performance.

Bypass permission:

  • playerdataplus.bypass.clean.*
  • playerdataplus.bypass.clean.TYPE
  • playerdataplus.bypass.clean.playerdata
  • ...

Index:

Settings

Config-Version: 3
Debugging: false
Check-Updates: true

Settings:
  Offline-Player:
    Priority-Order:
      - LuckPerms
      - CMI
      - Playerdata
  Expiry-Days: 60
  Log: true
  Max-Clean-Per-Data: 10000
  Timeout-Warning: true
  Auto-Clean:
    Enable: false
  Backup:
    Enable: true
    Mode: 'plugin'
    Folder-Name: 'Backup'
    Custom-Path: 'C:\Backup'
    To-Zip: true
  • Offline-Player
    • Priority-Order - The sequence of getting offline player data.
  • Config-Version - The version of this configuration. It will automatically generate a new one if this config is out date.
  • Debugging - If you want to see if the player data is out of date or bypassed, you can turn on the Debug mode.
  • Check-Updates - Check the plugin updates when server starting and an operator joined the game.
  • Expiry-Days - The expiration days of the data.
  • Log - Create a detail log file in plugin folder.
  • Max-Clean-Per-Data - It will clean up a limited amount of data once and then restart the clean process again. Set "0" to disable this feature.
  • Timeout-Warning - If your "timeout-time" setting in spigot.yml is too low, it may cause the server to restart in the middle of cleaning. Please set a higher number of seconds based on the number of server players, especially for the first time.
  • Auto-Clean
    • Enable - Automatic clean the old data when the server is starting.
  • Backup
    • Enable - Backup the data in plugin folder, it only support some data types.
    • Mode - The backup folder, support: plugin, custom
    • Folder-Name - The name of the backup folder.
    • Custom-Path - Custom the backup path like "C:\Server". You need to set the Backup Mode to "custom".
    • To-Zip - Compress the backup folder to zip.

Server

1. Logs

Logs:
 Enable: false
 Expiry-Days: 90
 Backup: true
  • Enable - The default is true.
  • Expiry-Day - You can specific the expiry day for each data.
  • Backup - You can disable the backup feature for each data. The default is true.

2. Playerdata

Playerdata:
  Enable: false

3. Regions

Regions:
  Enable: false
  Residence-Bypass: true
  Worlds:
    - world
    - world_nether
    - world_the_end
  Ignore-Regions: []
  #  - 'world 8.8'
  • Residence-Bypass - Bypass clean the regions which contain Residences. If you disable this option, you can still add the custom flag "bypassclean" to the residences to bypass the clean event.
  • Regenerate - Regenerate the delete regions. (Coming soon...)
  • Worlds - The checking world list.
  • Ignore-Regions - The ignore regions.

Plugins

1. AuthMe

Need: AuthMe Purge the player accounts.

AuthMe:
  Enable: false

2. CMI

Need: CMI
Purge the player data.

CMI:
  Enable: false

3. DiscordSRV

Need: DiscordSRV
Unlink the discord accounts.

DiscordSRV:
  Enable: false

4. MySQLPlayerDataBridge (Coming-soon...)

Need: MySQLPlayerDataBridge
Purge the player data between servers.

MySQLPlayerDataBridge:
  Enable: false

5. MyCommand (Coming-soon...)

Need: MyCommand
Purge the player data and useless variables from player data.

MyCommand:
  Enable: false
  Variables:
    - a
    - b
    - c
  • Variables - The variables from MyCommand's player data.

6. SkinsRestorer (Coming-soon...)

Need: SkinsRestorer
Purge the player skins cache.

SkinsRestorer:
  Enable: false

7. ChatControlPro (Coming-soon...)

Need: ChatControlPro
Purge the player settings like "ignore list" or warning points for violating rules/actions.

ChatControlPro:
  Enable: false

8. LuckPerms (Coming-soon...)

Need: LuckPerms
Purge the player permissions and groups.

LuckPerms:
  Enable: false

9. MyPet (Coming-soon...)

Need: MyPet
Purge the player's pet data.

MyPet:
  Enable: false

Custom (Coming-soon...)

  • Expiry-Type
    • modify - The target's last modified date.
    • login - The target player's last login date. It only support when target is "player", "uuid", "authme", "file-player", and "file-uuid". If you have AuthMe, it will check the AuthMe's last login time.
  • Target
    • player - Check all player names in the server.
    • uuid - Check all player UUIDs in the server.
    • authme - Check all players in the Authme database.
    • file - The files in the path.
    • file-player - The files of players in the path. And you can check their last login time or the bypass permission.
    • file-uuid - The files of player's UUIDs in the path. And you can check their last login time or the bypass permission.
  • Paths - The target's source paths. If the path contains placeholder "%player%"and "%uuid%", it will
  • File-formats - The target's file format. It will ignore other file formats.
  • Commands - Execute some commands. You can use it to purge the data.

1. Log-Example

Log-Example:
  Enable: false
  Target: file
  Expiry-Type: modify
  Paths:
    - "log"
  File-formats:
    - "log"
    - "gz"

2. Playerdata-Example

Playerdata-Example:
  Target: file-uuid
  Expiry-Type: modify
  Paths:
    - "world\playerdata"
    - "world_nether\playerdata"
    - "world_the_end\playerdata"
  File-formats:
    - "dat"

3. Player-Example

Player-Example:
  Enable: false
  Check-Target: uuid
  Expiry-Type: login
  Commands:
    - "customplugin removeuser %player%"