> [!CAUTION] > **This branch will be deleted soon, please replace usage of it with the new `main` branch**. > > If you need history from before 1.21.4, please use the archive repo: https://github.com/PaperMC/Paper-archive Paper [![Paper Build Status](https://img.shields.io/github/actions/workflow/status/PaperMC/Paper/build.yml?branch=master)](https://github.com/PaperMC/Paper/actions) [![Discord](https://img.shields.io/discord/289587909051416579.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/papermc) [![GitHub Sponsors](https://img.shields.io/github/sponsors/papermc?label=GitHub%20Sponsors)](https://github.com/sponsors/PaperMC) [![Open Collective](https://img.shields.io/opencollective/all/papermc?label=OpenCollective%20Sponsors)](https://opencollective.com/papermc) =========== The most widely used, high-performance Minecraft server that aims to fix gameplay and mechanics inconsistencies. **Support and Project Discussion:** - [Our forums](https://forums.papermc.io/) or [Discord](https://discord.gg/papermc) 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](https://papermc.io/downloads/paper). Run the Paperclip jar directly from your server. Just like old times * Documentation on using Paper: [docs.papermc.io](https://docs.papermc.io) * For a sneak peek at upcoming features, [see here](https://github.com/PaperMC/Paper/projects) How To (Plugin Developers) ------ * See our API patches [here](patches/api) * See upcoming, pending, and recently added API [here](https://github.com/orgs/PaperMC/projects/2/views/4) * Paper API javadocs here: [papermc.io/javadocs](https://papermc.io/javadocs/) #### Repository (for paper-api) ##### Maven ```xml papermc https://repo.papermc.io/repository/maven-public/ ``` ```xml io.papermc.paper paper-api 1.21.4-R0.1-SNAPSHOT provided ``` ##### Gradle ```kotlin repositories { maven { url = uri("https://repo.papermc.io/repository/maven-public/") } } dependencies { compileOnly("io.papermc.paper:paper-api:1.21.4-R0.1-SNAPSHOT") } java { toolchain.languageVersion.set(JavaLanguageVersion.of(21)) } ``` How To (Compiling Jar From Source) ------ To compile Paper, you need JDK 21 and an internet connection. Clone this repo, run `./gradlew applyPatches`, then `./gradlew createMojmapBundlerJar` from your terminal. You can find the compiled jar in the project root's `build/libs` directory. To get a full list of tasks, run `./gradlew tasks`. How To (Pull Request) ------ See [Contributing](CONTRIBUTING.md) 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](https://opencollective.com/) via the [Open Source Collective fiscal host](https://opencollective.com/opensource) 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](https://papermc.io/sponsors). You can find our collective [here](https://opencollective.com/papermc), or you can donate via GitHub Sponsors [here](https://github.com/sponsors/PaperMC), which will also go towards the collective. Special Thanks To: ------------- [![YourKit-Logo](https://www.yourkit.com/images/yklogo.png)](https://www.yourkit.com/) [YourKit](https://www.yourkit.com/), makers of the outstanding java profiler, support open source projects of all kinds with their full featured [Java](https://www.yourkit.com/java/profiler) and [.NET](https://www.yourkit.com/.net/profiler) application profilers. We thank them for granting Paper an OSS license so that we can make our software the best it can be. [](https://www.jetbrains.com) [JetBrains](https://www.jetbrains.com/), creators of the IntelliJ IDEA, supports Paper with one of their [Open Source Licenses](https://www.jetbrains.com/opensource/). IntelliJ IDEA is the recommended IDE for working with Paper, and most of the Paper team uses it. All our sponsors! [![Sponsor Image](https://raw.githubusercontent.com/PaperMC/papermc.io/data/sponsors.png)](https://papermc.io/sponsors)