Rune files

Every rune has its own settings file in plugins/Runic/runes/, named after the rune: teleporter.yml, toggleblock.yml, zenmaster.yml. The name is the last part of the rune's page address on this wiki. Each rune page lists every setting in its file with the default.

How the files work

On startup Runic copies any missing rune file out of the jar, comments included. It leaves existing files exactly as they are, so your edits survive updates.

Runic reads each file on top of the defaults built into the jar:

• A setting you leave out, or delete, uses its default. Settings added in a new release work the same way until you add them.
• A setting must keep the type of its default: true or false, a whole number, a decimal, quoted text, or a list of text.
• Keys the defaults do not have are ignored.
• A file may be at most 256 KiB.

Run /runic reload after editing, or restart the server.

Settings every rune has

rune-enabled: true
min-version: "1.13"
lore: "Enchants a held item with homecoming: bind it at the torch, and clicking with it thereafter returns you here."
activation-sound: ENTITY_ENDERMAN_TELEPORT
activation-sound-volume: 1.0
activation-sound-pitch: 1.0
messages:
  disabled: "&cThe pattern is drawn true, but {display} is forbidden on this server."

Key	Meaning
rune-enabled	false forbids the rune on the whole server.
min-version	The oldest Minecraft release the rune works on. Runic defines it, and edits here are ignored.
lore	The rune's entry in its school's Tome. Plain text, without colour codes.
activation-sound	The sound played when the rune wakes, by its Bukkit sound name. none or blank stays silent.
activation-sound-volume, activation-sound-pitch	Volume and pitch of that sound.
messages	Everything the rune says in chat. See Messages.

Charges

Runes that bind charges onto an item or block carry use-charges. Set it to false for unlimited charges.

A rune with Tier blocks sets its charges per Tier in charges-by-tier. A rune whose pattern has no Tier blocks, such as Recall, takes a single charges number instead.

use-charges: true
charges-by-tier:
  1: 52
  2: 114
  3: 262
  4: 655
  5: 1703
  6: 4598
  7: 13794

Tier tables

Any setting that changes with Tier is a table keyed 1 to 7, like charges-by-tier above or Zen Master's radii-by-tier. List only the Tiers you want to change and the rest keep their defaults:

radii-by-tier:
  7: 48

Write each table as a section with one line per Tier. A single-line list such as [8, 12, 16] is refused.

Setting groups

Some runes gather related numbers under a heading. Weather Sensor keeps its normal and inverted outputs apart this way:

normal:
  weather-pulse-ticks: 2
  weather-pulse-strength: 10
inverted:
  rain-strength: 5

Every value in a group is a whole number, and every name must already exist in that group.

Messages

Each line under messages overrides one message. Leave a message out to keep its default.

• Colours use & codes, as in &c for red and &7 for grey.
• Placeholders in braces, such as {display}, {tier}, or {radius}, fill in when the message is sent. Each message's default shows the placeholders it offers.
• Set a message to none, or leave it blank, to silence it.

Every rune shares a block of refusal messages: disabled, version-too-old, no-permission, need-initiation, ward-suppressed, and the near-miss-… hints described in Near-miss hints. The rest belong to the rune itself.

Settings Runic refuses

A file that breaks a rule above stops startup, or stops a reload, with a message that names the file and the setting. These older keys also stop it, with a pointer to the setting that replaced them:

charges-per-ink, cooldown-ms, duration-ms, duration-seconds-by-tier, trap-fire-seconds-by-tier, climb-charge-interval-ms, wave-blocks-per-second

Times in current files are in ticks, with twenty ticks to a second.

Renamed runes

The Light Bows and the Translocation Bow once carried bowof… names. If lightbow.yml is missing and bowoflight.yml is present, Runic reads the old file. The same holds for bowofredlight, bowofsoullight, bowofcopperlight, and bowoftranslocation.

The tier files

Two files give every material its Tier from 0 to 7:

• tiers-blocks.yml holds every block that can be placed, which covers every block a rune pattern can use.
• tiers-items.yml holds items without a block form, used by runes that take an item as fuel or payment.

tiers:
  COBBLESTONE: 1
  IRON_BLOCK: 4
  DIAMOND_BLOCK: 6
  NETHERITE_BLOCK: 7

A material missing from both files is Tier 0. Each value must be a whole number from 0 to 7.

When the server starts, Runic adds a row to the tier files for every material the server knows and the files lack, renames rows for materials Minecraft has renamed, and drops rows for materials this server does not have. A server still holding a single tiers.yml from an older Runic has it split into the two files at startup. /runic reload reads the files as they stand and fills the same gaps in memory, leaving the files to be rewritten at the next restart.

The Block tiers page lists the shipped Tier of every block, and /runic tier shows the live values in game. To learn what Tiers mean for players, see Tiers.