Configuration

Complete guide to configuring config.yml and all plugin settings.

Main Configuration (config.yml)

General Settings

license-key: "CODE"
date-format: "dd.MM.yyyy HH:mm:ss"
maximum-name-length: 20
blocked-plot-names:
  - "admin"
  - "moderator"
from-spawn-distance: 100
minimum-distance-between-plots: 122
flying-on-plots: false
flying-only-on-own-or-member-plots: true
member-invite-time-out: 5
teleport-time: 5
debug-mode: false
guest-protection: true
plots-overlapping-with-same-owner: false
OptionTypeDefaultDescription
license-keyString"CODE"Plugin license key
date-formatString"dd.MM.yyyy HH:mm:ss"Date format used throughout the plugin
maximum-name-lengthInteger20Maximum allowed plot name length
blocked-plot-namesList["admin", "moderator"]Names that cannot be used for plots
from-spawn-distanceInteger100Minimum distance from world spawn to create a plot
minimum-distance-between-plotsInteger122Minimum distance between plot centers
flying-on-plotsBooleanfalseAllow flight on plot territories
flying-only-on-own-or-member-plotsBooleantrueRestrict flying to own or member plots only
member-invite-time-outInteger5Invitation expiration time in minutes
teleport-timeInteger5Teleport warmup time in seconds
debug-modeBooleanfalseEnable debug logging
guest-protectionBooleantrueProtect guests from damage on plots
plots-overlapping-with-same-ownerBooleanfalseAllow the same player’s plots to overlap

World Settings

ignore-spawn-location-worlds:
  - "world_nether"
disable-worlds:
  - "world_nether"
  - "world_the_end"
invert-disabled-worlds: false
ignore-world-guard-regions:
  - "plots_region"
OptionTypeDefaultDescription
ignore-spawn-location-worldsList["world_nether"]Worlds where spawn distance check is skipped
disable-worldsList["world_nether", "world_the_end"]Worlds where plots cannot be created
invert-disabled-worldsBooleanfalseIf true, only allow plots in listed worlds instead of blocking them
ignore-world-guard-regionsList["plots_region"]WorldGuard regions where plots cannot be created

Plot Defaults

defaults:
  default-plot-name: "Plot"
  default-size: 10
  default-slots: 5
  plot-home-icon: CAMPFIRE
OptionTypeDefaultDescription
default-plot-nameString"Plot"Default name for newly created plots
default-sizeInteger10Initial plot radius (center to edge). Actual size = 2 * size + 1
default-slotsInteger5Initial member slot limit
plot-home-iconMaterialCAMPFIREDefault material icon for plot home

Tip: A default-size of 10 creates a 21x21 block plot (10 blocks in each direction from center, plus the center block).

Warps

plots-warps: true
plot-warp-price: 300.0
OptionTypeDefaultDescription
plots-warpsBooleantrueEnable the plot warp system
plot-warp-priceDouble300.0Cost to create a plot warp

Rating

broadcast-plots-ratings: true
OptionTypeDefaultDescription
broadcast-plots-ratingsBooleantrueBroadcast plot rating changes to players

Economy

economy:
  enable: true
  economy-type: ITEMS
  cost-for-one-expiration-day: 100.0
  upgrading-members-slots: 1
  cost-for-one-members-slot-upgrade: 20.0
  upgrading-plot-size-blocks: 5
  cost-for-one-plot-size-upgrade: 50.0
  upgrade-multiple: 2
OptionTypeDefaultDescription
enableBooleantrueEnable the economy system
economy-typeEnumITEMSEconomy mode: VAULT or ITEMS
cost-for-one-expiration-dayDouble100.0Cost to extend expiration by one day
upgrading-members-slotsInteger1Number of member slots added per upgrade
cost-for-one-members-slot-upgradeDouble20.0Base cost per member slot upgrade
upgrading-plot-size-blocksInteger5Number of blocks added per size upgrade
cost-for-one-plot-size-upgradeDouble50.0Base cost per size upgrade
upgrade-multipleInteger2Cost multiplier applied to each successive upgrade

Economy Types

TypeDescription
VAULTUses any Vault-compatible economy plugin (EssentialsX, CMI, etc.)
ITEMSUses a configurable physical item as currency

Economy Item

When using ITEMS economy type, the currency item is configurable:

economy-item:
  material: EMERALD
  display-name: "&aCustom emerald"
  lore:
    - "&7This &eis &6custom &2emerald"

Tip: Economy items support custom model data for integration with Oraxen or Nexo.

Cost Multiplier

The upgrade-multiple option increases the cost for each successive upgrade. The formula is:

cost = baseCost * (multiplier ^ upgradeCount)

For example, with upgrade-multiple: 2 and cost-for-one-plot-size-upgrade: 50:

  • 1st upgrade: 50
  • 2nd upgrade: 100
  • 3rd upgrade: 200
  • 4th upgrade: 400

Expiration

expiration:
  enable: true
  default-expiration-hours: 48
  maximum-expiration-hours: 256
  broadcast-when-team-are-expired: true
  unit-type: DAYS
OptionTypeDefaultDescription
enableBooleantrueEnable the plot expiration system
default-expiration-hoursInteger48Default plot lifespan in hours
maximum-expiration-hoursInteger256Maximum plot lifespan in hours
broadcast-when-team-are-expiredBooleantrueBroadcast a message when a plot expires
unit-typeEnumDAYSDisplay unit for expiration time

Unit Types

UnitDescription
HOURSDisplay expiration in hours
DAYSDisplay expiration in days
WEEKSDisplay expiration in weeks
MONTHSDisplay expiration in months

Limits

Plot, size, and member slot limits are assigned via permissions. Each entry maps a permission suffix to a limit value.

limits:
  plots-limit:
    default: 1
    vip: 4
    svip: 10
  size-limit:
    default: 20
    vip: 40
    svip: 60
  slots-limit:
    default: 5
    vip: 10
    svip: 15

The resulting permissions are:

PermissionPlotsMax SizeMember Slots
plots.limit.default / plots.size.default / plots.slots.default1205
plots.limit.vip / plots.size.vip / plots.slots.vip44010
plots.limit.svip / plots.size.svip / plots.slots.svip106015

Tip: The default permission entries are granted to all players by default. Add custom entries (e.g., mvp: 20) to create additional tiers β€” the corresponding permission would be plots.limit.mvp.


Hologram

Requires: A supported hologram plugin must be installed. minePlots integrates with DecentHolograms, FancyHolograms, and HolographicDisplays. Without one of these plugins, holograms will not appear even if enable: true.

hologram:
  enable: true
  added-y-block-from-center: 2.0
  line-height: 0.25
  lines:
    - "&a&lminePlots"
    - ""
    - "&7Plot name: &e{name}"
    - "&7Owner: &e{owner}"
    - ""
    - "&e&lCLICK TO OPEN PANEL"
OptionTypeDefaultDescription
enableBooleantrueShow an information hologram above each plot
added-y-block-from-centerDouble2.0Height above the plot center where the hologram appears
line-heightDouble0.25Vertical spacing between hologram lines
linesListsee aboveHologram lines. Supports {name} and {owner} placeholders

Visualize

visualize:
  visualize-material: RED_CONCRETE
  visualize-particles:
    particle: FLAME
    dust-particles:
      red: 255
      green: 178
      blue: 45
      size: 1.0
  visualize-time: 60
  visualize-type: BLOCKS
OptionTypeDefaultDescription
visualize-materialMaterialRED_CONCRETEBlock used to mark plot borders when BLOCKS mode is active
visualize-particles.particleParticleFLAMEParticle type used when PARTICLES mode is active
visualize-particles.dust-particlesObjectsee aboveColor and size for DUST particle type
visualize-timeInteger60How long (in seconds) the visualization is shown
visualize-typeEnumBLOCKSHow to display plot borders: BLOCKS or PARTICLES

Plot Boss Bar

plot-boss-bar:
  enable: true
  own-plot-boss-bar:
    name: "&aYou are on your own plot of land! &8(&e{distance}m&8)"
    color: GREEN
    overlay: NOTCHED_20
  friendly-plot-boss-bar:
    name: "&6You are in a friendly plot of land! &8(&e{distance}m&8)"
    color: YELLOW
    overlay: NOTCHED_20
  enemy-plot-boss-bar:
    name: "&cYou are in a enemy plot! &8(&e{distance}m&8)"
    color: RED
    overlay: NOTCHED_20
OptionTypeDefaultDescription
enableBooleantrueShow a boss bar when a player enters a plot
*.nameStringsee aboveBoss bar message. Supports {distance} and {plot} placeholders
*.colorEnumvariesBar color: GREEN, YELLOW, RED, BLUE, PURPLE, PINK, WHITE
*.overlayEnumNOTCHED_20Bar style: PROGRESS, NOTCHED_6, NOTCHED_10, NOTCHED_12, NOTCHED_20

Expiration Task

Controls renewal reminders sent to plot owners/members before their plot expires.

expiration-task:
  enabled: true
  min-plot-expire-time: 1
  min-plot-expire-time-unit: DAYS
  reminder-interval: 1
  reminder-interval-unit: HOURS
  remind-on-join: true
  notification-scope: MEMBERS_WITH_PERMISSION
OptionTypeDefaultDescription
enabledBooleantrueEnable expiration reminder notifications
min-plot-expire-timeLong1Start sending reminders when expiry is within this amount of time
min-plot-expire-time-unitTimeUnitDAYSUnit for min-plot-expire-time (DAYS, HOURS, MINUTES, SECONDS)
reminder-intervalInteger1How often to repeat the reminder
reminder-interval-unitTimeUnitHOURSUnit for reminder-interval
remind-on-joinBooleantrueSend a reminder when the player joins the server
notification-scopeEnumMEMBERS_WITH_PERMISSIONWho receives the reminder: ALL_MEMBERS, ONLY_OWNER, MEMBERS_WITH_PERMISSION

Crafting

Controls the crafting recipe for the plot creation block.

crafting-preset: false
default-crafting-recipe:
  shape:
    - "OOO"
    - "ODO"
    - "OOO"
  ingredients:
    O: OAK_LOG
    D: DIAMOND
vehicle-move-flag-enable: false
commands-invoked-when-plot-created:
  - "plot"
OptionTypeDefaultDescription
crafting-presetBooleanfalseEnable preset-size crafting recipes (preset-recipe-configurations)
default-crafting-recipe.shapeListsee aboveCrafting grid layout using ingredient characters
default-crafting-recipe.ingredientsMapO: OAK_LOG, D: DIAMONDCharacter-to-material mapping for the recipe
vehicle-move-flag-enableBooleanfalseEnable tracking of vehicle movement through the VEHICLE flag
commands-invoked-when-plot-createdList["plot"]Commands auto-dispatched as the player when they create a plot

Squaremap Integration

If squaremap is installed, minePlots will render plot markers on the live map.

layer:
  marker-click-text: "Owner: {username}"
  marker-hover-text: "{name}"
  fill-settings:
    whether-is-visible: true
    color: "#326da8"
    weight: 1
    opacity: 0.5
  stroke-settings:
    whether-is-visible: true
    color: "#326da8"
    weight: 1
    opacity: 0.5
  marker-update-interval: 30
OptionTypeDefaultDescription
marker-click-textString"Owner: {username}"Text shown in the popup when a marker is clicked. Supports {username}, {name}
marker-hover-textString"{name}"Tooltip text on hover
fill-settings.whether-is-visibleBooleantrueShow plot fill color
fill-settings.colorString"#326da8"Fill color (hex)
fill-settings.weightInteger1Fill border weight
fill-settings.opacityDouble0.5Fill opacity (0.0–1.0)
stroke-settingsObjectsame as fillBorder stroke settings (same fields as fill)
marker-update-intervalInteger30How often (in seconds) markers are refreshed on the map