OpenSource/PaperMC
OpenSource/PaperMC
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2024-12-27 15:00:13 +01:00
Code Issues Projects Releases Packages Wiki Activity

Update readme and contributing guidelines

Browse source
This commit is contained in:
Nassim Jahnke 2021-11-26 10:39:57 +01:00
parent 7114126267
commit 1959bd0fbd
2 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
CONTRIBUTING.md
View file

@ -27,12 +27,12 @@ which can be obtained in (most) package managers such as `apt` (Debian / Ubuntu;
you will most likely use this for WSL), `homebrew` (macOS / Linux), and more: you will most likely use this for WSL), `homebrew` (macOS / Linux), and more:
- `git` (package `git` everywhere); - `git` (package `git` everywhere);
- A Java 16 or later JDK (packages vary, use Google/DuckDuckGo/etc.). - A Java 17 or later JDK (packages vary, use Google/DuckDuckGo/etc.).
- [Adoptium](https://adoptium.net/) has builds for most operating systems. - [Adoptium](https://adoptium.net/) has builds for most operating systems.
- Paper requires JDK 16 to build, however makes use of Gradle's - Paper requires JDK 17 to build, however makes use of Gradle's
[Toolchains](https://docs.gradle.org/current/userguide/toolchains.html) [Toolchains](https://docs.gradle.org/current/userguide/toolchains.html)
feature to allow building with only JRE 8 or later installed. (Gradle will feature to allow building with only JRE 8 or later installed. (Gradle will
automatically provision JDK 16 for compilation if it cannot find an existing automatically provision JDK 17 for compilation if it cannot find an existing
install). install).
If you're on Windows, check If you're on Windows, check
@ -42,11 +42,11 @@ If you're compiling with Docker, you can use Adoptium's
[`eclipse-temurin`](https://hub.docker.com/_/eclipse-temurin/) images like so: [`eclipse-temurin`](https://hub.docker.com/_/eclipse-temurin/) images like so:
```console ```console
# docker run -it -v "$(pwd)":/data --rm eclipse-temurin:16.0.2_7-jdk bash # docker run -it -v "$(pwd)":/data --rm eclipse-temurin:17.0.1_12-jdk bash
Pulling image... Pulling image...
root@abcdefg1234:/# javac -version root@abcdefg1234:/# javac -version
javac 16.0.2 javac 17.0.1
``` ```
## Understanding Patches ## Understanding Patches

12
README.md
View file

@ -19,7 +19,7 @@ Download Paper from our [downloads page](https://papermc.io/downloads).
Run the Paperclip jar directly from your server. Just like old times Run the Paperclip jar directly from your server. Just like old times
* Documentation on using Paper: [paper.readthedocs.io](https://paper.readthedocs.io/) * 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) * For a sneak peek on upcoming features, [see here](https://github.com/PaperMC/Paper/projects)
How To (Plugin Developers) How To (Plugin Developers)
------ ------
@ -38,7 +38,7 @@ How To (Plugin Developers)
<dependency> <dependency>
<groupId>io.papermc.paper</groupId> <groupId>io.papermc.paper</groupId>
<artifactId>paper-api</artifactId> <artifactId>paper-api</artifactId>
<version>1.17.1-R0.1-SNAPSHOT</version> <version>1.18-R0.1-SNAPSHOT</version>
<scope>provided</scope> <scope>provided</scope>
</dependency> </dependency>
``` ```
@ -54,19 +54,19 @@ repositories {
} }
dependencies { dependencies {
compileOnly("io.papermc.paper:paper-api:1.17.1-R0.1-SNAPSHOT") compileOnly("io.papermc.paper:paper-api:1.18-R0.1-SNAPSHOT")
} }
java { java {
toolchain.languageVersion.set(JavaLanguageVersion.of(16)) toolchain.languageVersion.set(JavaLanguageVersion.of(17))
} }
``` ```
How To (Compiling Jar From Source) How To (Compiling Jar From Source)
------ ------
To compile Paper, you need JDK 16 and an internet connection. To compile Paper, you need JDK 17 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. Clone this repo, run `./gradlew applyPatches`, then `./gradlew createReobfBundlerJar` 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`. To get a full list of tasks, run `./gradlew tasks`.