Skip to content

General Settings File

Ali Arslan edited this page Jan 21, 2026 · 5 revisions

⚙️ General Settings

This section controls the core logic, economy, and behavior of your farmers.

Option Type Description
disabled-worlds List A list of worlds where farmers will not work (e.g., world_nether, world_the_end).
disabled-products-grow-physically Boolean If true, products that are have their collection status disabled by the farmer owner/member will grow physically and will not be simulated. This can cause critical performance issues, not recommended to enable.
collect-dropped-items Boolean If true, the farmer will collect matching items dropped on to ground within its region.
collect-player-dropped-items Boolean Whether farmer should collect items dropped by players.
collect-custom-items Boolean If true, the farmer will collect items that have custom names or lore. If false, it ignores them.
upgrade-all-upgrades-everything Boolean If false, /farmer upgrade-all only upgrades items the farmer has collected before. If true, it upgrades everything in the farmer's storage.
upgrade-all-discount Integer A percentage discount (0-100) to apply when using the "upgrade-all" function. 50 means 50% off.
place-farmer-on-region-creation Boolean If true, a farmer is automatically placed when a player creates a new region (e.g., an island or claim).
farmer-command-opens-gui Boolean If true, /farmer opens the main GUI.
farmer-command-opens-buy-menu Boolean If true and the player doesn't have a farmer, /farmer will open the purchase menu.
disable-buy-command Boolean If true, disables /farmer buy. The only way to get farmers would be via admin-given eggs.
sell-all-requires-confirmation Boolean If true, players must confirm before selling all items to prevent accidents.
adding-member-requires-permission Boolean If true, farmer managers will need the permission uxmfarmer.addmember to add new members.
add-new-region-members-to-farmer Boolean If true, new region members (like island member or trusted player in a claim) will be added to farmer as members too.
remove-leaving-region-members-from-farmer Boolean If true, region members who have left the region will be removed from farmer members
default-click-actions List A list of actions (as Strings) to perform when a player clicks the farmer NPC. Default opens the main menu and plays a sound.
disable-transfer Boolean If true, players cannot give their farmer to another player.
maximum-farmer-per-player Integer The default maximum number of farmers a player can own. Grant uxmfarmer.maxfarmer.<amount> to allow more.
tax-price Double The default tax rate (as a decimal) taken from all sales. 0.25 = 25% tax.
farmer-price Double The flat cost to buy one new farmer.
return-price-on-delete Boolean If true, the owner gets money back when their farmer is deleted (e.g., by staff).
return-percent Integer The percentage of the farmer-price a player gets back when they use /farmer return. 75 = 75% back.
glow-if-stock-is-full boolean Gives a glow effect to product's slot if its stock is full

🧭 First Location (Automatic Placement)

This only works when place-farmer-on-region-creation is enabled. It configures the exact coordinates and rotation of the automatically placed farmer relative to the region center.

Option Type Description
enabled Boolean Set to true to use this automatic location feature.
modify-by String The X, Y, Z offset (relative to region center) where the farmer will be placed (e.g., -5.5, 1.5, 3.5).
rotation String The Pitch, Yaw rotation values for the farmer's head (e.g., -88, 0.8).

🧑‍🤝‍🧑 Add Member Input

This section controls the behavior when a player attempts to add a member to their farmer.

Option Type Description
required-online Boolean If true, the player being added must be online to be successfully added as a member.
input-type String How to take the target player's name: CHAT (typing in chat) or SIGN (anvil/sign GUI).
chat-timeout Integer How long (in seconds) the plugin waits for the player to enter input via chat before timing out.

📦 Take Amount Input

This section configures how the player provides a specific quantity (e.g., of XP or items) to take from the farmer.

Option Type Description
input-type String How to take player input: CHAT (typing in chat) or SIGN (anvil/sign GUI).
chat-timeout Integer How long (in seconds) the plugin waits for the player to enter input via chat before timing out.

Clone this wiki locally