Paper README

The project's README from github.com/PaperMC/Paper. As one markdown file: README.md.

Paper Version Paper Build Status Discord GitHub Sponsors Open Collective

The most widely used, high-performance Minecraft server that aims to fix gameplay and mechanics inconsistencies.

Support and Project Discussion:

How To (Server Admins)

Paperclip is a jar file that you can download and run just like a normal jar file.

Download Paper from our downloads page.

Run the Paperclip jar directly from your server. Just like old times.

How To (Plugin Developers)

Repository (for paper-api)

See the docs for more details.

Gradle
repositories {
    maven {
        url = uri("https://repo.papermc.io/repository/maven-public/")
    }
}

dependencies {
    compileOnly("io.papermc.paper:paper-api:26.2.build.+")
}

java {
    toolchain.languageVersion.set(JavaLanguageVersion.of(25))
}
Maven
<repository>
    <id>papermc</id>
    <url>https://repo.papermc.io/repository/maven-public/</url>
</repository>

<dependency>
    <groupId>io.papermc.paper</groupId>
    <artifactId>paper-api</artifactId>
    <version>[26.2.build,)</version>
    <scope>provided</scope>
</dependency>

How To (Compiling Jar From Source)

To compile Paper, you need JDK 25 and an internet connection.

Clone this repo, run ./gradlew applyPatches, then ./gradlew createPaperclipJar from your terminal. You can find the compiled jar in the paper-server/build/libs directory.

To get a full list of tasks, run ./gradlew tasks.

How To (Pull Request)

See Contributing

Old Versions (1.21.3 and below)

For branches of versions 1.8-1.21.3, please see our archive repository.

Support Us

First of all, thank you for considering helping out, we really appreciate that!

PaperMC has various recurring expenses, mostly related to infrastructure. Paper uses Open Collective via the Open Source Collective fiscal host to manage expenses. Open Collective allows us to be extremely transparent, so you can always see how your donations are used. You can read more about financially supporting PaperMC on our website.

You can find our collective here, or you can donate via GitHub Sponsors here, which will also go towards the collective.

Special Thanks To:

YourKit-Logo

YourKit, makers of the outstanding java profiler, support open source projects of all kinds with their full featured Java and .NET application profilers. We thank them for granting Paper an OSS license so that we can make our software the best it can be.

All our sponsors!
Sponsor Image

Paper (PaperMC/Paper)

Searching Database…

12.7K ·GitHub
Paper
What is this?Paper is the most widely used, high-performance Minecraft server software. Its goal is to fix gameplay and mechanics inconsistencies found in the vanilla server.
Is this something players install, or a server I host myself?It is server software you host yourself: you run Paper on your own machine or host, and players join from their normal Minecraft client.
How do I get a server up and running?Download the Paperclip jar from the PaperMC downloads page and run it directly on your server like any normal jar. Usage documentation lives at docs.papermc.io.
Are older Minecraft versions still supported?This repository carries current releases; branches for versions 1.8 through 1.21.3 are maintained in a separate archive repository.
What exactly is Paperclip?It is the launcher jar you download from PaperMC and run to set up a Paper server. You treat it like any normal jar file - no special install steps.
Why run Paper instead of the vanilla server?Paper is built for high performance and aims to fix gameplay and mechanics inconsistencies, which is why it has become the most widely used Minecraft server software.
Is Paper free, and how is it funded?Yes, it is free and openly developed. The project covers its infrastructure costs through transparent donations via Open Collective and GitHub Sponsors, so you can see exactly how funds are used.
What are similar projects?docker-minecraft-server, Pumpkin, luanti, TrinityCore, Rise-6.9.5, skynet, ktor, ReSkate
Which topics is it in?game-server, minecraft, gradle, multiplayer, jvm, paper, gaming, java, plugin, performance, framework, free
Creator
PaperMC
Size
131.7 MB
Stars
12.7K
Updated
CommitOct 16
Age
10y
Commits · 90 Days