Skip to main content

Installation

Runic is a single plugin jar for Spigot and Paper servers on Minecraft 1.13 and newer, through the 26.x releases. It needs no other plugins. Every integration on the Integrations and protection page switches on by itself when its plugin is present.

Installing​

  1. Stop the server.
  2. Put the Runic jar in the server's plugins folder.
  3. Start the server. Runic writes its files into plugins/Runic/ and prints a banner to the console.
  4. Grant your players the rune permissions (see Giving players magic). Every rune permission defaults to operators only.

Some runes need a newer Minecraft release, often because their patterns use newer blocks. The Version support page lists the release each rune needs.

What Runic creates​

Path in plugins/Runic/Holds
config.ymlGlobal settings. See the config.yml reference.
tiers-blocks.ymlThe Tier of every placeable block. See Block tiers.
tiers-items.ymlThe Tier of every item without a block form.
runes/One file per rune, 247 in all. See Rune files.
storage/runic.dbThe database of every placed rune, binding, and player record. See Storage, reload, and troubleshooting.
storage/hell-maw-recovery/Recovery journals that let Hell Maw restore terrain after a crash.
salvation/Records kept by the Salvation admin rune.

The console banner​

Runic prints a banner on startup and shutdown. It shows the version and build stamp, the server software, the main settings (Initiation, cross-world teleport, disabled worlds), and a status for every integration, grouped as Logging, Claims, Locks, Regions, Editing, Worlds, Chat, Skills, and Placeholders.

Quote the build stamp in bug reports. It also appears at the top of /runic info and in the %runic_build% placeholder.

Giving players magic​

Players need the permission for each rune they cast. Each rune has a node named after it, such as runic.runes.teleporter, and runic.runes.* grants every player rune. The Permissions page lists every node.

The seven admin runes stay outside the wildcard: Admin Pick, Absolution, Redemption, Salvation, True Name Altar, Altar of Judgement, and Seed Rune. Staff get them through runic.admin, which operators hold by default. With LuckPerms, for example:

/lp group default permission set runic.runes.* true
/lp group staff permission set runic.admin true

runic.admin grants the seven admin runes together with runic.admin.bypass-owner, which lets staff use, move, and retune magic bound to other players. To hand out a single admin rune, grant its own node, such as runic.runes.seedrune.

Initiation​

With require-initiation: true, the default, a player must activate the Initiation rune once before any other rune answers them. Set it to false to open magic to everyone with the permissions.

Worlds​

List world names under disabled-worlds to switch Runic off in those worlds completely:

disabled-worlds:
  - world_nether
  - minigames

Teleporters, Waypoints, and other travel magic link across worlds while teleport.cross-world is true, the default.

Turning a rune off​

Set rune-enabled: false in the rune's file under runes/ to forbid it on the whole server. A player who completes the pattern is told the rune is forbidden here. Removing the rune's permission works per group instead.

Updating​

  1. Stop the server.
  2. Replace the old Runic jar with the new one.
  3. Start the server and read the console banner.

Runic leaves your edited files in place. A setting added in a new release uses its default until you add it to the file. Each rune page on this wiki shows every current setting and its default.

The tier files gain a row for every material the server knows and the files lack, so blocks added in a new Minecraft release get a Tier right away. The database adds tables for new runes by itself.

If Runic stops during startup after an update, the console names the setting it refused. See Storage, reload, and troubleshooting.