Skip to main content

Configuration

The configuration file for Nexal Regions. Located at plugins/Nexal Regions/config.yml.

config.yml
# ============================================================
#                    Nexal Regions Configuration
# ============================================================
# A comprehensive region management plugin with buy, sell, and rent functionality
# by Nexal Studios
#
# Most of these settings can also be changed in game: /region admin > Configuration.

# ============================================================
#                         STORAGE
# ============================================================
storage:
  # Storage type: json or sql (MySQL/MariaDB). Changing it needs a restart.
  # To move your data: /region admin export, change the type, restart, /region admin import
  type: json

  # SQL configuration (only used if type is sql).
  # Configs from older versions with a "mysql:" section instead keep working.
  sql:
    host: localhost
    port: 3306
    database: nexal_regions
    username: root
    password: ""

# ============================================================
#                        FEATURES
# ============================================================
features:
  # Enable entry notifications (alert owners when someone enters their region)
  entry-notifications: true

  # Let players show region borders as particles (/region borders)
  border-particles: true

  # Let players show region borders as a glowing outline (/region borders).
  # Each player's outline is visible only to them.
  border-glow: true

  # Enable region holograms
  holograms: true

# ============================================================
#                         REGIONS
# ============================================================
regions:
  # Default flag values for new regions
  default-flags:
    pvp: false
    mob-spawning: true
    explosions: false
    fire-spread: false

  # Region ownership limits per permission group
  # Use nexalregions.limit.<number> permission for custom limits
  # Use nexalregions.limit.unlimited for no limit
  limits:
    default: 1

# ============================================================
#                          RENT
# ============================================================
rent:
  # Length of each rent period, in seconds. Renters pick one with /region rent <hour|day|mcday>.
  # Rent prices are set per day; a period costs its share of the daily price.
  periods:
    hour-real: 3600        # 1 hour
    day-real: 86400        # 24 hours
    day-minecraft: 1200    # 20 minutes (1 Minecraft day)

  # The most rent time a renter can have paid ahead with /region pay (in days).
  # Payments are prorated: a renter only pays for the time actually added.
  max-upfront-days: 7

  # Automatically renew rent when payment is due (if player has funds)
  auto-renewal: true

  # Grace period before eviction (in seconds)
  # 86400 = 24 hours
  grace-period: 86400

  # During the grace period, how often the renter is warned (in seconds)
  eviction-warning-interval: 3600

  # Reminder times before rent is due (in seconds)
  # Players will receive reminders at these intervals
  reminder-times:
    - 86400  # 24 hours before
    - 3600   # 1 hour before
    - 600    # 10 minutes before

  # Price-lock confirmation expiry time (in seconds)
  # Protects renters from sudden price changes
  confirmation-expiry: 60

  # How often rent and taxes are processed (in seconds)
  check-interval: 60

# ============================================================
#                         TAXES
# ============================================================
taxes:
  # Enable the optional tax system: owners of player-owned regions pay a tax every period,
  # or lose the region to the server after the grace period.
  enabled: false

  # Tax per period for every player-owned region (0 = no tax).
  # /region admin settax <id> <amount> gives a region its own amount.
  default-amount: 0

  # Tax payment period (in seconds)
  # 604800 = 7 days (weekly)
  period: 604800

  # Grace period before reclaiming region for non-payment (in seconds)
  # 172800 = 48 hours
  grace-period: 172800

# ============================================================
#                         OFFERS
# ============================================================
# Admins offer a region to one player at a set price: /region admin offer create.
# The player accepts with /region offer accept. Offers end when the region changes hands.
offers:
  # How long an offer stays open when the command gives no duration (in seconds)
  # 86400 = 24 hours
  default-duration: 86400

# ============================================================
#                        LISTINGS
# ============================================================
listings:
  # Listings mode: disabled, command, or gui
  mode: gui

# ============================================================
#                       HOLOGRAMS
# ============================================================
holograms:
  # How often to update hologram text (in ticks, 20 = 1 second)
  update-interval: 100

  # Hologram lines with placeholders (for player-owned regions)
  # Available: %name%, %id%, %status%, %price%, %owner%, %renter%, %area%, %volume%
  lines:
    - "%name%"
    - "%status%"
    - "%price%"
    - "%owner%"

  # Hologram lines for unowned (server-owned) regions
  # These regions have no player owner yet
  lines-unowned:
    - "%name%"
    - "%status%"
    - "%price%"

# ============================================================
#                    BORDER PARTICLES
# ============================================================
border-particles:
  # How often to update border particles (in ticks, 20 = 1 second)
  update-interval: 10

  # Maximum distance from player to show region borders (blocks)
  max-distance: 10

  # Particle density - space between particles on the border edge (blocks)
  particle-spacing: 0.5

  # Height offset from ground for particles
  height-offset: 1.0

  # Different colors for each region (hex format)
  # Colors cycle through this list for multiple nearby regions
  colors:
    - "#2ECC71"  # Green
    - "#3498DB"  # Blue
    - "#E74C3C"  # Red
    - "#F39C12"  # Orange
    - "#9B59B6"  # Purple
    - "#1ABC9C"  # Teal
    - "#E91E63"  # Pink
    - "#00BCD4"  # Cyan

# ============================================================
#                      BORDER GLOW
# ============================================================
# Glowing outline of small markers along region edges (wireframe effect).
# Markers have no collision and only the player who chose glow mode sees them.
border-glow:
  # How often to update glow borders (in ticks, 20 = 1 second)
  # Higher values = less frequent updates, better performance
  update-interval: 40

  # Maximum distance from player to show region glow borders (blocks)
  max-distance: 15

  # Space between markers on edges (blocks)
  # Lower = denser wireframe, more entities, more lag
  entity-spacing: 3.0

  # Maximum number of markers per region
  # Prevents lag from very large regions
  max-entities-per-region: 60

  # Colors for glow effect: color names or hex (#RRGGBB)
  # Names: BLUE, GREEN, RED, GOLD, AQUA, LIGHT_PURPLE, YELLOW, WHITE, etc.
  colors:
    - "BLUE"
    - "GREEN"
    - "RED"
    - "GOLD"
    - "AQUA"
    - "LIGHT_PURPLE"

Configuration Options​

Below is a reference of the main configuration sections:

storage​

============================================================ Nexal Regions Configuration

A comprehensive region management plugin with buy, sell, and rent functionality by Nexal Studios

Most of these settings can also be changed in game: /region admin > Configuration.

============================================================ STORAGE

features​

============================================================ FEATURES

regions​

============================================================ REGIONS

rent​

============================================================ RENT

taxes​

============================================================ TAXES

offers​

============================================================ OFFERS

Admins offer a region to one player at a set price: /region admin offer create. The player accepts with /region offer accept. Offers end when the region changes hands.

listings​

============================================================ LISTINGS

holograms​

============================================================ HOLOGRAMS

border-particles​

============================================================ BORDER PARTICLES

border-glow​

============================================================ BORDER GLOW

Glowing outline of small markers along region edges (wireframe effect). Markers have no collision and only the player who chose glow mode sees them.