From 5721b969d93104591526e7410ee88d46ea641c53 Mon Sep 17 00:00:00 2001 From: LeCraft Date: Fri, 3 Nov 2023 10:36:32 +0100 Subject: [PATCH] Update README.md --- README.md | 98 +------------------------------------------------------ 1 file changed, 1 insertion(+), 97 deletions(-) diff --git a/README.md b/README.md index c656cf87d4ed..e5ef43589d25 100644 --- a/README.md +++ b/README.md @@ -1,97 +1 @@ -Paper [![Paper Build Status](https://img.shields.io/github/workflow/status/PaperMC/Paper/Build%20Paper/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) -=========== - -High performance Spigot fork 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). - -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 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 - - papermc - https://repo.papermc.io/repository/maven-public/ - -``` - * Artifact Information: -```xml - - io.papermc.paper - paper-api - 1.18.2-R0.1-SNAPSHOT - provided - - ``` - -**Or alternatively, with Gradle:** - - * Repository: -```kotlin -repositories { - maven { - url = uri("https://repo.papermc.io/repository/maven-public/") - } -} - -dependencies { - compileOnly("io.papermc.paper:paper-api:1.18.2-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 finanically 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) +Custom Paper