rune

install

Install Rune on your Paper server.

One command sets up Paper, drops the Rune plugin into plugins/, and bootstraps the scripts directory.

curl -fsSL https://runemc.dev/install.sh | bash

Requirements

  • Java 21 or newer. Paper 1.21+ requires it.
  • 2 GB RAM minimum; start the server with java -Xmx2G -jar paper.jar nogui.
  • About 1 GB free disk for Paper, Rune, and a starter world.

Manual install

While the one-line installer is being finalized, you can install Rune by hand:

  1. Download the latest Rune jar from GitHub releases.
  2. Drop it into your Paper server's plugins/ directory.
  3. Start your server. Rune creates plugins/Rune/scripts/ on first load.

Verify

Confirm Rune loaded by running plugins in the server console. You should see Rune in the list.

Your first Rune

Scaffold a TypeScript Rune in plugins/Rune/scripts/<name>/:

rune new-script --name hello

That writes rune.jsonc and an index.ts with a working event listener. Reload from the server console with rune reload. Live Bukkit references survive the reload, so iteration is fast: edit, save, reload, see the change in-game.