NobleSteeds Wiki

Getting Started

Wiki Version: NobleSteeds 1.0.0

Plugin Version: 1.0.0 · Java: 17 · API: Bukkit/Spigot 1.18.2 with api-version: 1.18

Soft dependencies: Vault, Citizens, and MailboxGUI. None is required for core mount claiming and management.

Screenshots are local website files. Missing images display a matching “Screenshot pending upload” card until they are added.

What NobleSteeds Does

NobleSteeds turns supported vanilla mounts into managed player mounts. Players can claim, inspect, call, favorite, rename, share, transfer, stable, store, revive, release, list, and purchase mounts. Server owners can configure rarity and breeding quality, run a player market and admin shop, choose YAML/SQLite/MySQL storage, register Citizens access NPCs, route market payouts through MailboxGUI, and use focused administration tools.

Compatibility and Requirements

Java 17 or newer and a Bukkit-compatible server providing the declared 1.18 API.
Core use requires no economy, NPC, mail, Redis, or proxy plugin.
Vault plus a compatible economy is required for configured money prices and paid revive.
Citizens is required only for Storage, Market, or Shop NPC entry points.
MailboxGUI is required only when its market payout options are enabled.

Installation

Stop the Minecraft server.
Place one NobleSteeds 1.0.0 JAR in plugins/.
Install optional dependencies before NobleSteeds when their features will be used.
Start the server and read the NobleSteeds startup summary.
Stop the server before the first substantial configuration or storage change.

First Startup

Confirm the active storage provider, language count, enabled feature states, and optional hook states in console. SQLite is the default and recommended local provider. Test claiming and /ns manage before enabling optional commerce or NPC entry points.

File Structure

plugins/NobleSteeds/
├── config.yml
├── language/
│   └── messages_<locale>.yml
└── data/
    ├── data.sql       # default SQLite file
    └── yaml/          # used only by YAML storage

MySQL stores plugin records in the configured database and table prefix instead of a local database file.

Quick Start Checklist

Tame and ride a supported adult mount.
Run /ns claim [name].
Open /ns manage and select the mount.
Set it as favorite, then test /ns call.
Review storage, market, shop, Citizens, and payout settings before exposing them to players.

Player Guide

Claiming a Mount

Ride a supported adult, tamed mount that is not owned by another vanilla player, then use /ns claim [name]. Supported types in source are horse, donkey, mule, llama, trader llama, skeleton horse, and zombie horse. Horse colors/styles and supported entity variants are retained. The default active claim limit is seven; numeric noblesteeds.claims.<amount> permissions override it.

Successful NobleSteeds mount claim — A successful claim assigns the mount an active slot, saved identity, name, rarity snapshot, and breeding quality.

My Horses and Mount Details

/ns manage or /ns myhorses opens the My Horses GUI. Each active slot can show mount type/variant, rarity, overall score, speed, jump, health, breeding quality, alive/stored/stable/shared/market state, and favorite status.

NobleSteeds My Horses menu — My Horses lists active mount slots and opens management for a selected mount.

NobleSteeds horse management menu — The management menu exposes only actions valid for the mount and current configuration.

Calling, Favorite, Rename, and Information

Call: /ns call [mount] summons a selected mount, or the favorite when omitted, after the configured cooldown.
Favorite: use the GUI or /ns set favorite <mount>.
Rename: use the GUI chat prompt or /ns rename <mount> <new name>; listed mounts cannot be renamed.
Info: ride a mount and run /ns info for type, variant, rarity, overall, speed, jump, health, and breeding-quality bars.

NobleSteeds mount information output — /ns info displays source-calculated rarity and vanilla stat ratings for the ridden mount.

Stable and Storage

A stable is a saved world location for an active mount: set, send, unset, and optionally auto-send on logout. Storage is different—it serializes the mount snapshot, removes the live entity, and frees an active slot. Restoring requires a free active slot. Storage defaults to 10 stored slots and can be opened by command, management button, or a configured Citizens NPC.

NobleSteeds stable controls — Stable controls reflect whether a location is set and whether auto-stable is enabled.

NobleSteeds storage menu — Storage contains serialized mounts that can be restored into a free active slot.

Sharing keeps ownership with the original player while allowing everyone or selected players to use a mount. Giving transfers ownership through a pending request: the owner uses /ns give, the online recipient opens /ns receive, and acceptance requires a free active slot. Listed or otherwise unavailable mounts cannot be transferred.

NobleSteeds sharing menu — Sharing supports private, everyone, and specific-player access.

NobleSteeds receive mounts menu — Pending transfer offers show the sender and mount before acceptance.

Revive and Release

When an owned mount dies, NobleSteeds keeps its saved profile marked dead. Revive creates a replacement from the saved vanilla snapshot; optional Vault pricing can scale by rarity and overall score. Release is permanent ownership removal behind a confirmation GUI. Released mount owner cleanup is handled separately by the plugin.

NobleSteeds revive confirmation — Revive shows confirmation and cost when paid revival is enabled.

NobleSteeds release confirmation menu — Release requires an explicit confirmation before ownership is removed.

Market and Shop

Player Market

The market supports browsing, listing active or stored mounts, choosing Vault or configured item-currency pricing, viewing personal listings, buying, unlisting, and optional expiration. Listed mounts are blocked from conflicting call, rename, give, and management operations. Vault money pricing honors configured minimum, maximum, and default values; item pricing supports up to three material/amount entries.

NobleSteeds market browse menu — Market Browse shows seller, price, rarity, breeding quality, and mount stats.

NobleSteeds market listing flow — The listing flow selects active or stored inventory, then the supported price type.

Market Payouts

Vault sale proceeds are deposited directly unless MailboxGUI money payout is enabled. Item-currency proceeds are claimed with /ns market receive or its GUI button unless MailboxGUI package payout is enabled. If MailboxGUI is missing, source code safely disables those routes and falls back to normal payout behavior.

Admin Shop

The shop is separate from the player market. Staff create fixed mount offers with variant, speed, jump, health, breeding quality, name, and Vault or item price. Players buy from /ns shop or a registered Shop NPC. Staff can manage entries in Admin Tools or with the exact admin commands below.

NobleSteeds player shop menu — The shop presents enabled administrator-created mount offers and their exact prices.

Rarity and Breeding

Rarity

Rarity converts vanilla speed, jump, and max health into 0–100 ratings, then applies configurable weights. Defaults are 40% speed, 35% jump, and 25% health. The highest matching threshold produces Common, Uncommon, Rare, Epic, Legendary, or Mythic. Display names, vanilla stat ranges, weights, and thresholds are configurable.

Breeding Quality

Breeding Quality is separate from rarity. New eligible mounts receive a configured 0–100 value. Offspring combine parent average quality with randomness, may receive a configured bonus, and can move vanilla offspring stats toward configured maximums. An unclaimed parent uses the configured fallback quality.

Admin Guide

Admin Tools Overview

/ns admin tools opens the central GUI for player mount inspection, claimed mounts, market moderation, shop management, NPC registration, storage status, and reload. Individual buttons remain subject to the matching feature and dependency state.

NobleSteeds Admin Tools menu — Admin Tools is the source-confirmed starting point for GUI administration.

Mount and Claim Tools

Staff can browse players and active/stored mounts, claim a targeted mount for a player through chat input, edit mount type/variant/stats through the GUI, unclaim with confirmation, spawn wild claimable mounts, edit the ridden mount, and clear stale NobleSteeds plus vanilla owner data from a ridden or targeted supported mount.

NobleSteeds admin player mounts menu — Player Mounts gives staff source-confirmed active and stored mount administration.

Storage Tools

Use /ns admin storage current to compare configured and active provider states. Conversion supports YAML, SQLite, and MySQL and reports validation/result details. Take an external backup before conversion; do not manually change storage.type halfway through a conversion.

Staff Workflow Example

Run /ns admin tools and inspect the affected player/mount.
Confirm whether the mount is active, stored, listed, dead, or pending transfer.
Use the narrowest GUI action or permission-specific command.
Use clearclaim only for stale claim/owner repair, not ordinary ownership changes.
After config changes, run /ns admin reload and re-test the affected flow.

Integrations

Vault Economy

Vault is optional globally. It is used when the player market or admin shop requires economy-backed prices, and when paid revival is enabled. Both Vault and a compatible economy provider must be available.

Citizens NPC Access

When Citizens is installed, staff can register NPCs for Storage, Market, or Shop access. Each type also requires its own config toggle and the player’s normal feature permission. NobleSteeds persists its NPC trait and provides registration/type/registered-NPC menus.

NobleSteeds Citizens NPC registration tools — NPC tools register Storage, Market, and Shop access only when Citizens and that feature are available.

MailboxGUI Payouts

Two optional routes exist: market Vault proceeds as MailboxGUI money mail, and item-currency proceeds as MailboxGUI package mail. Each has a sender display and delivery delay. Missing/unavailable MailboxGUI causes a safe fallback rather than blocking the market payout.

Network Scope

Network features are not included in NobleSteeds 1.0.0. The current source has no Redis client, network configuration, cross-backend messenger, distributed lock, presence system, or network admin command. MySQL is a storage provider only and does not create supported multi-backend coordination.

Configuration

config.yml Overview

The current file is config-version: 1. Its source-confirmed top-level modules are locale, storage, breeding-quality, random-mount-names, claim-limits, horse-storage, mount-auto-save, storage-npc, market, item-currency, shop, horse-management, rarity, and updates.

Storage and Locale

config-version: 1
locale:
  default: en
  auto-detect-player-locale: true
storage:
  type: "SQLITE"
  yaml:
    folder: "data/yaml"
  sqlite:
    file: "data/data.sql"
  mysql:
    host: "localhost"
    port: 3306
    database: "noblesteeds"
    username: "root"
    password: ""
    use-ssl: false
    table-prefix: "noblesteeds_"

Mount Systems

claim-limits:
  default: 7
horse-storage:
  enabled: true
  command-enabled: true
  manage-button-enabled: true
  slots: 10
mount-auto-save:
  enabled: true
  interval-minutes: 5
horse-management:
  summon-cooldown-seconds: 4.0
  auto-stable:
    enabled: false
    queue-delay-ticks: 20
  rename:
    max-length: 32
  revive:
    enabled: true
    cost:
      enabled: false
      base-price: 1000.0
      score-scale: 1.0
      min-price: 1.0
      max-price: 100000000.0

The same source file also contains the full breeding generated range/inheritance/bonus/outcome-boost settings and rarity stat ranges, weights, tier display names, and minimum scores.

Market, Shop, NPC, and Payout Toggles

storage-npc:
  citizens:
    enabled: false
market:
  enabled: true
  require-economy: true
  command-enabled: true
  npc:
    enabled: false
  listing-expiration-hours: 0
  min-price: 1.0
  max-price: 100000000.0
  default-price: 1000.0
  send-mailboxgui-money:
    enabled: false
    from: "&a&lNobleSteeds Market Payout"
    delay: 0
item-currency:
  enabled: false
  send-mailboxgui-package: false
shop:
  enabled: true
  command-enabled: true
  npc:
    enabled: false
  require-economy: true

Safe Editing Rules

Stop the server and back up plugins/NobleSteeds/ plus external MySQL data before storage changes.
Use spaces, preserve YAML indentation, and keep material names/permission nodes exact.
Do not paste network or Redis keys from an older wiki; they are not read by this source.
Use /ns admin reload for ordinary config/language changes; use a full restart for dependency or storage-driver changes.
Use the storage conversion command instead of copying provider files by hand.

Storage

Storage Providers

Provider	Location	Use
SQLite	`plugins/NobleSteeds/data/data.sql` by default	Recommended local/single-server default.
YAML	`plugins/NobleSteeds/data/yaml/` by default	Human-readable flat-file storage.
MySQL	Configured database and `noblesteeds_` table prefix by default	External database storage; not network coordination.

Conversion and Backups

Run /ns admin storage current, back up the active provider, run /ns admin storage convert <provider>, read the reported counts/errors, then change/restart only as directed by the command result. Retain the source backup until claims, stored mounts, shares, market listings, payouts, shop entries, and NPC registrations have been checked.

Commands

Command and Aliases

The only registered root command is /noblesteeds. Source-confirmed aliases are /ns, /steed, and /steeds. Commands remain gated by exact permissions, feature settings, dependencies, sender type, and mount state.

Player Commands

Command	Permission	Who	Description	Notes
`/noblesteeds`	`noblesteeds.command`	Player	Show player help page 1.	Aliases: /ns, /steed, /steeds.
`/ns help [1-3]`	`noblesteeds.command`	Player	Show a player help page.	Page is clamped to the available range.
`/ns manage`	`noblesteeds.manage`	Player	Open My Horses.	/ns myhorses is an accepted subcommand alias.
`/ns info`	`noblesteeds.info`	Player	Show rarity and stat bars for the mount being ridden.	Requires rarity to be enabled.
`/ns claim [name]`	`noblesteeds.claim`	Player	Claim the supported adult, tamed mount being ridden.	A random configured name can be used when no name is supplied.
`/ns call [mount]`	`noblesteeds.call`	Player	Call a selected mount or the favorite mount.	Subject to the summon cooldown and mount state.
`/ns set favorite <mount>`	`noblesteeds.favorite`	Player	Set an owned mount as favorite.	Mount can be selected by slot/ID or name.
`/ns give <mount> <onlinePlayer>`	`noblesteeds.give`	Player	Send an online player a mount transfer request.	The recipient reviews it with /ns receive.
`/ns receive`	`noblesteeds.receive`	Player	Open pending mount transfers.	Accepting requires a free active slot.
`/ns rename <mount> <new name>`	`noblesteeds.rename`	Player	Rename an owned mount.	Maximum length is configurable.
`/ns revive <mount>`	`noblesteeds.revive`	Player	Prepare revival of a dead owned mount.	May calculate a Vault cost when enabled.
`/ns revive confirm`	`noblesteeds.revive`	Player	Confirm the pending revival.	Uses the saved vanilla mount snapshot.
`/ns stable set <mount>`	`noblesteeds.stable`	Player	Set the current position as the mount stable.	The selected mount must be eligible.
`/ns stable send <mount>`	`noblesteeds.stable`	Player	Send a mount to its saved stable.	The mount must be alive, loaded, and have a stable.
`/ns stable unset <mount>`	`noblesteeds.stable`	Player	Remove a mount stable location.	Does not release the mount.
`/ns stable auto <mount> <on\|off>`	`noblesteeds.stable`	Player	Toggle auto-stable on logout.	The global auto-stable setting must be enabled.
`/ns storage`	`noblesteeds.storage`	Player	Open mount storage.	Requires storage and command access to be enabled.
`/ns market`	`noblesteeds.market`	Player	Open the player mount market.	Requires the market and command access to be enabled.
`/ns market receive`	`noblesteeds.market`	Player	Claim pending item-currency market payouts.	The misspelling “recieve” is also accepted by source for compatibility.
`/ns shop`	`noblesteeds.shop`	Player	Open the admin-created mount shop.	Requires the shop and command access to be enabled.

Administrator Commands

Command	Permission	Who	Description	Notes
`/ns admin`	`Any NobleSteeds admin node`	Staff	Show admin help page 1.	The parent node noblesteeds.admin grants all admin capabilities.
`/ns admin help [1-4]`	`Any NobleSteeds admin node`	Staff	Show an admin help page.	Only permitted feature entries are shown.
`/ns admin tools`	`noblesteeds.admin.tools`	In-game staff	Open the Admin Tools GUI.	Player-only.
`/ns admin storage`	`noblesteeds.admin.storage`	Staff/console	Show storage command usage.	Read-only help output.
`/ns admin storage current`	`noblesteeds.admin.storage`	Staff/console	Show configured and active providers.	Use before and after conversion.
`/ns admin storage convert <YAML\|SQLITE\|MYSQL>`	`noblesteeds.admin.storage`	Staff/console	Convert stored plugin data.	Back up first and verify the result before changing config.
`/ns admin shop [help]`	`noblesteeds.admin.shop`	Staff/console	Show shop management commands.	Shop must be available.
`/ns admin shop list`	`noblesteeds.admin.shop`	Staff/console	List configured shop entries.	Shows short/full IDs and entry state.
`/ns admin shop add --v <variant> --s <speed%> --j <jump%> --h <health%> --b <quality%> --price <price\|Item:Amount> --name <name>`	`noblesteeds.admin.shop`	Staff/console	Create a shop mount.	Item prices require item currency.
`/ns admin shop remove <shopId>`	`noblesteeds.admin.shop`	Staff/console	Remove a shop entry.	Accepts the source-supported entry identifier.
`/ns admin spawn [--v <variant>] [--s <speed%>] [--j <jump%>] [--h <health%>] [--b <quality%>]`	`noblesteeds.admin.spawn`	In-game staff	Spawn a wild claimable mount.	No tags creates a random horse with random stats.
`/ns admin edit [--v <variant>] [--s <speed%>] [--j <jump%>] [--h <health%>] [--b <quality%>]`	`noblesteeds.admin.edit`	In-game staff	Edit the mount being ridden.	Entity type changes must use the GUI.
`/ns admin clearclaim`	`noblesteeds.admin.clearclaim`	In-game staff	Clear stale claim/vanilla owner data.	Targets the ridden mount or a supported mount in view.
`/ns admin updatecheck`	`noblesteeds.admin.update`	Staff/console	Check the website release endpoint.	Does not install an update.
`/ns admin update`	`noblesteeds.admin.update`	Staff/console	Prepare an available update.	Follow the plugin response.
`/ns admin update confirm`	`noblesteeds.admin.update`	Staff/console	Confirm a prepared update.	Only after preparation.
`/ns admin reload`	`noblesteeds.admin.reload`	Staff/console	Reload NobleSteeds.	Reloads config/languages and rebuilds current managers/hooks.

Permissions

Player Permissions

Node	Default	Recommended Group	Used For
`noblesteeds.command`	true	All players	Use the base command and help.
`noblesteeds.player`	false	Player parent	Grants all normal player permissions listed below.
`noblesteeds.manage`	true	All players	Open My Horses.
`noblesteeds.storage`	true	All players	Use mount storage by command/menu/NPC when enabled.
`noblesteeds.info`	true	All players	View mounted horse rarity and stats.
`noblesteeds.claim`	true	All players	Claim supported mounts.
`noblesteeds.claims.*`	false	Rank override	Pattern for numeric limits such as noblesteeds.claims.10; highest value wins.
`noblesteeds.call`	true	All players	Call owned mounts.
`noblesteeds.give`	true	All players	Send transfer requests.
`noblesteeds.receive`	true	All players	Review and accept transfers.
`noblesteeds.rename`	true	All players	Rename owned mounts.
`noblesteeds.favorite`	true	All players	Choose a favorite mount.
`noblesteeds.stable`	true	All players	Set/send/unset stable and toggle auto-stable.
`noblesteeds.revive`	true	All players	Revive dead owned mounts when enabled.
`noblesteeds.market`	true	All players	Use the player market and configured market NPC.
`noblesteeds.shop`	true	All players	Use the shop and configured shop NPC.

Admin Permissions

Node	Default	Used For
`noblesteeds.admin`	op	Admin parent; grants every admin child below.
`noblesteeds.admin.tools`	op	Open and use Admin Tools.
`noblesteeds.admin.storage`	op	Inspect and convert storage.
`noblesteeds.admin.update`	op	Check, stage, and confirm updates.
`noblesteeds.admin.reload`	op	Reload NobleSteeds.
`noblesteeds.admin.spawn`	op	Spawn custom or random mounts.
`noblesteeds.admin.edit`	op	Edit vanilla stats on the ridden mount.
`noblesteeds.admin.clearclaim`	op	Clear stale claim data.
`noblesteeds.admin.shop`	op	Manage shop entries.

Recommended Permission Groups

Keep the source defaults for normal players, or grant noblesteeds.player as an explicit player parent. Add only numeric noblesteeds.claims.<amount> nodes to rank tiers. Grant staff the individual admin children needed for their role; reserve noblesteeds.admin for trusted administrators.

Language Files

Included Languages

The current source bundles de, en, es, fr, it, ja, ko, nl, pl, ru, sv, uk, zh_cn, zh_tw. Files are generated as plugins/NobleSteeds/language/messages_<code>.yml. Client locale detection can select a supported file, with locale.default as fallback.

Editing Language Files

Stop or reload safely, back up the file, preserve YAML indentation and every %placeholder%, then use /ns admin reload. If a locale is unsupported, NobleSteeds falls back to the configured default. Do not use screenshots to document language YAML.

Troubleshooting

Quick Checks

Read startup for the active provider and optional hook states.
Check the exact permission, feature toggle, and command toggle.
Confirm the mount is supported, adult, tamed, and in the required state.
Check whether it is dead, stored, listed, shared, or pending transfer.
Validate YAML before reloading.

Feature Problems

Market or shop says economy unavailable

Install Vault and a compatible economy, or configure a supported item-currency flow where applicable. Confirm the feature and command toggles.

Citizens NPC does not open a menu

Confirm Citizens loaded, the NPC type is registered, its type toggle is enabled, the underlying feature is available, and the player has the normal storage/market/shop permission.

MailboxGUI payout is not used

Confirm the exact payout setting and MailboxGUI availability. The source intentionally falls back to direct Vault payout or /ns market receive when the hook is unavailable.

Call, rename, or give is blocked

Check whether the mount is listed, dead, stored, already active at another state, or subject to the call cooldown.

Storage Problems

A stored mount will not restore

The player needs an empty active claim slot. Check claim limits, provider errors, and whether the stored snapshot remains present.

Provider conversion fails

Keep the source backup, verify destination path/credentials and permissions, and read conversion validation output. Do not delete the original provider or switch config mid-failure.

MySQL works but cross-server behavior does not

This is expected. MySQL is persistence only; current NobleSteeds has no Redis or coordinated network mode.

FAQ

Does NobleSteeds require Vault?

No. Core mount features work without it. Configured Vault prices and paid revive require Vault plus an economy.

Can MySQL make NobleSteeds network-ready?

No. MySQL is an available storage provider, but this version has no cross-backend coordination.

What is the difference between stable and storage?

A stable is a saved location for a live active mount. Storage serializes and removes the entity, freeing an active claim slot.

Can players use another player’s mount?

Yes, when the owner enables everyone sharing or adds that player to the mount’s specific share list.

Are market and shop the same?

No. The market contains player listings and payouts. The shop contains fixed administrator-created offers.

Where are screenshots stored?

Website screenshots are local files under public/images/wiki/noblesteeds/1.0.0/ and load publicly from /images/wiki/noblesteeds/1.0.0/. Missing files remain styled placeholders.