Skip to content

Installation

j-gaertig-co-dev edited this page Aug 13, 2026 · 1 revision

Installation

Requirements

  • Server software: Paper, Purpur or Folia
  • Minecraft version: 1.21.6 up to the latest supported version (currently 26.2)
  • Java: 25 or newer (whatever your server platform requires)
  • Spigot/Bukkit (without Paper) is not supported — PlainBase relies on Paper-only APIs (Brigadier command registration, region schedulers, etc.).

Steps

  1. Download the PlainBase-<version>.jar from the latest release, Modrinth or Hangar.
  2. Drop the jar into your server's plugins/ folder.
  3. Start (or restart) the server. This generates:
    • plugins/PlainBase/config.yml — the master file, only used to enable/disable modules.
    • plugins/PlainBase/modules/*.yml — one file per module, only created for modules once they're referenced.
  4. Open config.yml and set the modules you want to true.
  5. Run /plainbase reload (or restart the server) to apply the change.
  6. Edit the corresponding modules/<name>.yml file to configure that module, then /plainbase reload again.

Optional Soft Dependencies

  • PlaceholderAPI — if installed, PlainBase automatically registers its %plainbase_*% placeholder expansion. Not required; everything else works without it. See PlaceholderAPI.

Updating PlainBase

  1. Replace the old jar in plugins/ with the new one and restart the server.
  2. Check the console/OP join warnings for outdated config files — PlainBase does not silently rewrite your configs. See Configuration & Versioning for exactly how this works and what to do about it.
  3. Read the release notes on the Releases page for anything module-specific.

Clone this wiki locally