Configuration

A walk through config.yml, key by key, with what each one changes and what it defaults to.

config.yml holds the settings shared by every wand. The per wand settings live in wands.yml, and prices in prices.yml.

Leave config-version alone. It is how a later update merges its new keys into the file you have already edited, without touching your values. The same key sits at the top of every WandWorks file.

Language

language: en_US

Names a file in the lang folder, without the extension. en_US, fr_FR and es_ES ship translated. The short names en, fr and es point at the same three files, so a config written for the first release keeps working.

Drop your own de_DE.yml in the folder and put de_DE here and it loads. A name that does not match any file falls back to en_US with a console warning. See Messages and language.

Storage

storage:
  type: sqlite
  save-interval: 60
  mysql:
    host: localhost
    port: 3306
    database: wandworks
    username: root
    password: ""
    properties: "useSSL=false&allowPublicKeyRetrieval=true"
    pool-size: 6

Key	What it does	Default
`type`	`sqlite` or `mysql`. Anything else is read as `sqlite`	`sqlite`
`save-interval`	Seconds between batched writes. Values under 5 are raised to 5	`60`
`mysql.properties`	Extra JDBC flags. Change this only if your host asks for something else	as shipped
`mysql.pool-size`	Connections kept open	`6`

Storage settings are read once at startup. Changing type or any of the MySQL details needs a full server restart. /wandworks reload will not pick them up.

Full detail on Storage.

Price order

prices:
  order:
    - shopguiplus
    - economyshopgui
    - ultimateshop
    - zshop
    - essentials
    - file

The order price sources are asked in. First one with a price wins, and ids whose plugin is missing are skipped. Covered in full on Price sources.

Hooks

hooks:
  superiorskyblock:
    enabled: true
    # block or allow
    outside-island: block
  infinitebags:
    enabled: true

Key	What it does	Default
`superiorskyblock.enabled`	Limits wand use to islands the player belongs to	`true`
`superiorskyblock.outside-island`	What happens away from every island. `block` refuses, `allow` lets it through	`block`
`infinitebags.enabled`	Whether bag mode is looked for at all	`true`

Both hooks turn themselves off when the plugin behind them is missing, so leaving these on costs nothing on a server that does not have them.

wandworks.bypass.island skips the island check entirely. Staff usually want it. See Permissions.

Selling

selling:
  cancel-on-unpriced: false

Off, an item nobody prices is skipped and left in the container while the rest sells. On, one unpriced item stops the whole sale and the player is told which item did it.

Leave it off for a normal server. Turn it on if you would rather players noticed an unpriced item than quietly sold around it.

Building

building:
  # inventory or bag
  source-order: inventory

Which source an inventory mode builder wand tries first when bag use is on. inventory empties their pockets before their bag, bag does the reverse.

This does not apply to shop mode. There the bag always goes first, so only the shortfall is ever bought.

The bag toggle

bag-toggle:
  action: sneak-right-click-air

Which action switches bag use on a held builder wand. One of sneak-right-click-air, right-click-air, sneak-left-click-air or left-click-air. Anything else is read as the default. See Bag mode.

Replaceable blocks

replaceable:
  - AIR
  - CAVE_AIR
  - SHORT_GRASS
  - TALL_GRASS
  - SNOW

The blocks a builder wand is allowed to build over. Anything not on this list is never overwritten, and a position holding one is stepped over rather than ending the line.

Add WATER, LAVA or the leaf types if you want the wands clearing those. An unknown material name gets a console warning naming it and is skipped.

Containers

containers:
  - CHEST
  - TRAPPED_CHEST
  - BARREL
  - SHULKER_BOX

The blocks a sell wand works on. Right-clicking anything else with a sell wand does nothing at all, so players can still open other containers normally with one in hand.

A double chest counts as one container. Clicking either half sells the whole thing.
SHULKER_BOX covers all sixteen coloured ones too, so you do not need to list them.

Reloading

/wandworks reload re-reads config.yml, wands.yml, prices.yml and the language file, rebuilds the wand list and the price chain, and clears every cooldown.

Two things it does not do:

Storage settings, as above. Those need a restart.
Wands already in players' inventories keep their old name and lore until they are next used, because the item is only rewritten when its uses change.

On this page