Configuration
Everything is in plugins/BerryHomes/config.yml, with a comment on every setting. /ahome reload applies changes (command names and permission nodes need a restart). This page covers what each section is for.
Server and storage
server-name: survival
storage:
type: sqlite # sqlite, mysql, mariadb or mongodb
table-prefix: bh_
One server: leave it on sqlite. A network: see cross-server and storage.
Homes
homes:
default-name: home # /sethome with no name
slot-name: home<number> # homes made by clicking an empty slot
name-pattern: '[A-Za-z0-9_-]{1,16}'
blocked-names: [help, rename, list, confirm, desc]
max-display-name-length: 24 # fancy names, visible letters only
max-description-length: 48
home-with-several: menu # menu, default or first
menu-style: slots # slots or list
over-limit: lock # lock or keep
confirm-delete: true
home-with-severaldecides what a bare/homedoes once a player has more than one home: open themenu, go to thedefaulthome (default-name), or go to home number 1 (first).menu-style:slotsshows numbered slots with locked ones above the limit;listshows every home on pages you can sort. Both menus are always there; this picks which one/homesopens.over-limit: when a player has more homes than their limit (they lost a rank),lockkeeps the extra homes but makes them unusable until the limit allows them again;keepleaves them usable and only stops new ones.
Limits
limits:
default: 3
max-slots: 10
permission-prefix: berryhomes.limit.
ranks:
vip: 5
mvp: 10
home-limits: [] # "name:permission:amount", if you're coming from another plugin
per-world: {} # e.g. world_nether: 2
per-server: {} # e.g. lobby: 1
Players get the highest limit they have permission for. max-slots is how many slots the slots menu shows (locked ones included), and what berryhomes.limit.unlimited gives. per-world and per-server cap how many of a player's homes can be in one world or on one server, on top of their limit.
Teleporting
teleport:
warmup: 3
cooldown: 5
cancel-on-move: true
move-tolerance: 0.5
cancel-on-damage: true
rank-warmups: { vip: 1 }
rank-cooldowns: { vip: 0 }
safety-check: true
unsafe-action: confirm # confirm, refuse or ignore
disabled-worlds: []
after-teleport: []
- The warmup cancels if the player moves more than
move-toleranceblocks or takes damage. Cooldowns are saved across restarts. - Safety check: before teleporting, BerryHomes checks the home isn't lava, fire, in the air over a drop, or inside blocks.
confirmasks "teleport anyway?",refusesays no,ignoreskips the check. after-teleportruns actions once the player lands, e.g.:
after-teleport:
- "[sound] ENTITY_ENDERMAN_TELEPORT 1 1"
- "[effect] SPEED 5 1" # effect, seconds, level (0 = I)
- "[console] say <player> went home"
Setting homes
sethome:
disabled-worlds: []
disabled-servers: []
block-in-claims: true
With block-in-claims, players can't set a home inside someone else's WorldGuard region, GriefPrevention claim or Lands land (their own and ones they're trusted in are fine).
Respawn at home
respawn-at-home:
enabled: false
home: home
first-fallback: true
only-without-bed: true
Sends players to a home when they die. Only homes on the same server are used.
Costs
Needs Vault and an economy plugin.
economy:
enabled: false
sethome-cost: 0
sethome-cost-per-home: 0 # extra for each home they already have
teleport-cost: 0
cross-server-cost: -1 # -1 = same as teleport-cost
Teleports are only charged when they go through. If one fails (the home became unsafe, the other server is down), the money goes back. Cross-server teleports are charged once, on the server the player leaves.
Text input
text-input:
mode: anvil # anvil or chat
chat-timeout: 30
cancel-word: cancel
How players type names and descriptions from the menu. anvil opens an anvil to type in; chat asks them to type in chat.
Debug
debug: true logs more, and makes BerryHomes complain loudly if anything ever waits on the database from a tick thread. Leave it off normally.