Skip to main content

​
sFarmer Plugin Guide

This comprehensive guide will help you set up and configure the sFarmer plugin for your Minecraft server, creating an automated farming system with NPC farmers that collect crops and resources for you.

​
What is sFarmer?

sFarmer is a powerful Minecraft plugin that adds NPC farmers to your server who can automatically:
  • Harvest crops when they’re fully grown
  • Replant crops in empty farmland
  • Kill farm animals for resources
  • Collect and store farming resources
  • Sell harvested items for server currency
This plugin is perfect for survival, skyblock, or economy-based servers where you want to add more depth to the farming experience and provide players with automation options.

​
Features Overview

  • NPC Farmers: Custom NPCs that look like farmers and perform automated tasks
  • Auto-Harvesting: Automatically harvest mature crops in a designated area
  • Auto-Planting: Automatically plant seeds in empty farmland
  • Auto-Killing: Automatically kill specified farm animals for resources
  • Storage System: Store collected resources with upgradeable capacity
  • Economy Integration: Sell harvested items for server currency
  • Team Management: Allow multiple players to manage a single farmer
  • Permission Ranks: Assign different permission levels to team members
  • Visual Customization: Customize farmer appearance with glowing effects and colors

​
Prerequisites

Before installing sFarmer, you’ll need:
  • A Minecraft server running Spigot, Paper, or a compatible fork (Minecraft 1.20.6 or newer)
  • Server operator permissions (or access to the server files)
  • An economy plugin (Vault recommended) for the selling feature
  • A land claim/protection plugin (optional but recommended)

​
Compatible Plugins

sFarmer works best with these plugins: Region Protection:
  • SuperiorSkyblock2
  • IridiumSkyblock
  • BentoBox (BSkyBlock, OneBlock)
  • Lands
  • GriefPrevention
  • RClaim
  • Towny
  • UltimateClaims
  • FabledSkyBlock
Economy:
  • Vault (with any economy plugin)
  • PlayerPoints
NPC/Hologram:
  • Citizens
  • FancyNpcs
  • DecentHolograms
  • FancyHolograms

​
Step-by-Step Installation Guide

​
1. Downloading the Plugin

  1. Download the sFarmer plugin JAR file from a trusted source
  2. Make sure you download a version compatible with your server version (1.16+)

​
2. Installing the Plugin

  1. Stop your Minecraft server if it’s running
  2. Locate your server’s plugins folder
    • This is typically in the same directory as your server JAR file
  3. Copy the downloaded sFarmer.jar file into the plugins folder
  4. Start your server
  5. The plugin will automatically create its configuration files
  6. Once the server is fully loaded, stop it again to configure the plugin

​
3. Basic Configuration

After first startup, you’ll find a new folder called sFarmer in your plugins directory. Here are the key files:
  • config.yml: Main configuration file
  • collected-materials.yml: Settings for harvestable materials and their prices
  • languages/en/messages.yml: Customizable messages
  • languages/en/ranks.yml: Team rank configuration

​
Setting Up Essential Configurations:

  1. Open the config.yml file
  2. Configure your region protection plugin: 
    hooks:
  region-hook: "YOUR_LAND_PLUGIN"  # e.g., "SuperiorSkyblock2"
  3. Configure your economy plugin: 
    hooks:
  money-hook: "Vault"  # Or "PlayerPoints"
  4. Configure your NPC plugin (if using): 
    hooks:
  interaction-hook: "YOUR_INTERACTION_PLUGIN"
  5. Save the file and restart your server

​
How to Use sFarmer

​
Getting Started

  1. Purchasing a Farmer:
    • In-game, use the command: /farmer buy
    • This costs the amount specified in config.yml (default: 15000)
    • The farmer NPC will spawn at your current location
  2. Accessing Your Farmer:
    • Approach your farmer and right-click on them
    • This opens the main farmer menu
  3. Managing Your Farmer:
    • The main menu provides options for:
      • Viewing collected resources
      • Managing team members
      • Adjusting automation settings
      • Upgrading storage capacity
      • Selling collected resources

​
Main Commands

CommandDescriptionPermission
/farmer buyPurchase a farmer for your land/islandNo Permission
/farmer menuOpen the farmer management menusfarmer.command.menuNo Permission
/farmer teleportTeleport the farmer to your current locationsfarmer.changeskin
/farmer sellallSell all collected resources for moneysfarmer.command.sellall
/farmer returnReturns the farmer and gives back original pricesfarmer.returnfarmer
/farmer skin <skin name>Changes NPC skinsfarmer.changeskin

​
Admin Commands

CommandDescriptionPermission
/sfarmerSends admin help messagesfarmer.command.admin
/sfarmer reloadReload the plugin configurationsfarmer.command.reload
/sfarmer saveSaves everything to database and refreshes permission cachessfarmer.command.save
/sfarmer bypassToggle admin bypass modesfarmer.command.bypass
/sfarmer uuidof <player>Sends UUID of given player’s farmersfarmer.command.uuidof
/sfarmer delete <player>Delete given player’s farmersfarmer.command.delete
/sfarmer deleteall <player>Delete given player’s every farmersfarmer.command.delete
/sfarmer givefarmer <player>Gives given player a farmersfarmer.command.givefarmer
/sfarmer giveproductupgrader <player> <product> <level> <amount>Gives an item that upgrades given product’s levelsfarmer.command.setproductlevel
/sfarmer giveegg <player> <amount>Gives given player a farmer egg, gives a farmer upon right clicksfarmer.command.giveegg

​
Automation Features

​
Auto-Harvesting

Your farmer can automatically harvest fully grown crops including:
  • Wheat, Carrots, Potatoes
  • Pumpkins, Cactus, Sugar Cane
  • And other configurable crops
To enable auto-harvesting:
  1. Open your farmer menu
  2. Navigate to “Settings”
  3. Enable “Automatic Harvest”

​
Auto-Killing

Your farmer can automatically kill farm animals for resources:
  1. Open your farmer menu
  2. Navigate to “Settings”
  3. Enable “Automatic Kill”
  4. Configure which animals to target in the menu

​
Storage and Economy

​
Storage System

  • Each material has its own storage capacity
  • You can upgrade storage capacity for each material
  • View stored materials in the farmer menu

​
Selling Products

  1. Open your farmer menu
  2. Click on the “Sell” option for individual materials, or
  3. Use /farmer sellall to sell everything at once
  4. Money will be added to your account based on configured prices

​
Upgrading Storage

  1. Open your farmer menu
  2. Click on a material you want to upgrade
  3. Purchase storage upgrades using server currency
  4. Higher levels provide more storage capacity

​
Team Management

You can add team members to help manage your farmer:
  1. Open your farmer menu
  2. Navigate to “Members”
  3. Click “Add Member” and enter a player name
  4. Assign appropriate permissions

​
Ranks and Permissions

sFarmer has three default ranks with increasing permissions:
  • Member: Can sell products, collect items, toggle glowing
  • Leader: All Member permissions plus ability to move the farmer
  • Owner: Full control including managing team members
To change a member’s rank:
  1. Open the farmer menu
  2. Navigate to “Members”
  3. Click on the member
  4. Use promotion/demotion options

​
Customization Options

​
Farmer Appearance

You can customize your farmer’s appearance:
  1. Open your farmer menu
  2. Navigate to “Settings”
  3. Options include:
    • Toggle glowing effect
    • Change glowing color
    • Customize name display
    • Change skin

​
Material Prices

Admins can configure the selling prices for all materials:
  1. Open collected-materials.yml
  2. Adjust the unit-price for any material
  3. Save and reload the plugin
Example: 
CACTUS:
  unit-price: 1.5
  tax-price: 0.15
WHEAT:
  unit-price: 2.5
sFarmer uses an intuitive GUI system to make managing your farmers easy and enjoyable. Here’s a breakdown of the main menus you’ll encounter:

​
Main Farmer Menu

The central hub for interacting with your farmer. From here you can:
  • View all collected resources and their quantities
  • Access the management panel
  • Move your farmer to your current location
  • Sell all collected resources at once
  • View farmer logs
  • Configure glowing settings
  • Toggle automatic item collection
Each stored material appears with detailed information:
  • Current stock and maximum capacity
  • Unit price for selling
  • Fullness percentage
  • Production rate statistics (per minute/hour/day)
  • Options to collect, sell, or upgrade storage

​
Management Panel

The management panel gives you access to:
  1. Members Management
    • Add new team members
    • View all current team members
    • Promote/demote members
    • Change member permissions
    • Remove members
  2. Farmer Settings
    • Toggle auto-harvesting of crops
    • Toggle auto-planting of seeds
    • Toggle auto-killing of farm animals
  3. Permissions System
    • Configure which ranks can access specific features
    • Customize permission levels for each team rank

​
Activity Logs

The logs menu tracks all important actions related to your farmer:
  • Resource collection events (who collected what and when)
  • Sales records (who sold what, how much, and earnings)
  • Member management activities (adding, promoting, demoting members)
You can filter logs by player to see actions performed by specific team members, making it easier to track everyone’s contributions.

​
Appearance Customization

The glowing settings menu allows you to:
  • Toggle the farmer’s glowing effect on/off
  • Choose from 16 different glowing colors to customize your farmer’s appearance
  • Change colors with a cooldown period (configurable in settings)

​
Advanced Features

​
Permission System

sFarmer has a sophisticated permission system that allows fine control over who can do what with your farmer:
  1. Available Permissions:
    • Access Management Panel - Control who can access the admin functions
    • Sell Products - Allow selling collected resources
    • Collect Products - Allow collecting items from storage
    • Toggle Glowing - Control glowing effect on/off
    • Change Glowing Color - Customize appearance
    • Move Farmer Location - Relocate the farmer
    • View Farmer Logs - Access to activity history
  2. Default Ranks:
    • Owner - Full control of the farmer (automatically assigned to creator)
    • Leader - Advanced permissions including moving the farmer
    • Member - Basic permissions for daily operations
  3. Permission Management:
    • Rank requirements can be adjusted through the permissions menu
    • Left-click raises permission requirements
    • Right-click lowers permission requirements

​
Storage Upgrade System

Each material collected by the farmer has its own independent storage system:
  1. Upgrading Process:
    • View material details in the main menu
    • Press ‘Q’ or click the upgrade option
    • Purchase upgrades using server currency
    • Each level increases storage capacity
  2. Upgrade Tiers:
    • Multiple upgrade levels available (up to level 12 by default)
    • Each level provides increased capacity
    • Higher levels cost more to purchase
    • Maximum capacity at top level is 120,000 items (configurable)

​
Automation Modules

Your farmer has three main automation features that can be toggled independently:
  1. Production Module
    • Calculates Farmer’s earnings for each product.
  2. Auto-Harvest Module:
    • Automatically harvests mature crops in your claimed land
    • Configurable for specific crop types
    • Collects the harvested items into storage
  3. Auto-Kill Module:
    • Automatically kills specified farm animals
    • Collects drops into storage
    • Option to only target spawner-spawned mobs
Please check modules.yml for module permissions. Players cannot enable modules without permission if permission is required in modules.yml.

​
Economy Integration

​
Selling Resources

The selling system is designed to be intuitive with multiple options:
  1. Bulk Selling:
    • Use /farmer sellall command or click the “Sell Farmer’s Warehouse” button
    • Instantly sells all collected resources
    • Subject to cooldown (configurable in settings)
    • 25% tax is applied to all sales (configurable)
  2. Individual Material Selling:
    • Shift+Left-Click on a material in the main menu to sell all of that type
    • Earnings are based on configured unit prices
    • Prices can be customized for each material
  3. Sales Log:
    • All sales are recorded in the logs system
    • Records seller name, material type, quantity, and earnings

​
Troubleshooting

​
Common Issues and Solutions

ProblemSolution
Farmer not appearingCheck if the interaction hook plugin is installed and working
Can’t purchase farmerVerify you have enough money and are in a claimed area
Automation not workingEnsure the feature is enabled in settings and farmer has permission to access the area
Can’t sell resourcesCheck economy plugin configuration and ensure integration is working
Team members can’t accessVerify they have the correct rank and permissions

​
Debug Tips

If you encounter issues:
  1. Check the server console for error messages
  2. Ensure all dependent plugins are up-to-date
  3. Verify permissions are correctly set up
  4. Try reloading the plugin with /sfarmer reload

​
Support and Contact

For additional assistance with sFarmer configuration: