Config File

uxmFarmer Configuration Documentation

This guide will walk you through every setting in your config.yml file. We'll explain what each option does, what the available choices are, and how you can best configure your server.

General Settings

These are the basic settings at the top of your file.

Option	Type	Description
config-version	String	Do not change this! This is used by the plugin to manage updates.
language	String	Sets the language for all plugin messages. Supported: EN (English), TR (Turkish).

---

🔌 Hooks (Plugin Integrations)

This section details the various hooks used by the Farmer plugin to integrate with other plugins on your server.

Region Hooks

These settings determine how the plugin interacts with land management and claim plugins to define farmer boundaries and membership.

Option	Type	Description
region-hook	String	Required. Tells the farmer which land protection or island plugin should be used for checking region boundaries, ownership, and members. Supported Plugins: uxmClaims DeluxeSkyblock IridiumSkyblock SuperiorSkyblock2 Lands RealmCore GriefPrevention GriefDefender Tip: It’s recommended to disable place-farmer-on-region-creation when using GriefDefender. RClaim Towny (for TownyAdvanced) UltimateClaims FabledSkyBlock ProtectionStones Format: ProtectionStones:<claim world name> BentoBox:BSkyBlock Format: BentoBox:<island world friendly name> BentoBox:OneBlock Format: BentoBox:<island world friendly name>

Economy Hooks

This setting defines the primary plugin used for all money transactions.

Option	Type	Description
money-hook	String	Required. Sets the plugin used for all economy transactions (purchasing farmers, selling crops, taxes). Supported Plugins: Vault (Most common) PlayerPoints SuperiorSkyblock2 (island banks)

Price Source Hooks

This setting specifies where the plugin looks to determine the market price of items for the farmer's selling mechanism.

Option	Type	Description
price-source-hook	String	Sets the plugin used to determine the price of crops and materials for the farmer's internal selling mechanism. Use default if no external shop plugin is used. Supported Plugins: ShopGUIPlus EconomyShopGUI or EconomyShopGUI-Premium ExcellentShop default

NPC/Interaction Hooks

These settings specify which plugin handles the farmer's visual representation and physical interaction logic.

Option	Type	Description
interaction-hook	String	Specifies which plugin handles the farmer's NPC entity model and interaction logic. Leave empty if relying only on internal systems. Supported Plugins: FancyNpcs Citizens ZNPCsPlus PlayerNpc Internal/Model Hooks: Holograms (internal text display) and ModelSystem (for custom models via ModelEngine, ItemsAdder, BetterModel)

---

🗄️ Database

This is where all your farmer data (owner, upgrades, contents) is stored.

Option	Type	Description
driver	String	The type of database to use. SQLITE is simple and stores data in a file. MYSQL is recommended for larger servers or multi-server networks.
host	String	The IP address of your MySQL database (e.g., localhost).
database	String	The name of the database to use.
username	String	The username for your MySQL database.
password	String	The password for your MySQL database.
port	Integer	The port for your MySQL database (default is 3306).
use-ssl	Boolean	Whether to use a secure connection (SSL) to your database.

---

🌐 Multi-Server

Configure this if you run a network (like BungeeCord/Velocity) and want farmers to sync across servers.

Option	Type	Description
enabled	Boolean	Set to true if you are using more than one server.
redis-host	String	The host address for your Redis server, which is required for multi-server syncing.

---

🎨 Model Settings

This section is for using custom models from plugins like ModelEngine, ItemsAdder, or BetterModel.

Option	Type	Description
default-entity	String	The default Minecraft Entity to use if no model is applied (e.g., VILLAGER).
model-source	String	Which plugin is providing the custom model: ModelEngine, ItemsAdder, or BetterModel.
model-name	String	The ID/name of the model you want to use from the source plugin.

---

🧹 Log Cleaner

Manages the plugin's logs to save database space.

Option	Type	Description
enabled	Boolean	Set to true to enable automatic log cleaning. Be careful! The comments warn this could cause lag the first time it runs on old databases.
clean-old-logs-after	Integer	The total number of logs to wait for before cleaning.
logs-to-clean	Integer	The number of oldest logs to remove once the threshold is met.

---

⏳ Cooldowns

Sets the time (in seconds) players must wait between using certain commands.

Option	Type	Description
move-cooldown	Integer	Cooldown for moving the farmer.
sell-all-cooldown	Integer	Cooldown for selling all products.
sell-xp-cooldown	Integer	Cooldown for selling experience.
change-glowing-cooldown	Integer	Cooldown for changing the farmer's glow color.
change-entity-cooldown	Integer	Cooldown for changing the farmer's entity type.
change-profession-cooldown	Integer	Cooldown for changing the farmer's villager profession.
return-cooldown	Integer	Cooldown for returning (deleting) the farmer.

---

🔊 Sounds

Defines the Sounds played for specific plugin events.

Option	Type	Description
on-cooldown	String	Sound played when a command is on cooldown.
try-again	String	Sound played for a minor error (e.g., failed input).
already-using-that-glow-color	String	Sound played when trying to select the currently active glow color.
blacklisted-world	String	Sound played when trying to use a farmer command in a disabled world.

---

🐛 Debug

This is for developers and support staff.

Option	Type	Description
debug	Boolean	Keep this false! Enabling it will spam your console with detailed information, which can cause lag. Only enable it if a developer asks you to.