Configuration Overview
NobleSteeds creates plugins/NobleSteeds/config.yml on first startup. The
bundled file uses config-version: 1 and includes comments explaining each
supported setting. Stop the server and make a timestamped backup before editing a
production configuration.
plugins/NobleSteeds/config.yml
plugins/NobleSteeds/config.yml.bak-YYYYMMDD-HHMMSS
The top-level sections control:
- Default language and client-locale detection.
- YAML, SQLite, or MySQL storage.
- Breeding Quality, random names, claim limits, and storage capacity.
- Automatic mount snapshots and optional Citizens access.
- Player Market, item currency, administrator shop, calling, stables, and revival.
- Rarity ranges, weights, and tiers.
- The website-powered update checker and release channel.
Values are read during plugin startup and by the NobleSteeds-specific reload process.
Unknown enum values, malformed numbers, unavailable providers, or missing dependencies
can cause a setting to fall back, a feature to become unavailable, or startup to stop
with a protective error. Read the console after every configuration change.
Complete Default Config
This is the complete default config.yml bundled with NobleSteeds 1.0.0,
including every comment and default value. Copy only the settings you intend to
change, or compare this block with the generated file after an update.
# ============================================================
# NobleSteeds Configuration
# ============================================================
#
# NobleSteeds is a mount management plugin with claiming,
# storage, rarity, breeding quality, stable management, sharing,
# revive/release tools, item currency, MailboxGUI payouts,
# market, shop, and optional Citizens NPC access.
#
# Storage note:
# - SQLITE is recommended for normal single-server installs.
# - MYSQL is available for servers that prefer database storage.
# - YAML is available for simple flat-file setups.
#
# Economy note:
# Vault is optional for the plugin overall.
# Market, Shop, and paid revive features require Vault unless
# the feature is disabled or using item-currency where supported.
#
# Citizens note:
# Citizens is optional. NPC features only work when Citizens is
# installed and the matching NPC setting is enabled.
#
# MailboxGUI note:
# MailboxGUI is optional. If MailboxGUI payout settings are enabled
# but MailboxGUI is not detected, NobleSteeds disables those settings
# safely and falls back to normal payout behavior.
#
# ============================================================
config-version: 1
# ============================================================
# Locale / Language
# ============================================================
locale:
# Default language code.
#
# This decides which language file is used when player locale
# detection is disabled or when a player's client language is
# not supported by NobleSteeds.
#
# Example:
# en = language/messages_en.yml
default: en
# If true, NobleSteeds tries to use each player's Minecraft
# client language.
#
# If false, all players use locale.default.
auto-detect-player-locale: true
# ============================================================
# Storage
# ============================================================
storage:
# Main storage provider.
#
# YAML:
# Stores data in flat YAML files under the configured folder.
#
# SQLITE:
# Recommended default for single-server installs.
# Stores data in a local SQLite database file.
#
# MYSQL:
# Stores data in a MySQL/MariaDB database.
type: "SQLITE"
yaml:
# Folder used when storage.type is YAML.
folder: "data/yaml"
sqlite:
# SQLite database file used when storage.type is SQLITE.
file: "data/data.sql"
mysql:
# MySQL/MariaDB connection settings used when storage.type is MYSQL.
host: "localhost"
port: 3306
database: "noblesteeds"
username: "root"
password: ""
use-ssl: false
# Prefix for NobleSteeds database tables.
#
# Useful if multiple plugins or multiple test installs share
# the same database.
table-prefix: "noblesteeds_"
# ============================================================
# Breeding Quality
# ============================================================
breeding-quality:
# Enables NobleSteeds Breeding Quality.
#
# Breeding Quality is separate from rarity.
# It does not directly affect rarity score.
# It is used to improve breeding outcomes by nudging child
# vanilla stats upward.
enabled: true
generated-range:
# Random Breeding Quality range for newly claimed/generated mounts.
min: 0.0
max: 100.0
offspring:
# How much the parents' average Breeding Quality influences
# the child's Breeding Quality.
#
# 70.0 means:
# - 70% inherited from parents
# - 30% random from generated-range
inheritance-weight: 70.0
# Chance and amount for an extra Breeding Quality bonus.
high-quality-bonus-chance: 10.0
high-quality-bonus-amount: 10.0
outcome-boost:
# If enabled, high parent Breeding Quality can improve the
# child's vanilla speed, jump, and health outcomes.
enabled: true
# If an unclaimed valid parent is bred, this value is used
# for that parent's Breeding Quality.
#
# Claimed NobleSteeds mounts use their saved Breeding Quality.
unclaimed-parent-quality: 0.0
# At 100% average parent Breeding Quality, child stats move
# this percent of the remaining distance toward the configured
# max stat range.
#
# Example:
# 20.0 means up to 20% closer to max speed/jump/health.
max-stat-boost-percent: 20.0
# ============================================================
# Random Mount Names
# ============================================================
random-mount-names:
# If enabled, newly claimed unnamed mounts can receive a random
# NobleSteeds display name.
enabled: true
# Names used by the random name system.
names:
- "Aurelius"
- "Silvermane"
- "Stormcrest"
- "Emberhoof"
- "Starfall"
- "Ironstride"
- "Moonwhisper"
- "Goldenvalor"
- "Shadowglen"
- "Nobleheart"
# ============================================================
# Claim Limits
# ============================================================
claim-limits:
# Default number of active claimed mounts each player can have.
#
# Permission nodes can override this per player:
# noblesteeds.claims.10
# noblesteeds.claims.15
# noblesteeds.claims.20
#
# If a player has multiple noblesteeds.claims.<number> permissions,
# NobleSteeds uses the highest number.
default: 7
# ============================================================
# Horse Storage
# ============================================================
horse-storage:
# Enables the player mount storage system.
enabled: true
# Enables /ns storage.
command-enabled: true
# Enables storage access through the player mount management GUI.
manage-button-enabled: true
# Number of stored mount slots available to each player.
slots: 10
# ============================================================
# Mount Auto Save
# ============================================================
mount-auto-save:
# Periodically refreshes loaded claimed mounts so saddle, armor,
# chest inventory, custom Bukkit item metadata, variant, stats,
# name, and location stay current.
enabled: true
# Auto-save interval in minutes.
#
# Minimum recommended value is 2.
interval-minutes: 5
# ============================================================
# Storage NPC
# ============================================================
storage-npc:
citizens:
# Optional Citizens NPC support for opening /ns storage.
#
# Requires Citizens.
enabled: false
# ============================================================
# Player Market
# ============================================================
market:
# Enables the player mount market.
enabled: true
# Requires Vault and a Vault-compatible economy plugin for
# normal money-based market use.
require-economy: true
# Enables /ns market.
command-enabled: true
npc:
# Optional Citizens NPC support for opening /ns market.
#
# Requires Citizens.
enabled: false
# Market listing expiration in hours.
#
# 0 = listings never expire.
# Example: 72 = listings expire after 72 hours.
listing-expiration-hours: 0
# Vault money price limits for market listings.
min-price: 1.0
max-price: 100000000.0
default-price: 1000.0
send-mailboxgui-money:
# If enabled, money payouts from player market sales are sent
# through MailboxGUI money mail instead of being deposited
# directly through Vault.
#
# If MailboxGUI is missing or unavailable, NobleSteeds disables
# this safely and falls back to Vault payouts.
enabled: false
# Sender display name shown in MailboxGUI money mail.
from: "&a&lNobleSteeds Market Payout"
# Delivery delay in seconds.
#
# 0 = deliver immediately.
delay: 0
# ============================================================
# Item Currency
# ============================================================
item-currency:
# Enables item-currency pricing for supported systems.
#
# Market:
# Players can list mounts using item prices.
#
# Shop:
# Admins can create shop entries using item prices.
#
# Supported format:
# Diamond:3
# Diamond:3,Emerald:2,Gold_Nugget:2
#
# Up to 3 item entries are supported.
enabled: false
# If true, item-currency market payouts are sent through
# MailboxGUI package mail.
#
# If false, sellers claim item payouts through:
# /ns market receive
#
# If MailboxGUI is missing or unavailable, NobleSteeds disables
# this safely and falls back to /ns market receive.
send-mailboxgui-package: false
mailboxgui-package:
# Sender display name shown in MailboxGUI package mail.
from: "&a&lNobleSteeds Market Payout"
# Delivery delay in seconds.
#
# 0 = deliver immediately.
delay: 0
# ============================================================
# Admin Shop
# ============================================================
shop:
# Enables the admin-created NobleSteeds shop.
#
# This is separate from the player market.
# Players buy shop mounts from /ns shop.
# Admins manage shop entries from /ns admin shop and admin tools.
enabled: true
# Enables /ns shop.
command-enabled: true
npc:
# Optional Citizens NPC support for opening /ns shop.
#
# Requires Citizens.
enabled: false
# Requires Vault and a Vault-compatible economy plugin for
# normal money-based shop purchases.
require-economy: true
# Vault money price limits for shop entries.
min-price: 1.0
max-price: 100000000.0
default-price: 1000.0
# ============================================================
# Horse Management
# ============================================================
horse-management:
# Cooldown between player mount calls in seconds.
#
# Calling a mount may need to load the mount's last known chunk,
# find and remove the old entity, load the destination chunk,
# teleport/spawn the mount, and save the updated location.
#
# Paper can load chunks asynchronously, but its API does not
# guarantee an exact completion time. 4 seconds gives the prior
# mount call time to finish cleanup before the same player starts
# another call.
summon-cooldown-seconds: 4.0
auto-stable:
# Enables auto-stable on logout.
#
# Disabled by default. When enabled, players can toggle
# auto-stable per mount from /ns stable auto or the manage GUI.
#
# Large servers should use this carefully. On logout,
# NobleSteeds may load each enabled mount's last known chunk and
# its stable chunk to safely move the entity. This is queued one
# mount at a time, but busy servers with many players logging out
# can still see periodic chunk loads and extra RAM use while those
# chunks are active.
enabled: false
# Delay between queued auto-stable mounts for the same player.
#
# 20 ticks = 1 second.
#
# The default value is recommended for most servers. Lower values
# can make logout processing busier because NobleSteeds may load
# chunks for each auto-stabled mount more quickly.
#
# Be especially careful if you give VIP or donor ranks high
# noblesteeds.claims.* limits such as noblesteeds.claims.15 or
# noblesteeds.claims.20. More claimed mounts means one logout can
# queue more chunk loads, entity checks, teleports, and saves.
queue-delay-ticks: 20
rename:
# Maximum length for mount rename input.
max-length: 32
revive:
# Enables the Revive Horse button.
#
# Revive creates a replacement mount using the saved vanilla
# stat snapshot from the dead mount profile.
enabled: true
cost:
# If enabled, reviving a mount requires Vault money.
#
# Disabled by default.
enabled: false
# Base revive price before rarity and score scaling.
base-price: 1000.0
# How strongly the mount's 0-100 overall rarity score affects
# revive price.
#
# 0.0 = score does not affect cost.
# 1.0 = score adds up to +100% cost.
# 2.0 = score adds up to +200% cost.
score-scale: 1.0
# Optional hard limits after revive cost calculation.
min-price: 1.0
max-price: 100000000.0
# Rarity multipliers applied to revive cost.
rarity-multipliers:
common: 1.0
uncommon: 1.15
rare: 1.35
epic: 1.75
legendary: 2.25
mythic: 3.0
# ============================================================
# Rarity
# ============================================================
rarity:
# Enables rarity calculation from vanilla mount stats.
enabled: true
# Vanilla horse stat ranges used to convert raw values into
# 0-100 ratings.
#
# These are based around normal Minecraft horse ranges.
stat-ranges:
speed:
min: 0.1125
max: 0.3375
jump:
min: 0.4
max: 1.0
health:
min: 15.0
max: 30.0
# Overall score weighting.
#
# The weights determine how much each stat contributes to the
# final rarity score.
weights:
speed: 40.0
jump: 35.0
health: 25.0
# Rarity tiers.
#
# The highest matching min-score becomes the mount's rarity.
tiers:
common:
display-name: "&7Common"
min-score: 0.0
uncommon:
display-name: "&aUncommon"
min-score: 21.0
rare:
display-name: "&9Rare"
min-score: 41.0
epic:
display-name: "&5Epic"
min-score: 61.0
legendary:
display-name: "&6Legendary"
min-score: 81.0
mythic:
display-name: "&dMythic"
min-score: 95.0
# ============================================================
# Updates
# ============================================================
updates:
# Website-powered update checker.
#
# No license key is required.
enabled: true
# Checks for updates during plugin startup.
check-on-startup: true
# Notifies admins when they join if an update is available.
notify-admins-on-join: true
# Permission required to receive update notifications.
notify-permission: "noblesteeds.admin"
# Release channel passed to the website update system.
channel: "release"
Safe Configuration Changes
- Stop the server completely for storage, database, file-path, or provider changes.
- Create a timestamped copy of
plugins/NobleSteeds/config.yml and back up the complete plugins/NobleSteeds/data directory or database. - Edit YAML with spaces, preserve indentation, and keep text containing formatting codes or punctuation quoted where the default file does.
- Do not change
config-version manually. - Use
/ns admin storage convert for provider migration instead of changing storage.type and copying records by hand. - Start the server and check the full startup log for YAML, storage, economy, Citizens, MailboxGUI, and update-system warnings.
- Test claiming, management, storage, and any enabled economy or NPC feature with a non-administrator account.
For ordinary non-storage settings, /ns admin reload reloads NobleSteeds.
A clean restart is still safer after dependency, database, or structural changes. Do
not use the server-wide /reload command as a substitute.
Never expose storage.mysql.password in logs, support messages, public posts, or shared configuration copies. Replace credentials immediately if they are disclosed.