mirror of https://github.com/PaperMC/Paper.git synced 2024-11-05 18:31:29 +01:00

[ci skip] Remove redundant/broken readme badges (#6715 )

The sonatype badge only works half the time (currently looks like this: [image](https://i.imgur.com/RGXGTvo.png))

The other removed badges contained mostly redundant or questionably useful/relevant info.

2021-10-04 09:32:57 +02:00

3.1 KiB

Raw Blame History

Paper

High performance Spigot fork that aims to fix gameplay and mechanics inconsistencies.

Support and Project Discussion:

IRC or Discord

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.

Run the Paperclip jar directly from your server. Just like old times

Documentation on using Paper: paper.readthedocs.io
For a sneak peak on upcoming features, see here

How To (Plugin Developers)

See our API patches here
See upcoming, pending, and recently added API here
Paper API javadocs here: papermc.io/javadocs
Maven Repo (for paper-api):

<repository>
    <id>papermc</id>
    <url>https://papermc.io/repo/repository/maven-public/</url>
</repository>

Artifact Information:

<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:

repositories {
    maven {
        url 'https://papermc.io/repo/repository/maven-public/'
    }
}

Artifact:

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

Special Thanks To:

YourKit, makers of the outstanding java profiler, support open source projects of all kinds with their full featured Java and .NET application profilers. We thank them for granting Paper an OSS license so that we can make our software the best it can be.

JetBrains, creators of the IntelliJ IDEA, supports Paper with one of their Open Source Licenses. IntelliJ IDEA is the recommended IDE for working with Paper, and most of the Paper team uses it.

3.1 KiB Raw Blame History