From a4d9687be89cba296572de1f5afc6457d42946c7 Mon Sep 17 00:00:00 2001 From: Nassim Jahnke Date: Fri, 26 Nov 2021 10:39:57 +0100 Subject: [PATCH] Update readme and contributing guidelines --- CONTRIBUTING.md | 10 +++++----- README.md | 12 ++++++------ 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 73b74306c9..ce3b88f770 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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: - `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. - - 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) 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). 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: ```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... root@abcdefg1234:/# javac -version -javac 16.0.2 +javac 17.0.1 ``` ## Understanding Patches diff --git a/README.md b/README.md index f8b2c534d4..57e63dba11 100644 --- a/README.md +++ b/README.md @@ -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 * 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) ------ @@ -38,7 +38,7 @@ How To (Plugin Developers) io.papermc.paper paper-api - 1.17.1-R0.1-SNAPSHOT + 1.18-R0.1-SNAPSHOT provided ``` @@ -54,19 +54,19 @@ repositories { } 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 { - toolchain.languageVersion.set(JavaLanguageVersion.of(16)) + toolchain.languageVersion.set(JavaLanguageVersion.of(17)) } ``` 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`.