Skip to main content

Configuration

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

config.yml
# ══════════════════════════════════════════════════════════
#                   NEXAL CROPS CONFIG
# ══════════════════════════════════════════════════════════
# Most of these settings can also be changed in-game:
# /crops admin > Configuration. Changes to this file apply
# on save, except storage, which needs a restart.

# Where regions and pending crops are stored.
# Switching: /crops admin export, change type, restart the
# server, then /crops admin import.
storage:
  # "json" (plugins/NexalCrops/data.json) or "sql" (MySQL/MariaDB)
  type: "json"
  sql:
    host: "localhost"
    port: 3306
    database: "nexalcrops"
    username: "root"
    password: ""

# Settings a new region starts with. Each region can be changed
# afterwards in its settings menu (/crops admin settings <name>).
defaults:
  # INDIVIDUAL: each crop respawns on its own after respawn-delay
  # GROUP:      every harvested crop respawns together on a shared timer
  # INSTANT:    a harvested crop resets to a seedling and regrows naturally
  mode: "INDIVIDUAL"
  # Seconds before a harvested crop respawns (INDIVIDUAL and GROUP)
  respawn-delay: 600
  # ALL: every vanilla drop; HARVEST_ONLY: no seeds; NONE: nothing drops
  drop-filter: "ALL"
  # GROUND: drops fall on the ground; INVENTORY: drops go to the player
  # (whatever does not fit falls on the ground)
  drop-destination: "GROUND"
  # true: crops are harvested before protection plugins (WorldGuard,
  # claims) can refuse it, so players can farm in protected areas
  bypass-protection: false
  # true: players and mobs cannot trample farmland in the region
  prevent-trample: true
  # true: farmland in the region never dries out
  prevent-moisture-loss: true

# Crops that are harvested and respawned inside regions (Material names).
# Crops growing on farmland or, for NETHER_WART, soul sand are supported.
# Crops growing on anything else (cocoa, sweet berries) are not.
supported-crops:
  - "WHEAT"
  - "CARROTS"
  - "POTATOES"
  - "BEETROOTS"
  - "NETHER_WART"

# Floating text above each enabled region. No hologram plugin is needed.
hologram:
  # false removes every region hologram
  enabled: true
  # Lines of regions in GROUP mode.
  # Placeholders: %region% (name), %countdown% (time until the next respawn)
  lines:
    - "<gradient:#E67E22:#EB984E><bold>Crop Region</bold></gradient>"
    - "<gray>%region%</gray>"
    - ""
    - "<gradient:#AAAAAA:#BBBBBB>Next respawn in:</gradient>"
    - "<gradient:#FFC107:#FFCD38>%countdown%</gradient>"
  # Lines of regions in INDIVIDUAL and INSTANT mode. Placeholders: %region%
  lines-no-timer:
    - "<gradient:#E67E22:#EB984E><bold>Crop Region</bold></gradient>"
    - "<gray>%region%</gray>"
  # Blocks above the top of the region where an auto-centred hologram
  # floats. A position set with /crops admin sethologram ignores this.
  y-offset: 3.0

Configuration Options​

Below is a reference of the main configuration sections:

storage​

══════════════════════════════════════════════════════════ NEXAL CROPS CONFIG ══════════════════════════════════════════════════════════ Most of these settings can also be changed in-game: /crops admin > Configuration. Changes to this file apply on save, except storage, which needs a restart.

Where regions and pending crops are stored. Switching: /crops admin export, change type, restart the server, then /crops admin import.

defaults​

Settings a new region starts with. Each region can be changed afterwards in its settings menu (/crops admin settings <name>).

supported-crops​

Crops that are harvested and respawned inside regions (Material names). Crops growing on farmland or, for NETHER_WART, soul sand are supported. Crops growing on anything else (cocoa, sweet berries) are not.

hologram​

Floating text above each enabled region. No hologram plugin is needed.