Members and Ranks

A farmer has one owner and any number of members, and each member holds a rank. The rank decides what they may do; the ranks themselves are yours to define.

Ranks

Ranks live in languages/<lang>/ranks.yml. Three ship by default:

Each rank lists only what it adds. A rank holds everything granted by every rank of lower weight, so a Leader can sell and upgrade without those permissions being repeated in its list.

farmer-ranks:
  leader:
    id: 2
    name: 'Leader'
    weight: 500
    permissions:
      - CHANGE_SKIN_NAME
      - MOVE_HERE
      - CHANGE_APPEARANCE
      - SEE_MODULE_SETTINGS
    show:
      material: 'PLAYER_HEAD'
      display-name: '<#39a7fc>Role'
      head-data: 'texture-...'
      lore: [...]
      slots: [12]

id must be unique, weight sets the order, and show is the item drawn in the member management menu — including the slot it occupies. Left-click promotes, right-click demotes, and the plugin walks the ranks in weight order.

Adding a fourth rank is a matter of adding a block with a weight between two existing ones and listing what it adds.

Rank permissions

Adding members

add-member:
  required-online: true
  input-type: SIGN
  chat-timeout: 15

adding-member-requires-permission: false

input-type is SIGN or CHAT. Sign input is the safer choice: it cannot be intercepted by a chat plugin and it does not leave the player in a state where their next message is swallowed. If you use CHAT, chat-timeout is how long the plugin waits before giving up.

adding-member-requires-permission: true additionally requires uxmfarmer.addmember, which is how you make member slots a rank perk.

Members from the region

By default the farmer follows the region:

add-new-region-members-to-farmer: true
remove-leaving-region-members-from-farmer: true
transfer-farmer-ownership-to-region-owner-on-leave: true

Someone trusted on the claim or added to the island becomes a farmer member automatically, and loses it when they leave. The third setting handles the awkward case: a farmer owner who is not the region owner and who leaves — the farmer goes to whoever owns the land rather than disappearing with them.

Turn all three off if farmer membership should be a separate thing players manage themselves.

Transferring and deleting

disable-transfer: true removes transfer entirely. Otherwise a player with ACCESS_MANAGE_MENU can hand the farmer to another player through a confirmation menu.

return-price-on-delete: true refunds the farmer's price when a farmer is deleted; /farmer return refunds return-percent of it — 75% by default — which is the one players use.

Logs

Every action on the farmer is logged and readable by anyone with SEE_LOGS. Logs are trimmed automatically:

log-cleaner:
  enabled: true
  clean-old-logs-after: 50
  logs-to-clean: 25

At 50 entries the oldest 25 are dropped. disable-logs: true in general-settings.yml switches logging off entirely, which is worth doing only if you have measured that it costs you something.