Configuration
This section provides a detailed breakdown of every option available in the config.yml file.
General Settings
general:
check-updates: true
use-permissions: false
enabled-worlds:
- "world"
- "world_the_end"
regeneration-ticks-per-stage: 10
use-vanilla-growth-speed: false
require-hoe: true
check-updates
: Iftrue
, the plugin will check for new versions on SpigotMC when the server starts.use-permissions
: Iftrue
, the detailed permission system is enabled. Iffalse
, anyone withharvestflow.use
can access all features.enabled-worlds
: A list of the worlds where HarvestFlow's features will be active.regeneration-ticks-per-stage
: The time in server ticks for a replanted crop to advance one growth stage. Ignored ifuse-vanilla-growth-speed
is true. (20 ticks = 1 second).use-vanilla-growth-speed
: Iftrue
, the plugin will not use its custom growth timer and will rely on Minecraft's default random tick speed.require-hoe
: Iftrue
, players must use a hoe to harvest crops with HarvestFlow.
Harvest Behavior
harvest-behavior:
auto-add-to-inventory: true
auto-add-to-inventory
: Iftrue
, harvested items are placed directly into the player's inventory. If their inventory is full, items are dropped on the ground.
Crop Protection
crop-protection:
enabled: true
enabled
: Iftrue
, players cannot break immature (not fully grown) crops by left-clicking. They can still be broken by sneaking while holding a hoe.
WorldGuard Integration
worldguard-integration:
respect-named-regions: true
respect-named-regions
: This is a crucial setting for server protection.If
true
, HarvestFlow will respect theblock-break: deny
flag in any named WorldGuard region.If
false
, HarvestFlow will bypass theblock-break: deny
flag, allowing players to farm anywhere. This is generally not recommended unless you have a specific use case.
Enchantment Settings
enchantments:
fortune:
enabled: true
apply-to-custom-drops: false
enabled
: Iftrue
, the Fortune enchantment on a player's hoe will increase the yield of harvested crops.apply-to-custom-drops
: Iftrue
, Fortune will also apply to your custom drops. Iffalse
, it will only affect default vanilla drops. Set tofalse
to protect your server's economy from over-inflation of valuable custom items.
Supported Crops
supported-crops:
WHEAT: true
CARROTS: true
POTATOES: true
BEETROOTS: true
NETHER_WART: true
Enable (
true
) or disable (false
) HarvestFlow's mechanics for each specific crop type.
Area of Effect (AoE) Harvesting
harvest-area:
enabled: true
radius: 1
require-sneaking: true
reduce-durability-per-block: true
enabled
: Iftrue
, players can harvest multiple crops at once.radius
: The radius of the harvest area.0
is a single block,1
is a 3x3 area,2
is a 5x5 area, etc.require-sneaking
: Iftrue
, the player must be sneaking (holding Shift) to trigger an AoE harvest.reduce-durability-per-block
: Iftrue
, the hoe's durability is reduced for each block harvested in the AoE. Iffalse
, durability is only reduced once for the entire action.
Sounds & Messages
sounds:
no-hoe-break: "BLOCK_ANVIL_LAND"
successful-harvest: "ENTITY_ITEM_PICKUP"
inventory-full: "ENTITY_VILLAGER_NO"
no-permission-feature: "BLOCK_NOTE_BLOCK_DIDGERIDOO"
messages:
prefix: "&6[&eHarvestFlow&6] "
no-hoe-actionbar: "&cYou must use a hoe to harvest this crop!"
config-reloaded: "&aConfiguration has been successfully reloaded."
no-permission: "&cYou do not have permission to execute this command."
no-permission-feature-actionbar: "&cYou do not have permission to use this feature."
update-notify: "&e[Harvest-Flow] A new version is available! Download it from: &f%link%"
Customize the sounds and messages for various plugin events. You can find a list of valid sound names on the Spigot Javadocs website.
Full Inventory Feedback
full-inventory-feedback:
enabled: true
title: "&cInventory Full!"
subtitle: "&eItems have been dropped on the ground."
fade-in: 10
stay: 60
fade-out: 20
Configure the title message that appears on a player's screen when their inventory is full and items are dropped on the ground. The time values are in ticks.
Item Drop Configuration
This is the most powerful section of the plugin. You can define drop behavior for each crop.
Basic Vanilla-like Drop
This example makes potatoes drop like they do in vanilla, but with a defined quantity range.
item-drops:
POTATO:
custom-drop: false
min: 2
max: 4
durability-cost: 1
custom-drop: false
: This tells the plugin to drop the default item for this crop (potatoes).min
/max
: The minimum and maximum number of items to drop.durability-cost
: The amount of durability to remove from the hoe for this harvest.
Custom Drop
This example replaces the default wheat drop with a custom item called "Magical Essence".
WHEAT:
custom-drop: true
material: AMETHYST_SHARD
display-name: "&bMagical Essence"
lore:
- "&7A shard of pure magical energy."
- "&7Can be used in alchemy."
min: 1
max: 2
durability-cost: 2
drop-seeds: true
custom-drop: true
: This enables the custom drop system.material
: The material of the item to drop (e.g.,AMETHYST_SHARD
).display-name
: The custom name of the item. Supports color codes.lore
: A list of strings for the item's lore. Supports color codes.drop-seeds
: Iftrue
, the corresponding seeds (e.g., Wheat Seeds) will also be dropped.
Bonus Drops
This example shows a standard carrot drop that also has a 5% chance to drop a special Golden Carrot.
CARROT:
custom-drop: false
min: 2
max: 4
durability-cost: 1
bonus:
chance: 0.05
item:
material: GOLDEN_CARROT
min: 1
max: 1
display-name: "&6Enchanted Golden Carrot"
lore:
- "&eA rare and highly nutritious find!"
commands:
- "broadcast &e%player% &ahas found an Enchanted Golden Carrot while harvesting!"
bonus
: This section defines a potential bonus drop.chance
: The probability of the bonus dropping, from0.0
(0%) to1.0
(100%).0.05
is a 5% chance.item
: Defines the item to be awarded if the chance check succeeds. It has the same structure as a custom drop.commands
: A list of commands to be executed by the console when this specific bonus is awarded. Use%player%
as a placeholder for the player's name.
Last updated