TribeCraft Wiki · Release 2026.09.5
Wiki Release: 2026.09.5 · UltimateClans: 9.1.4 · Documentation branch: 9 · ClanFarmCoins

ClanFarmCoins#

ClanFarmCoins adds configurable coin drops/rewards from gameplay sources such as blocks, mobs, fishing and player-related actions, with clan/permission filters. The pages in this section explain what players see in-game, what administrators need to configure, the normal setup flow, and the most common problems you may need to diagnose.

Compatibility#

  • Component version: 3.10.1
  • Documentation release: 2026.09.5
  • Minimum UltimateClans version: 9.0.0

What you can do with it#

  • Enable only the farm sources you want in config.yml/coins.yml
  • Set eligible blocks/entities/actions and reward values/chances
  • Test with a non-creative player in an allowed world/region and, if required, inside a clan
  • Verify pickup/save behavior and clan role permissions

How it works#

What ClanFarmCoins actually does#

ClanFarmCoins is an automatic gameplay reward system; players do not need a dedicated FarmCoins command to earn rewards. The addon listens to supported gameplay actions and, when a configured coin definition matches, rolls that coin's chance and value.

A coin definition can react to four practical sources:

  • Mob kills through the mobs whitelist.
  • Mining / block breaking through the miner whitelist. The addon also checks claim/region build permission before rewarding a block break.
  • Fishing through the fishing whitelist.
  • Player combat through the players relationship list (MEMBER, ALLY, RIVAL, NEUTRAL). PvP and region PvP checks are respected before a combat reward is considered.

Each definition in coins.yml then decides what the reward means and how the player receives it. type accepts the implemented reward types POINT, MONEYBANK and LEAGUEPOINT; coin selects VIRTUAL or PHYSICAL. A physical coin is represented by the configured item/icon and can display its rarity/value in the world. A virtual coin applies the reward without leaving a collectible item.

Example: create a mining clan-point coin#

  1. Copy an existing entry under Coins.list and give it a unique ID, for example mining_point.
  2. Set type: POINT and choose coin: PHYSICAL or VIRTUAL.
  3. Set chance, min_value and max_value.
  4. Put the allowed blocks under miner, for example IRON_ORE and DIAMOND_ORE.
  5. Leave mobs, fishing and players empty if that coin should only come from mining.
  6. Optionally restrict the definition using permission, enabled_worlds, enabled_regions, chance_per_level or chance_per_role.
  7. Restart/reload according to the addon workflow and test with a non-creative clan member in an allowed location.

Physical coin flow#

When a physical coin is created, the addon stores its coin ID/value in item data. If Config.Farm.use_customname is enabled, the dropped entity receives the configured display name with {rarity} and {amount} resolved. Pickup and interaction listeners then enforce the FarmCoins role permissions and save/apply the reward.

Anti-farm and eligibility checks#

Config.Farm.only_with_clan can require membership in a clan. disable_creative blocks Creative-mode earning. disabled_worlds and disabled_regions exclude locations. The block-following settings are intended to avoid rewarding blocks that should be treated as player-placed/reused farming sources. Clan role permissions coin_pickup, coin_save and coin_drop let administrators control the three main actions separately.

First setup#

Before enabling the feature for players, review these installed files:

  • coins.yml
  • config.yml
  • language/Lang_EN.yml
  • polymart.yml
  1. Enable only the farm sources you want in config.yml/coins.yml.
  2. Set eligible blocks/entities/actions and reward values/chances.
  3. Test with a non-creative player in an allowed world/region and, if required, inside a clan.
  4. Verify pickup/save behavior and clan role permissions.

This feature is mainly automatic or accessed through the parent plugin/GUI, so it does not need a large standalone command tree.

What administrators should configure#

  • Use placed-block tracking rules to prevent farming loops if enabled.
  • Keep creative/world/region exclusions explicit.
  • Test custom item/name formatting separately from reward accounting.

Configuration map#

  • config.ymlConfig (Farm, Permissions)
  • coins.ymlCoins (list)

The Configuration page lists the available paths and defaults from the installed configuration, with notes on what each area controls.

Before going live#

  1. Back up the component data/configuration.
  2. Start the server and confirm the component is detected without startup errors.
  3. Test with a non-OP player and the lowest clan role that should have access.
  4. Exercise the complete flow once, including the failure/deny path, not only the happy path.
  5. Restart the server and verify that persistent state survives.
  6. If the network is multiserver, repeat the test from a second node and verify storage/synchronization.

Troubleshooting quick reference#

SymptomLikely causeWhat to check
No coins dropSource not configured, creative mode, disabled world/region, player not in clan, or role permission blocks itCheck the exact source and all filters using a normal player account.
Placed blocks can be farmed repeatedlyPlaced-block follow/prevention rule is disabled or storage was resetEnable the intended tracking rule and preserve its data.
Coin item drops but cannot be picked upPickup permission/filter or custom item identity does not matchCheck role pickup permission and item configuration.
Rewards are too frequentChance/amount/source list is too broadReduce one source at a time and retest statistically.

For a longer diagnostic flow, open the Troubleshooting page for this component.