NobleSteeds documentation

NobleSteeds Wiki

NobleSteeds includes the Free mount ownership workflow and adds network mode, Redis/MySQL coordination, cross-backend safety, player market, admin shop, Citizens NPC access, Vault economy support, item-currency payouts, and optional MailboxGUI delivery.

NobleSteeds Wiki banner

Wiki sections

Pro Overview

Wiki Version: NobleSteeds 1.0.0-b Pro

This page is based on the bundled NobleSteeds 1.0.0-b plugin.yml, config.yml, network/config.yml, and English language file. The Free and Pro JARs found in the website project are byte-identical resource bundles, so this page documents the Pro systems visible in those shared resources and keeps Free-only documentation separate.

Pro is for servers that need more than local mount claiming.

Use Pro for Velocity-style backend networks, Redis coordination, shared MySQL storage, market listings, admin-created shop mounts, Citizens NPC access points, and advanced admin diagnostics.

Upgrading from Free

  1. Stop the server and back up plugins/NobleSteeds/.
  2. Back up the database if using SQLite or MySQL.
  3. Install the Pro JAR in place of the Free JAR.
  4. Start once to verify config and language files.
  5. Enable Pro systems intentionally. Do not enable network mode, market, shop, or NPCs until dependencies are ready.
  6. Test with staff accounts before opening player access.
Storage conversion and network mode are operational changes. Treat them like database migrations: back up first, test on staging, then roll out during maintenance.

Installation

  • Plugin name: NobleSteeds.
  • Version inspected: 1.0.0-b.
  • Bukkit API version declared by the JAR: 1.18.
  • Soft dependencies declared by the JAR: Vault, Citizens, and MailboxGUI.
  • Network settings live in plugins/NobleSteeds/network/config.yml.

Dependency Planning

  • Vault plus an economy plugin is required for normal money-based market/shop use.
  • Citizens is required for Storage, Market, and Shop NPC access points.
  • MailboxGUI is optional for money mail and package payout delivery.
  • Redis and MySQL/MariaDB are required for network mode.

Network Setup

Network mode coordinates NobleSteeds across backend servers behind a proxy. The bundled network config says normal single-server installs should leave network mode disabled.

network:
  enabled: false
  mode: "STANDALONE"
  server-id: "default"
  operation-timeout-millis: 250

Redis Setup

Redis is used for backend-to-backend coordination. Configure host, port, optional username/password, SSL, timeout, and the network-calls channel in network/config.yml. Keep Redis private to your server network and use credentials when it is not local-only.

MySQL / Storage Setup

Network mode expects MySQL/MariaDB in the main config.yml. The same database and table prefix should be used by each backend in the same NobleSteeds network.

Server IDs and Backends

Every backend needs a unique network.server-id. This ID is used for stable location routing, cross-backend mount safety, market payout routing, MailboxGUI payout routing, and loaded mount ownership checks.

Network Diagnostics

Use /ns admin network to view readiness, mode, server ID, storage requirement, Redis host/channel, messenger status, spawn safety manager, give/trade manager, timeout, coverage checks, and config file path.

Cross-Backend Safety

Pro network safety protects against duplicate mount spawning and remote loaded-mount conflicts. When one backend needs to call, restore, transfer, or sell a mount, Redis coordination allows other backends to save/despawn or refresh state first.

Market

Market Setup

The bundled config enables the market by default, requires economy by default, enables /ns market, supports optional Market NPC access, and defines listing expiration plus min/default/max price limits.

market:
  enabled: true
  require-economy: true
  command-enabled: true
  listing-expiration-hours: 0
  min-price: 1.0
  default-price: 1000.0

Player Market

Players with noblesteeds.market can open the market, browse listings, list an active or stored owned mount, choose a money or item-currency price where enabled, view their listings, remove listings, buy eligible listings, and claim item-currency payouts with /ns market receive.

Admin Market Management

Admin tools include market listing review and removal. The language bundle includes stale owner checks so staff can identify listings where the seller no longer matches the saved mount owner.

Market Payouts

Money payouts normally use Vault. The config can send money sale payouts through MailboxGUI money mail, and item-currency payouts can be delivered through MailboxGUI package mail when enabled. If MailboxGUI is unavailable, NobleSteeds safely falls back to normal payout behavior.

Shop

Shop Setup

The admin-created shop is separate from the player market. The bundled config enables the shop and /ns shop by default and requires Vault economy for normal money purchases.

Player Shop

Players use /ns shop to browse staff-created mount entries and purchase a mount when they have funds and an available active claim slot. If claim fails after payment, the language bundle notes that the payment is refunded if payment was taken.

Admin Shop Management

Staff create entries with /ns admin shop add, list entries with /ns admin shop list, and remove entries with /ns admin shop remove <shopId>. Shop entries can define variant, speed, jump, health, breeding quality, price, and name.

Citizens NPCs

Citizens is optional. If Citizens is missing, NPC registration is unavailable but the rest of NobleSteeds still works.

Citizens NPC Setup

  1. Install Citizens and restart the backend.
  2. Create the NPCs you want players to use.
  3. Open the NobleSteeds admin NPC registration tools.
  4. Select Storage, Market, or Shop access and right-click the Citizens NPC to register it.
  5. Test the NPC as a player with the matching command permission.

Storage NPC

Storage NPCs open the mount storage GUI. This can be useful if /ns storage is disabled and storage should only be available in specific server locations.

Market NPC

Market NPCs open the player market when market and economy requirements are satisfied.

Shop NPC

Shop NPCs open the NobleSteeds shop when the shop is enabled and economy requirements are satisfied.

Manage Registered NPCs

The registered NPC management flow lets admins inspect and remove registered Citizens NPC IDs without editing data files manually.

Vault and Economy

Vault is optional for the plugin overall, but market, shop, and paid revive features require Vault unless the feature is disabled or item-currency is being used where supported. If Vault/economy is missing, market and shop menus can show unavailable or hidden states instead of exposing broken purchase flows.

MailboxGUI Integration

The JAR declares MailboxGUI as a soft dependency and includes a MailboxGUI hook. The config supports MailboxGUI money mail for market sale payouts and MailboxGUI package mail for item-currency payouts. Keep these settings disabled until MailboxGUI is installed, compatible, and tested.

market:
  send-mailboxgui-money:
    enabled: false

item-currency:
  send-mailboxgui-package: false

Pro Commands and Permissions

Core Player Commands

CommandPermissionPurpose
/nsnoblesteeds.commandOpen NobleSteeds help.
/ns managenoblesteeds.manageOpen the My Horses management GUI.
/ns infonoblesteeds.infoView rarity, type, variant, speed, jump, health, and breeding quality for the mount being ridden.
/ns claim [name]noblesteeds.claimClaim the supported adult, tamed mount being ridden.
/ns call [mount]noblesteeds.callCall a selected or favorite mount.
/ns set favorite <mount>noblesteeds.favoriteSet the favorite mount.
/ns give <mount> <onlinePlayer>noblesteeds.giveSend a mount transfer request.
/ns receivenoblesteeds.receiveOpen pending transfer requests.
/ns rename <mount> <new name>noblesteeds.renameRename an owned mount.
/ns revive <mount>noblesteeds.reviveRevive a dead owned mount when enabled.
/ns stable <set|send|unset> <mount>noblesteeds.stableManage stable locations.
/ns stable auto <mount> <on|off>noblesteeds.stableToggle auto-stable.
/ns storagenoblesteeds.storageOpen stored mounts when enabled.

Pro Player Commands

CommandPermissionPurpose
/ns marketnoblesteeds.marketOpen the player mount market hub.
/ns market receivenoblesteeds.marketClaim item-currency market payouts when item-currency payouts are enabled.
/ns shopnoblesteeds.shopOpen the admin-created NobleSteeds shop.

Admin Commands

CommandPermissionPurpose
/ns adminnoblesteeds.adminOpen admin command help.
/ns admin toolsnoblesteeds.adminOpen the admin GUI, including Pro market, shop, NPC, and storage tools when enabled.
/ns admin networknoblesteeds.adminView network readiness, storage requirement, Redis status, server ID, and safety diagnostics.
/ns admin storage currentnoblesteeds.adminShow current storage provider status.
/ns admin storage convert <YAML|SQLITE|MYSQL>noblesteeds.adminConvert storage after backing up data.
/ns admin shopnoblesteeds.admin.shopShow shop admin command help.
/ns admin shop listnoblesteeds.admin.shopList configured shop entries.
/ns admin shop remove <shopId>noblesteeds.admin.shopRemove a configured shop entry.
/ns admin shop add --v <variant> --s <speed%> --j <jump%> --h <health%> --b <breedingquality%> --price <price|Item:Amount> --name <name>noblesteeds.admin.shopCreate a curated shop mount entry.
/ns admin spawn --v <variant> --s <speed%> --j <jump%> --h <health%> --b <breedingquality%>noblesteeds.admin.spawnSpawn a custom supported mount.
/ns admin edit [--v <variant>] [--s <speed%>] [--j <jump%>] [--h <health%>] [--b <breedingquality%>]noblesteeds.admin.editEdit the mount being ridden.
/ns admin clearclaimnoblesteeds.admin.clearclaimClear stale claim data.
/ns admin reloadnoblesteeds.adminReload config, language, storage, horse data, market data, and hooks.
/ns admin updatechecknoblesteeds.adminCheck website releases.
/ns admin updatenoblesteeds.adminStage an available update.

Permissions

PermissionDefaultDescription
noblesteeds.commandtrueUse basic NobleSteeds commands.
noblesteeds.managetrueOpen My Horses.
noblesteeds.storagetrueOpen storage.
noblesteeds.infotrueView mount info.
noblesteeds.claimtrueClaim supported vanilla mounts.
noblesteeds.claims.*falseNumeric active-claim limit overrides.
noblesteeds.calltrueCall owned mounts.
noblesteeds.givetrueSend mount transfer requests.
noblesteeds.receivetrueAccept pending transfers.
noblesteeds.renametrueRename mounts.
noblesteeds.favoritetrueSet favorites.
noblesteeds.stabletrueUse stable commands.
noblesteeds.revivetrueRevive dead mounts.
noblesteeds.markettrueOpen and use the player market when enabled.
noblesteeds.shoptrueOpen and use the admin-created shop when enabled.
noblesteeds.adminopBase admin access, admin GUI, storage commands, update commands, and network diagnostics.
noblesteeds.admin.spawnopSpawn admin-created mounts.
noblesteeds.admin.editopEdit vanilla mount stats.
noblesteeds.admin.clearclaimopClear stale claim data.
noblesteeds.admin.shopopManage NobleSteeds shop entries.

Pro Configuration

Pro configuration spans both config.yml and network/config.yml. The table below lists the important sections confirmed from the bundled resources.

SectionWhat to Configure
storage.typeYAML, SQLITE, or MYSQL. Network mode expects MYSQL/MariaDB shared storage.
storage.mysqlHost, port, database, username, password, SSL, and table prefix. Required for network mode.
network.network.enabledMain network mode toggle from network/config.yml. Defaults to false.
network.network.modeSTANDALONE or NETWORK_NODE. NETWORK_NODE is used for backend servers behind a proxy.
network.network.server-idUnique backend ID used for stable routing, mount safety, market payout routing, and MailboxGUI payout routing.
network.redisRedis host, port, username, password, SSL, timeout, and channel configuration.
marketEnable player market, require economy, command toggle, NPC toggle, expiration, price limits, and MailboxGUI money payout behavior.
item-currencyOptional item-currency market listings and optional MailboxGUI package payout behavior.
shopEnable admin-created shop, command toggle, NPC toggle, economy requirement, and price limits.
storage-npc.citizensOptional Citizens NPC access for storage.
horse-management.revive.costOptional Vault revive cost with score and rarity multipliers.
rarityStat ranges, weights, and tiers used by market, shop, info, and management displays.
updatesWebsite update checker and release channel.

Pro Screenshots

NobleSteeds screenshots are served locally from /assets/wiki/1.0.0/. Missing files are shown as pending cards instead of loading private repository or GitHub URLs.
Main NobleSteeds menu screenshot
Screenshot pending upload
Main NobleSteeds menu
My Horses menu screenshot
Screenshot pending upload
My Horses menu
Horse manage menu screenshot
Screenshot pending upload
Horse manage menu
Favorite toggle screenshot
Screenshot pending upload
Favorite toggle
Rename flow screenshot
Screenshot pending upload
Rename flow
Call success screenshot
Screenshot pending upload
Call success
Stable menu screenshot
Screenshot pending upload
Stable menu
Store horse menu screenshot
Screenshot pending upload
Store horse menu
Stored horse detail screenshot
Screenshot pending upload
Stored horse detail
Share menu screenshot
Screenshot pending upload
Share menu
Share player select screenshot
Screenshot pending upload
Share player select
Receive transfers menu screenshot
Screenshot pending upload
Receive transfers menu
Receive transfer detail screenshot
Screenshot pending upload
Receive transfer detail
Revive confirmation screenshot
Screenshot pending upload
Revive confirmation
Release confirmation screenshot
Screenshot pending upload
Release confirmation
Market browse screenshot
Screenshot pending upload
Market browse
List horse on market screenshot
Screenshot pending upload
List horse on market
Market price menu screenshot
Screenshot pending upload
Market price menu
My market listings screenshot
Screenshot pending upload
My market listings
Shop menu screenshot
Screenshot pending upload
Shop menu
Rarity display screenshot
Screenshot pending upload
Rarity display
Breeding quality display screenshot
Screenshot pending upload
Breeding quality display
Admin tools menu screenshot
Screenshot pending upload
Admin tools menu
Admin horse tools screenshot
Screenshot pending upload
Admin horse tools
Admin shop menu screenshot
Screenshot pending upload
Admin shop menu
Admin shop entry detail screenshot
Screenshot pending upload
Admin shop entry detail
Admin network menu screenshot
Screenshot pending upload
Admin network menu
Admin clearclaim result screenshot
Screenshot pending upload
Admin clearclaim result
Citizens NPC admin option screenshot
Screenshot pending upload
Citizens NPC admin option

Troubleshooting

Network Not Ready

  • Run /ns admin network and check readiness lines.
  • Confirm storage.type is MYSQL for network mode.
  • Confirm Redis host, port, credentials, SSL, timeout, and firewall access.
  • Confirm each backend has a unique server-id.

Market Hidden or Unavailable

  • Confirm market.enabled and market.command-enabled.
  • Confirm Vault and a compatible economy are installed when market.require-economy is true.
  • Confirm players have noblesteeds.market.

Shop Hidden or Unavailable

  • Confirm shop.enabled and shop.command-enabled.
  • Confirm Vault/economy when shop.require-economy is true.
  • Confirm shop entries exist and are enabled.

Citizens NPC Disabled

  • Confirm Citizens is installed and enabled.
  • Confirm the matching NPC setting is enabled in config.
  • Confirm the NPC is registered as the correct Storage, Market, or Shop type.
  • Confirm players have the permission for the command the NPC opens.

Claim Limit During Purchase or Restore

  • Market and shop purchases need an available active mount slot.
  • Stored market listings may require an active slot before unlisting/restoring.
  • Grant a higher noblesteeds.claims.<amount> permission or ask the player to store/release another mount.

FAQ

Can Free upgrade to Pro?

Yes. Back up the NobleSteeds folder and database first, then install Pro and enable Pro systems intentionally.

Does Pro support Velocity networks?

The bundled network config is written for backend servers behind a proxy such as Velocity. It does not require a Velocity plugin.

Does Pro require Redis?

Only for network mode. Standalone Pro market/shop/NPC installs can leave network mode disabled.

Does the market require Vault?

Normal money-based market and shop use require Vault plus an economy provider. Item-currency support is separate where enabled.

Can NPCs be disabled?

Yes. Storage, Market, and Shop NPC access each has config gating and Citizens must be installed for NPC workflows.