mirror of
https://github.com/PaperMC/Paper.git
synced 2024-11-22 18:45:54 +01:00
97 lines
4.3 KiB
Markdown
97 lines
4.3 KiB
Markdown
Paper [](https://github.com/PaperMC/Paper/actions)
|
|
[](https://discord.gg/papermc)
|
|
[](https://github.com/sponsors/PaperMC)
|
|
[](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/), [Discord](https://discord.gg/papermc), or [IRC](https://webchat.esper.net/?channels=paper)
|
|
|
|
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
|
|
<repository>
|
|
<id>papermc</id>
|
|
<url>https://repo.papermc.io/repository/maven-public/</url>
|
|
</repository>
|
|
```
|
|
|
|
```xml
|
|
<dependency>
|
|
<groupId>io.papermc.paper</groupId>
|
|
<artifactId>paper-api</artifactId>
|
|
<version>1.20.3-R0.1-SNAPSHOT</version>
|
|
<scope>provided</scope>
|
|
</dependency>
|
|
```
|
|
##### Gradle
|
|
```kotlin
|
|
repositories {
|
|
maven {
|
|
url = uri("https://repo.papermc.io/repository/maven-public/")
|
|
}
|
|
}
|
|
|
|
dependencies {
|
|
compileOnly("io.papermc.paper:paper-api:1.20.3-R0.1-SNAPSHOT")
|
|
}
|
|
|
|
java {
|
|
toolchain.languageVersion.set(JavaLanguageVersion.of(17))
|
|
}
|
|
```
|
|
|
|
How To (Compiling Jar From Source)
|
|
------
|
|
To compile Paper, you need JDK 17 and an internet connection.
|
|
|
|
Clone this repo, run `./gradlew applyPatches`, then `./gradlew createReobfBundlerJar` 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:
|
|
-------------
|
|
|
|
[](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.
|
|
|
|
[<img src="https://user-images.githubusercontent.com/21148213/121807008-8ffc6700-cc52-11eb-96a7-2f6f260f8fda.png" alt="" width="150">](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!
|
|
[](https://papermc.io/sponsors)
|