Installation

Requirements

CraftBook runs on the Java edition of Minecraft, on a dedicated server.

CraftBook can’t be used on Realms, Windows 10, Bedrock, or Pocket Edition versions. These versions of Minecraft have limited or no mod support. :(

Before you install CraftBook, you will first have to have a server that supports Paper plugins, such as Paper or one of its forks.

While you can use forks of Paper, we strongly recommend using Paper itself as many forks are known to be unstable and break plugins. See here for further reasons to use Paper over its forks.

Note

A now discontinued version of CraftBook is available that supports the Sponge API, it can be found here.

Installation

CraftBook 5 can be downloaded from the EngineHub Builds site.

Note

In the future, CraftBook 5 will be downloadable from Hangar, Paper’s in-development plugin repository.

  1. In your server folder, create a “plugins” folder if one does not yet exist.

  2. Copy the CraftBook .jar file into the plugins folder. (Make sure you get WorldEdit as well!)

  3. Start your server.

Check your server log for errors. If you encounter errors, see the Getting Help page.