Start here

Installation

Build Foundry from this repository and install it on a Paper server.

On this page

Requirements

  • A Paper server compatible with Minecraft 1.21.11.
  • Java 21. The Gradle build configures a Java 21 toolchain.
  • A built Foundry plugin JAR. This repository uses the Gradle Shadow plugin for the plugin artifact.

Build the plugin

From the repository root, run the Gradle wrapper. The root build includes the example and elemental addon projects as well as Foundry.

bash
./gradlew build

Gradle writes build outputs to the relevant project's build/libs directory. Select the Foundry plugin artifact from the root project's output, rather than an addon artifact.

Install on Paper

  • Copy the Foundry plugin JAR into the server's plugins directory.
  • Start or restart the server so Paper can load the plugin.
  • Check the server console for Foundry's enabled message and addon loading summary.