mirror of
https://github.com/PaperMC/Paper.git
synced 2024-11-29 22:13:42 +01:00
d8ad276b7d
* Update README.md * Update README.md Remove license badge and fix letters * Update README.md * Update README.md Many many time in this PR... now pass to java 16 * Update README.md Add discord badge * Update README.md Fix format * Update README.md Change url to patches (because Spigot-API-Patches change) * Update README.md * Update README.md Apply suggest url to patches Co-authored-by: Olivia <chew@chew.pw> * Update README.md Update paper version from 1.17 to 1.17.1 * Update README.md A better badge for discord (IRC not have a custom badge or any...) * Update README.md Update style. Co-authored-by: Olivia <chew@chew.pw>
85 lines
3.4 KiB
Markdown
85 lines
3.4 KiB
Markdown
Paper    
|
|
[](https://discord.gg/papermc)
|
|
===========
|
|
|
|
High performance Spigot fork that aims to fix gameplay and mechanics inconsistencies.
|
|
|
|
|
|
**Support and Project Discussion:**
|
|
- [IRC](https://webchat.esper.net/?channels=paper) 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).
|
|
|
|
Run the Paperclip jar directly from your server. Just like old times
|
|
|
|
* Documentation on using Paper: [paper.readthedocs.io](https://paper.readthedocs.io/)
|
|
* For a sneak peak on 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/PaperMC/Paper/projects/6)
|
|
* Paper API javadocs here: [papermc.io/javadocs](https://papermc.io/javadocs/)
|
|
* Maven Repo (for paper-api):
|
|
```xml
|
|
<repository>
|
|
<id>papermc</id>
|
|
<url>https://papermc.io/repo/repository/maven-public/</url>
|
|
</repository>
|
|
```
|
|
* Artifact Information:
|
|
```xml
|
|
<dependency>
|
|
<groupId>io.papermc.paper</groupId>
|
|
<artifactId>paper-api</artifactId>
|
|
<version>1.17.1-R0.1-SNAPSHOT</version>
|
|
<scope>provided</scope>
|
|
</dependency>
|
|
```
|
|
|
|
**Or alternatively, with Gradle:**
|
|
|
|
* Repository:
|
|
```groovy
|
|
repositories {
|
|
maven {
|
|
url 'https://papermc.io/repo/repository/maven-public/'
|
|
}
|
|
}
|
|
```
|
|
* Artifact:
|
|
```groovy
|
|
dependencies {
|
|
compileOnly 'io.papermc.paper:paper-api:1.17.1-R0.1-SNAPSHOT'
|
|
}
|
|
```
|
|
|
|
How To (Compiling Jar From Source)
|
|
------
|
|
To compile Paper, you need JDK 16 and an internet connection.
|
|
|
|
Clone this repo, run `./gradlew applyPatches`, then `./gradlew reobfJar` 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](CONTRIBUTING.md)
|
|
|
|
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.
|
|
|