Installing Scribe on your Minecraft server takes only a few minutes.

Prerequisites

Before installing Scribe, ensure your server meets the following requirements:

  • Server Software: Paper 1.21.1+ (or a modern fork like Purpur).
  • Java Version: Java 21 or higher.

While Scribe works perfectly on its own, it is highly recommended to install the following plugins to unlock its full potential:

  • LuckPerms: Scribe uses LuckPerms to fetch player groups, weights, and prefixes.
  • PlaceholderAPI (PAPI): To parse thousands of custom variables in chat formats.
  • MiniPlaceholders: For MiniMessage-native placeholder parsing.

Installation Steps

  1. Download the Plugin: Obtain the latest Scribe-x.x.x.jar file from the official releases page.
  2. Stop Your Server: Never install plugins while the server is running.
  3. Move the Jar: Place the Scribe-x.x.x.jar file into your server’s plugins/ directory.
  4. Start the Server: Boot up your server. Scribe will automatically generate its default configuration files in plugins/Scribe/.

First Boot

Once Scribe is running, it will take over the vanilla chat event. By default, Scribe provides a standard group format and basic moderation rules.

You can now proceed to the Config Overview to learn how to tweak Scribe to your liking.