settings.yml

About

This is the main settings file for PlotSquared.

Located in: /plugins/PlotSquared/config/settings.yml

Example

# The first value is not configurable. It shows the platform you are using.
platform: "Bukkit"
# Show additional information in console. It helps us at IntellectualSites to find out more about an issue.
# Leave it off if you don't need it, it can spam your console.
debug: false
# The big text that appears when you enter a plot.
# For a single plot set `/plot flag set titles false` to disable it.
# For just you run `/plot toggle titles` to disable it.
# For all plots: Add `titles: false` in the worlds.yml flags block to disable it.
titles: true

# Enable or disable parts of the plugin
# Note: A cache will use some memory if enabled
enabled-components:
  # The database stores all the plots
  database: true
  # Events are needed to track a lot of things
  events: true
  # Commands are used to interact with the plugin
  commands: true
  # Whether we should notify you about updates or not.
  update-notifications: true
  # Stores user metadata in a database
  persistent-meta: true
  # Optimizes permission checks
  permission-cache: true
  # Optimizes block changing code
  block-cache: true
  # Getting a rating won't need the database
  rating-cache: true
  # Allow WorldEdit to be restricted to plots
  worldedit-restrictions: true
  # Allow economy to be used to sell, claim or buy plots.
  economy: true
  # Expiry will clear old or simplistic plots
  plot-expiry: false
  # Processes chunks (trimming, or entity/tile limits) 
  chunk-processor: false
  # Kill mobs on roads (Chicken, Cow, etc.)
  kill-road-mobs: false
  # Kill items on roads (Stick, Paper, etc.)
  kill-road-items: false
  # Kill vehicles on roads (Boat, Minecart, etc.)
  kill-road-vehicles: false
  # Notify a player of any missed plot comments upon plot entry
  comment-notifier: false
  # Let players claim entire worlds with PlotSquared
  worlds: false
  # Actively purge invalid database entries
  database-purger: false
  # Delete plots when a player is banned.
  # Note: This only works with the /minecraft:ban command.
  ban-deleter: false
  # Allows PlaceholderAPI placeholders to be used in captions, flags, etc.
  external-placeholders: true
  # Make road regeneration persistent across restarts
  persistent-road-regen: false
  # Enable the `/plot component` preset GUI
  component-presets: true
  # Use UUID cache to complete usernames
  extended-username-completion: true

# Settings relating to PlotSquared's GlobalBlockQueue
queue:
  # Average time per tick spent completing chunk tasks in ms.
  # Waits (chunk task time / target_time) ticks before completely the next task.
  target-time: 65

# Enable or disable parts of the plugin specific to using Paper
paper-components:
  # Enable Paper's listeners.
  paper-listeners: true
  # Prevent entities from leaving plots
  entity-pathing: true
  # Cancel entity spawns when the chunk is loaded if the PlotArea's mob spawning is off
  cancel-chunk-spawn: true
  # Use paper's PlayerLaunchProjectileEvent to cancel projectiles
  player-projectile: true
  # Cancel entity spawns from spawners before they happen (performance buff)
  spawner-spawn: true
  # Cancel entity spawns from tick spawn rates before they happen (performance buff)
  creature-spawn: true
  # Check the tile entity limit on block placement
  tile-entity-check: true
  # Use Paper's async tab completion
  async-tab-completion: false

ratings:
  # Replace the rating system with a like system. Will add /plot like/dislike, and remove the rating command
  use-likes: false
  # Rating categories
  categories: []

claim:
  # The max plots claimed in a single `/plot auto <size>` command
  max-auto-area: 4

redstone:
  # Disable redstone in unoccupied plots
  disable-unoccupied: false
  # Disable redstone when all owners/trusted/members are offline
  disable-offline: false
  # Detect and cancel invalid pistons on the edge of plots (e.g. placed with WorldEdit)
  detect-invalid-edge-pistons: false

teleport:
  # Teleport to your plot on death
  on-death: false
  # Teleport to your plot on login
  on-login: false
  # Teleport to your plot on claim
  on-claim: true
  # Add a delay to all teleport commands
  # Assign `plots.teleport.delay.bypass` to bypass the cooldown.
  delay: 0
  # The visit command is ordered by world instead of globally
  per-world-visit: false

confirmation:
  # Timeout before a confirmation prompt expires
  confirmation-timeout-seconds: 20

# Backup related settings
backup:
  # Automatically backup plots when destructive commands are performed, e.g. /plot clear
  automatic-backups: true
  # Maximum amount of backups associated with a plot
  backup-limit: 3
  # Whether or not backups should be deleted when the plot is unclaimed
  delete-on-unclaim: true

# Relating to how many plots someone can claim  
limit:
  # Should the limit be global (over multiple worlds)
  global: false
  # The max. range of permissions to check e.g. plots.plot.127
  # The value covers the range to check only, you need to assign the permission to players/groups still
  # Modifying the value does NOT change the amount of plots players can claim
  max-plots: 127

chat:
  # Sometimes console color doesn't work, you can disable it here
  console-color: true
  # Should the chat be interactive?
  interactive: true

done:
  # Require a plot marked as done to download (/plot download)
  required-for-download: false
  # Only plots marked as done can be rated
  required-for-ratings: false
  # Restrict building when a plot is marked as done
  restrict-building: false
  # The limit being how many plots a player can claim
  counts-towards-limit: true

web:
  # The web interface for schematics
  #  - All schematics are anonymous and private
  #  - Downloads can be deleted by the user
  #  - Supports plot uploads, downloads and saves
  url: "https://schem.intellectualsites.com/plots/"
  # The web interface for assets
  #  - All schematics are organized and public
  #  - Assets can be searched, selected and downloaded
  assets: "https://empcraft.com/assetpack/"

# Configure the paths that will be used
paths:
  schematics: "schematics"
  scripts: "scripts"
  templates: "templates"
  translations: "translations"

# Schematic Settings
schematics:
  # Whether schematic based generation should paste schematic on top of plots, or from Y=1
  paste-on-top: true

# Update checker settings
updatechecker:
  # How often to poll for updates (in minutes)
  poll-rate: 360
  # Only notify console once after an update is found
  notify-once: true

# General settings
general:
  # Display scientific numbers (4.2E8)
  scientific: false
  # Replace wall when merging
  merge-replace-wall: true
  # Blocks that may not be used in plot components
  # When modifying, please make sure you are using valid material names: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html
  invalid-blocks: 
  - "acacia_button"
  - "acacia_fence_gate"
  - "acacia_door"
  - "acacia_pressure_plate"
  - "acaia_trapdoor"
  - "acacia_sapling"
  - "acacia_sign"
  - "acacia_wall_sign"
  - "acacia_leaves"
  - "birch_button"
  - "birch_fence_gate"
  - "birch_door"
  - "birch_pressure_plate"
  - "birch_trapdoor"
  - "birch_sapling"
  - "birch_sign"
  - "birch_wall_sign"
  - "birch_leaves"
  - "dark_oak_button"
  - "dark_oak_fence_gate"
  - "dark_oak_door"
  - "dark_oak_pressure_plate"
  - "dark_oak_trapdoor"
  - "dark_oak_sapling"
  - "dark_oak_sign"
  - "dark_oak_wall_sign"
  - "dark_oak_leaves"
  - "jungle_button"
  - "jungle_fence_gate"
  - "jungle_door"
  - "jungle_pressure_plate"
  - "jungle_trapdoor"
  - "jungle_sapling"
  - "jungle_sign"
  - "jungle_wall_sign"
  - "jungle_leaves"
  - "oak_button"
  - "oak_fence_gate"
  - "oak_door"
  - "oak_pressure_plate"
  - "oak_trapdoor"
  - "oak_sapling"
  - "oak_sign"
  - "oak_wall_sign"
  - "oak_leaves"
  - "spruce_button"
  - "spruce_fence_gate"
  - "spruce_door"
  - "spruce_pressure_plate"
  - "spruce_trapdoor"
  - "spruce_sapling"
  - "spruce_sign"
  - "spruce_wall_sign"
  - "spruce_leaves"
  - "activator_rail"
  - "detector_rail"
  - "rail"
  - "allium"
  - "azure_bluet"
  - "blue_orchid"
  - "dandelion"
  - "lilac"
  - "orange_tulip"
  - "oxeye_daisy"
  - "peony"
  - "pink_tulip"
  - "poppy"
  - "potted_allium"
  - "potted_azure_bluet"
  - "potted_birch_sapling"
  - "potted_blue_orchid"
  - "potted_brown_mushroom"
  - "potted_cactus"
  - "potted_fern"
  - "potted_jungle_sapling"
  - "potted_oak_sapling"
  - "potted_orange_tulip"
  - "potted_oxeye_daisy"
  - "potted_pink_tulip"
  - "potted_red_mushroom"
  - "potted_red_tulip"
  - "red_mushroom"
  - "red_tulip"
  - "potted_spruce_sapling"
  - "potted_white_tulip"
  - "rose_bush"
  - "sunflower"
  - "white_tulip"
  - "cornflower"
  - "wither_rose"
  - "attached_melon_stem"
  - "attached_pumpkin_stem"
  - "melon_stem"
  - "pumpkin_stem"
  - "mushroom_stem"
  - "beetroots"
  - "brown_mushroom"
  - "cactus"
  - "carrots"
  - "chorus_flower"
  - "chorus_plant"
  - "cocoa"
  - "dead_bush"
  - "fern"
  - "kelp_plant"
  - "large_fern"
  - "lily_pad"
  - "potatoes"
  - "sea_pickle"
  - "seagrass"
  - "sugar_cane"
  - "tall_grass"
  - "tall_seagrass"
  - "vine"
  - "wheat"
  - "bamboo"
  - "anvil"
  - "barrier"
  - "beacon"
  - "brewing_stand"
  - "bubble_column"
  - "cake"
  - "cobweb"
  - "comparator"
  - "creeper_head"
  - "creeper_wall_header"
  - "damaged_anvil"
  - "daylight_detector"
  - "dragon_egg"
  - "dragon_head"
  - "dragon_wall_head"
  - "enchanting_table"
  - "end_gateway"
  - "end_portal"
  - "end_rod"
  - "ender_chest"
  - "chest"
  - "flower_pot"
  - "grass"
  - "heavy_weighted_pressure_plate"
  - "lever"
  - "light_weighted_pressure_plate"
  - "player_head"
  - "redstone_wire"
  - "repeater"
  - "comparator"
  - "redstone_torch"
  - "torch"
  - "redstone_wall_torch"
  - "wall_torch"
  - "sign"
  - "skeleton_skull"
  - "skeleton_wall_skull"
  - "snow"
  - "stone_pressure_plate"
  - "trapped_chest"
  - "tripwire"
  - "tripwire_hook"
  - "turtle_egg"
  - "wall_sign"
  - "zombie_head"
  - "zombie_wall_head"
  - "bell"
  - "black_bed"
  - "black_banner"
  - "black_carpet"
  - "black_concrete_powder"
  - "black_wall_banner"
  - "blue_bed"
  - "blue_banner"
  - "blue_carpet"
  - "blue_concrete_powder"
  - "blue_wall_banner"
  - "brown_bed"
  - "brown_banner"
  - "brown_carpet"
  - "brown_concrete_powder"
  - "brown_wall_banner"
  - "cyan_bed"
  - "cyan_banner"
  - "cyan_concrete_powder"
  - "cyan_carpet"
  - "cyan_wall_banner"
  - "gray_bed"
  - "gray_banner"
  - "gray_concrete_powder"
  - "gray_carpet"
  - "gray_wall_banner"
  - "green_bed"
  - "green_banner"
  - "green_concrete_powder"
  - "green_carpet"
  - "green_wall_banner"
  - "light_blue_bed"
  - "light_blue_banner"
  - "light_blue_concrete_powder"
  - "light_blue_carpet"
  - "light_blue_wall_banner"
  - "light_gray_bed"
  - "light_gray_banner"
  - "light_gray_concrete_powder"
  - "light_gray_carpet"
  - "light_gray_wall_banner"
  - "lime_bed"
  - "lime_banner"
  - "lime_concrete_powder"
  - "lime_carpet"
  - "lime_wall_banner"
  - "magenta_bed"
  - "magenta_banner"
  - "magenta_concrete_powder"
  - "magenta_carpet"
  - "magenta_wall_banner"
  - "orange_bed"
  - "orange_banner"
  - "orange_concrete_powder"
  - "orange_carpet"
  - "orange_wall_banner"
  - "pink_bed"
  - "pink_banner"
  - "pink_concrete_powder"
  - "pink_carpet"
  - "pink_wall_banner"
  - "purple_bed"
  - "purple_banner"
  - "purple_concrete_powder"
  - "purple_carpet"
  - "purple_wall_banner"
  - "red_bed"
  - "red_banner"
  - "red_concrete_powder"
  - "red_carpet"
  - "red_wall_banner"
  - "white_bed"
  - "white_banner"
  - "white_concrete_powder"
  - "white_carpet"
  - "white_wall_banner"
  - "yellow_bed"
  - "yellow_banner"
  - "yellow_concrete_powder"
  - "yellow_carpet"
  - "yellow_wall_banner"
  - "brain_coral"
  - "brain_coral_fan"
  - "brain_coral_wall_fan"
  - "bubble_coral"
  - "bubble_coral_block"
  - "bubble_coral_fan"
  - "bubble_coral_wall_fan"
  - "dead_brain_coral"
  - "dead_brain_coral_block"
  - "dead_brain_coral_fan"
  - "dead_brain_coral_wall_fan"
  - "dead_bubble_coral"
  - "dead_bubble_coral_fan"
  - "dead_bubble_coral_wall_fan"
  - "dead_fire_coral"
  - "dead_fire_coral_block"
  - "dead_fire_coral_fan"
  - "dead_fire_coral_wall_fan"
  - "dead_horn_coral"
  - "dead_horn_coral_block"
  - "dead_horn_coral_fan"
  - "dead_tube_coral"
  - "dead_tube_coral_wall_fan"
  - "dried_kelp_block"
  - "horn_coral"
  - "horn_coral_block"
  - "horn_coral_fan"
  - "horn_coral_wall_fan"
  - "tube_coral"
  - "tube_coral_block"
  - "tube_coral_fan"
  - "tube_coral_wall_fan"

# UUID settings.
# DO NOT EDIT them if you don't know what you are doing.
uuid:
  # Force using offline UUIDs (it usually detects the right mode)
  offline: false
  # Force using lowercase UUIDs
  force-lowercase: false
  # Use a database to store UUID/name info
  use-sqluuidhandler: false
  # How many UUIDs that may be stored in the cache
  uuid-cache-size: 100000
  # Rate limit (per 10 minutes) for background UUID fetching from the Mojang API
  background-limit: 200
  # Rate limit (per 10 minutes) for random UUID fetching from the Mojang API
  impromptu-limit: 300
  # Timeout (in milliseconds) for non-blocking UUID requests (mostly commands)
  non-blocking-timeout: 3000
  # Timeout (in milliseconds) for blocking UUID requests (events)
  blocking-timeout: 10
  # Whether or not PlotSquared should read from the legacy database
  legacy-database-support: true
  # Whether or not PlotSquared should return Unknown if it fails to fulfill a request
  unknown-as-default: true

chunk-processor:
  # Auto trim will not save chunks which aren't claimed
  auto-trim: false
  # Max tile entities per chunk
  max-tiles: 4096
  # Max entities per chunk
  max-entities: 512
  # Disable block physics
  disable-physics: false

# This is an auto clearing task called `task1`
auto-clear:
  task1:
    threshold: -1
    required-plots: -1
    confirmation: true
    days: 90
    skip-account-age-days: -1
    worlds: 
    - "*"
    # See: https://github.com/IntellectualSites/PlotSquared-Documentation/wiki/Plot-analysis for a description of each value.
    calibration:
      variety: 0
      variety-sd: 0
      changes: 0
      changes-sd: 1
      faces: 0
      faces-sd: 0
      data-sd: 0
      air: 0
      air-sd: 0
      data: 0