RoodyDonations v1.0.0 is outSee what’s new →
RoodyRestore
v1.0.0 Paper 1.20.4+ Free
Guides · Files

config.yml

# ------------------------------------------------------------
#  RoodyRestore · config.yml
#  Texts: lang/<language>.yml · Menus: menus/<id>.yml · Discord: discord.yml
#  After a change: /rr reload (the storage section needs a restart)
# ------------------------------------------------------------

# Server language: en, es or any lang/<code>.yml of yours.
language: en
# Each player sees the file of their Minecraft language when there is one.
per-player-language: true
# More names for /roodyrestore. WorldEdit already has /restore, so it is not one of them.
command-aliases:
  - rr
  - rollback
  - invrestore

# The name of this server. With a shared MySQL every server needs a different one.
server-name: survival

# How dates are written (Java date pattern) and in which time zone ("" = the machine's).
date-format: "dd/MM/yyyy HH:mm:ss"
timezone: ""

# ------------------------------------------------------------ storage (needs a restart)
storage:
  # sqlite = one file in this folder, nothing to set up.
  # mysql (or mariadb) = needed to share backups between the servers of a network.
  type: sqlite
  table-prefix: roodyrestore_
  mysql:
    host: 127.0.0.1
    port: 3306
    database: roodyrestore
    user: root
    password: ""
    options: "useSSL=false&characterEncoding=utf8"

# ------------------------------------------------------------ what is saved and for how long
# One entry per kind of backup:
#   enabled   make this kind of backup
#   limit     how many to keep per player (the oldest go first), -1 = no limit
#   keep-days delete them after this many days, 0 = never
# Plugins using the API can add their own categories: put them here to change their limits.
categories:
  death: {enabled: true, limit: 50, keep-days: 60}
  combat-log: {enabled: true, limit: 20, keep-days: 30}
  join: {enabled: true, limit: 10, keep-days: 7}
  quit: {enabled: true, limit: 10, keep-days: 7}
  world-change: {enabled: true, limit: 10, keep-days: 7}
  gamemode-change: {enabled: true, limit: 10, keep-days: 7}
  ender-chest: {enabled: true, limit: 10, keep-days: 7}
  # uses a lot of space on busy servers
  container-close: {enabled: false, limit: 20, keep-days: 3}
  automatic: {enabled: true, limit: 24, keep-days: 3}
  command: {enabled: true, limit: 10, keep-days: 14}
  server-stop: {enabled: true, limit: 5, keep-days: 7}
  manual: {enabled: true, limit: -1, keep-days: 0}
  # made by the plugin right before each restore: restoring one of these is the "undo"
  pre-restore: {enabled: true, limit: 20, keep-days: 30}
  # copies changed in the edit menu
  edited: {enabled: true, limit: -1, keep-days: 0}

backups:
  # The most backups kept per player adding every category, -1 = no limit.
  total-limit: -1
  # Save the ender chest in every backup.
  ender-chest: true
  # Do not save a backup with nothing in it (manual ones are always saved).
  skip-empty: true
  # These categories are skipped when nothing changed since the player's last backup.
  skip-unchanged: [automatic, container-close, ender-chest]
  # No backups in these worlds.
  excluded-worlds: []
  # automatic: every how many minutes (spread out so that it does not hit one tick).
  automatic-minutes: 5
  # container-close and ender-chest: at most one backup per player in this time.
  container-cooldown-seconds: 30
  # command: back up the player before these commands run. The player named in the command
  # (/clear Steve) is backed up too.
  commands: [clear, ci, clearinventory, "minecraft:clear", "essentials:clear"]

# ------------------------------------------------------------ restoring
restore:
  # What is ticked when the restore menu opens:
  # inventory, armor (with the off hand), ender-chest, xp, health (with hunger), effects, location
  default-parts: [inventory, armor, ender-chest, xp]
  # replace = what they have now is replaced
  # merge = the items are added to what they have
  # missing = only the items they do not have now
  default-mode: replace
  # Make a backup of the player right before a restore (so it can be undone).
  backup-before: true
  # Tell the player that their inventory was restored.
  notify-player: true
  # A restore for someone who is offline waits this many ticks after they join.
  join-delay-ticks: 40
  # Sound for the player when it is applied ("" = none).
  sound: "entity.player.levelup 0.6 1.2"
  # The most backups shown in one list.
  list-limit: 500

# ------------------------------------------------------------ anti-dupe
anti-dupe:
  # What happens when a backup (or an item, or a part of it) was already given back:
  #   warn  = the staff has to confirm it (shift-click)
  #   block = it cannot be done again (roodyrestore.bypass can)
  #   off   = no checks
  mode: warn
  # When a death backup is restored, delete the items of that death that are still on the ground.
  remove-ground-drops: true
  ground-radius: 16

# ------------------------------------------------------------ requests
requests:
  enabled: true
  # Whoever asks has to say why.
  require-reason: true
  # Requests nobody answered are closed after this many hours.
  expire-hours: 48
  # Whether someone can accept their own request.
  self-approve: false

# ------------------------------------------------------------ self-service: /rr claim
# Players get back their own last death, once. It is off by default because of what can go
# wrong: if someone picked up the items before the claim, those items are duplicated. The
# safe default is to allow only deaths where the items are lost anyway (void, lava...).
self-service:
  enabled: false
  # How long after the death it can be claimed.
  max-age-minutes: 30
  # How many deaths the menu shows.
  listed: 3
  # Causes of death allowed (Bukkit DamageCause names), [] = all of them.
  causes: [VOID, LAVA, FIRE, FIRE_TICK, HOT_FLOOR, SUFFOCATION, WITHER, MELTING]
  # Never for a death caused by another player.
  exclude-pvp: true
  # Only in these worlds, [] = all of them.
  worlds: []
  # What it costs: Vault money and experience levels (0 = free).
  cost-money: 0
  cost-levels: 0
  # Time between claims, and the most claims in 24 hours (0 = no limit).
  cooldown-minutes: 60
  per-day: 3
  # merge keeps what they picked up since then; replace throws it away.
  mode: merge
  parts: [inventory, armor]

# ------------------------------------------------------------ alerts
alerts:
  # Someone died with valuable items (sum of the worth below).
  loss:
    enabled: true
    min-worth: 2000
    # Worth of one item of a material with no line below.
    default-worth: 0
    # Added per level of each enchantment.
    enchantment-worth: 5
    worth:
      NETHERITE_INGOT: 150
      NETHERITE_BLOCK: 1350
      NETHERITE_SWORD: 200
      NETHERITE_PICKAXE: 200
      NETHERITE_AXE: 200
      NETHERITE_SHOVEL: 180
      NETHERITE_HOE: 180
      NETHERITE_HELMET: 220
      NETHERITE_CHESTPLATE: 260
      NETHERITE_LEGGINGS: 240
      NETHERITE_BOOTS: 200
      DIAMOND: 10
      DIAMOND_BLOCK: 90
      EMERALD_BLOCK: 45
      GOLD_BLOCK: 27
      IRON_BLOCK: 9
      ELYTRA: 800
      TOTEM_OF_UNDYING: 150
      ENCHANTED_GOLDEN_APPLE: 200
      BEACON: 500
      NETHER_STAR: 400
      SHULKER_BOX: 20
      TRIDENT: 200
  # A death that looks like the server's fault.
  suspicious:
    enabled: true
    # Only when they lost at least this many items.
    min-items: 5
    # Causes that are often not the player's fault.
    causes: [VOID, SUFFOCATION, FALLING_BLOCK, CUSTOM]
    # Died this soon after joining (0 = do not check).
    after-join-seconds: 15
    # The server was lagging (0 = do not check).
    tps-below: 14
    # The player's connection was bad (0 = do not check).
    ping-above: 1000

# ------------------------------------------------------------ network (MySQL only)
network:
  # Every how many seconds this server looks for restores and requests from the others.
  poll-seconds: 3

# ------------------------------------------------------------ other Roody plugins
integrations:
  # RoodyStaff: do not back up a player in staff mode (they hold the staff tools then).
  skip-staff-mode: true
  # RoodyPvP: deaths for leaving in combat go to the combat-log category.
  combat-log-category: true

search:
  # /rr search stops after this many backups.
  max-results: 200

audit:
  # The record of who restored what is deleted after this many days (0 = kept forever).
  keep-days: 365

# Tell the console and admins (permission roodyrestore.update) when a new version is out
# on plugins.roody.es.
check-updates: true

# Every 30 minutes the plugin sends anonymous server statistics to plugins.roody.es:
# players online and maximum, Minecraft and Java version and the software (Paper,
# Purpur...). Nothing about your players. Set to false to turn them off.
metrics: true