Configuration
The configuration file for Nexal Homes. Located at plugins/Nexal Homes/config.yml.
# Nexal Homes Configuration
# Used by the plugin to update this file. Do not change it.
config-version: 2
# Default home limit (can be overridden with nexalhomes.limit.<N> permission)
default-home-limit: 3
# Default icon material for new homes
default-icon: RED_BED
# Default categories available to all players
default-categories:
- "General"
- "Farms"
- "Bases"
# Maximum custom categories a player can create
# (can be overridden with nexalhomes.categories.<N> permission)
max-custom-categories: 5
# Warmup delay in seconds before teleport (0 = instant)
warmup-delay: 3
# Cooldown between home teleports in seconds
cooldown: 10
# Whether taking damage cancels teleport warmup
warmup-cancel-on-damage: true
# Whether movement cancels teleport warmup
warmup-cancel-on-move: true
# Particle aura during teleport warmup
warmup-particles:
enabled: true
# Particle type, e.g. PORTAL, END_ROD, FLAME, SOUL_FIRE_FLAME, HEART, CLOUD,
# DRAGON_BREATH, GLOW, ELECTRIC_SPARK, NOTE (other particles that need no extra data work too)
type: PORTAL
# Number of particles per ring
count: 15
# Radius of the spiral around the player
radius: 0.8
# How fast the spiral rotates (ticks per update)
update-interval: 2
# Which worlds allow homes. Homes cannot be set in, or teleported to, the other worlds.
# blacklist: every world except the ones in disabled-worlds
# whitelist: only the worlds in enabled-worlds
world-mode: blacklist
# Worlds where homes cannot be set (blacklist mode)
disabled-worlds: []
# The only worlds where homes can be set (whitelist mode)
enabled-worlds: []
# Names worlds are shown with in messages and menus (%world%), by folder name.
# Worlds not listed here are shown with their folder name. Example:
# world-names:
# world: Overworld
# world_nether: Nether
# world_the_end: End
world-names: {}
# Whether cross-world teleporting is allowed
allow-cross-world: true
# Economy settings (requires Vault)
economy:
# Enable home economy costs
enabled: false
# Cost to set a new home
set-cost: 100.0
# Cost per teleport to a home
teleport-cost: 25.0
# Storage settings
storage:
# Storage type: json or sql. Changing it needs a server restart:
# /home admin reload does not switch storage.
type: json
# SQL settings (used when type is "sql")
sql:
host: localhost
port: 3306
database: minecraft
username: root
password: ""
Configuration Options
Below is a reference of the main configuration sections:
config-version
Nexal Homes Configuration
Used by the plugin to update this file. Do not change it.
default-home-limit
Default home limit (can be overridden with nexalhomes.limit.<N> permission)
default-icon
Default icon material for new homes
default-categories
Default categories available to all players
max-custom-categories
Maximum custom categories a player can create (can be overridden with nexalhomes.categories.<N> permission)
warmup-delay
Warmup delay in seconds before teleport (0 = instant)
cooldown
Cooldown between home teleports in seconds
warmup-cancel-on-damage
Whether taking damage cancels teleport warmup
warmup-cancel-on-move
Whether movement cancels teleport warmup
warmup-particles
Particle aura during teleport warmup
world-mode
Which worlds allow homes. Homes cannot be set in, or teleported to, the other worlds. blacklist: every world except the ones in disabled-worlds whitelist: only the worlds in enabled-worlds
disabled-worlds
Worlds where homes cannot be set (blacklist mode)
enabled-worlds
The only worlds where homes can be set (whitelist mode)
world-names
Names worlds are shown with in messages and menus (%world%), by folder name. Worlds not listed here are shown with their folder name. Example: world-names: world: Overworld world_nether: Nether world_the_end: End
allow-cross-world
Whether cross-world teleporting is allowed
economy
Economy settings (requires Vault)
storage
Storage settings