config.yml

config.yml

Core settings: the compatibility gate, the database, and the economy.

Spawner behaviour lives in spawners.yml, GUI layouts in menus.yml, chat text in messages.yml and sound effects in sounds.yml.

---

COMPATIBILITY

The version gate. The plugin refuses to enable on a server outside its supported range and prints the reason to the console.

COMPATIBILITY:
  ENABLED: true
  STRICT: true

Key	Type	Default	Description
ENABLED	boolean	true	false = log a warning and start anyway on an unsupported server.
STRICT	boolean	true	true = a Minecraft version that cannot be parsed counts as unsupported. false = let it through with a warning.

Supported ranges are Paper/Spigot/Bukkit 1.21.10 – 26.2 and Folia 1.21.11 – 26.2.

Read Compatibility before turning either of these off. Both are read before anything else loads, so a restart is required for a change to take effect.

---

DATABASE

DATABASE:
  TYPE: SQLITE
  SQLITE:
    FILE: spawners.db
  MYSQL:
    HOST: localhost
    PORT: 3306
    DATABASE: ultimatevirtualspawner
    USERNAME: root
    PASSWORD: ''
    USE_SSL: false

Key	Type	Default	Description
TYPE	SQLITE | MYSQL | MARIADB	SQLITE	Backend. MARIADB uses the MySQL driver.
SQLITE.FILE	string	spawners.db	File name inside the plugin folder.
MYSQL.HOST	string	localhost
MYSQL.PORT	int	3306
MYSQL.DATABASE	string	ultimatevirtualspawner	Must already exist; the plugin creates tables, not databases.
MYSQL.USERNAME	string	root	Needs SELECT, INSERT, UPDATE, DELETE, CREATE, ALTER.
MYSQL.PASSWORD	string	''
MYSQL.USE_SSL	boolean	false	Set true for a remote database over an untrusted network.

Requires a restart. If the database cannot be reached, the plugin refuses to enable — see Database for why that is the safe behaviour, plus the schema and migration notes.

---

ECONOMY

ECONOMY:
  PROVIDER: VAULT
  CURRENCY_SYMBOL: '$'
  SYMBOL_BEFORE_AMOUNT: true
  COMPACT_FORMAT: true

PROVIDER

Where player money lives. Requires a restart to change.

Value	Behaviour
INTERNAL	Balances live in this plugin's database. Nothing else to install; /balance, /baltop, /pay, /eco are handled here.
VAULT	Defer to an external economy plugin (EssentialsX, CMI, …) through Vault. Requires Vault plus that plugin.
AUTO	Use Vault when an economy provider is registered, otherwise fall back to INTERNAL.

The packaged default is VAULT. On a server with no Vault economy installed this leaves selling disabled — /spawner version will show Economy: unavailable (mode: VAULT). Set INTERNAL or AUTO if you are not running a separate economy plugin.

Formatting

Key	Type	Default	Description
CURRENCY_SYMBOL	string	'$'	Shown wherever money is printed.
SYMBOL_BEFORE_AMOUNT	boolean	true	true = $1,500; false = 1,500$.
COMPACT_FORMAT	boolean	true	true = 1.5K / 2.3M; false = 1,500 / 2,300,000.

These apply to whichever provider is active — including money coming from Vault.

---

ECONOMY.INTERNAL

Only used while the built-in economy is active (PROVIDER: INTERNAL, or AUTO with no external economy).

ECONOMY:
  INTERNAL:
    STARTING_BALANCE: 0.0
    DECIMAL_PLACES: 2
    ALLOW_NEGATIVE: false
    MAXIMUM_BALANCE: 0
    CURRENCY_NAME_SINGULAR: 'Dollar'
    CURRENCY_NAME_PLURAL: 'Dollars'
    REGISTER_WITH_VAULT: true
    ALLOW_PAY: true
    MINIMUM_PAY: 0.01
    BALTOP_SIZE: 10

Key	Type	Default	Description
STARTING_BALANCE	double	0.0	Balance a player starts with the first time they are paid or checked. Also the value /eco reset restores.
DECIMAL_PLACES	int (0–6)	2	Rounding precision applied to every balance change. 2 = cents. Clamped to 0–6.
ALLOW_NEGATIVE	boolean	false	Allow balances below zero (debt). Withdrawals that would go negative are blocked while false.
MAXIMUM_BALANCE	double	0	Hard cap per player. 0 = no limit.
CURRENCY_NAME_SINGULAR	string	'Dollar'	Name other plugins see through Vault.
CURRENCY_NAME_PLURAL	string	'Dollars'
REGISTER_WITH_VAULT	boolean	true	Publish this economy to Vault so shops and other plugins share these balances.
ALLOW_PAY	boolean	true	Player-to-player transfers via /pay.
MINIMUM_PAY	double	0.01	Smallest allowed /pay amount.
BALTOP_SIZE	int	10	Default number of entries shown by /baltop.

About REGISTER_WITH_VAULT

With this on and Vault installed, the built-in economy is published as a Vault provider, so shops, jobs and similar plugins read and write these same balances instead of the server ending up with two disconnected pots of money. Vault is not required; without it the economy simply stays internal to this plugin.

In AUTO mode, if an external Vault economy is already registered, the internal one is not published — the external plugin keeps ownership and the console says so.

About rounding and concurrency

Balances are rounded to DECIMAL_PLACES on every change, so repeated arithmetic cannot drift into fractions of a cent. Each player's balance is mutated under its own lock, so two concurrent sells cannot interleave into a lost update.

---

Full default file

COMPATIBILITY:
  ENABLED: true
  STRICT: true

DATABASE:
  TYPE: SQLITE
  SQLITE:
    FILE: spawners.db
  MYSQL:
    HOST: localhost
    PORT: 3306
    DATABASE: ultimatevirtualspawner
    USERNAME: root
    PASSWORD: ''
    USE_SSL: false

ECONOMY:
  PROVIDER: VAULT
  CURRENCY_SYMBOL: '$'
  SYMBOL_BEFORE_AMOUNT: true
  COMPACT_FORMAT: true
  INTERNAL:
    STARTING_BALANCE: 0.0
    DECIMAL_PLACES: 2
    ALLOW_NEGATIVE: false
    MAXIMUM_BALANCE: 0
    CURRENCY_NAME_SINGULAR: 'Dollar'
    CURRENCY_NAME_PLURAL: 'Dollars'
    REGISTER_WITH_VAULT: true
    ALLOW_PAY: true
    MINIMUM_PAY: 0.01
    BALTOP_SIZE: 10

See also

• Economy — how the provider modes behave in practice
• Database — schema, MySQL setup, backups
• Compatibility — the version gate in detail