Go to file
Mariell Hoversholm fac9cc5d5c [CI-SKIP] Ignore .gitignore
A `.gitignore' will make packages such as
`net.minecraft.world.entity.ai.goal.**target**` be ignored. This causes
the entire patch to not apply, which is very suspicious. This commit
adds a `--force' parameter to the `git add' command we run, as per `man
git-add':

```
       -f, --force
           Allow adding otherwise ignored files.
```

The global configuration file was proven problematic, then fixed by
this by commit by Prof_Bloodstone#0123 and thekinrar#0001 on Discord
(`#paper-dev').

CI-SKIP: This does not apply to the CI, therefore it is not worthy of
its own build.
2021-03-19 18:36:06 +01:00
.github Change cache keys 2021-03-18 18:03:22 +01:00
Paper-MojangAPI Updated Upstream (Bukkit/CraftBukkit/Spigot) 2021-01-16 02:18:38 +00:00
Spigot-API-Patches Deprecate ItemStack#setLore(List<String>) and ItemStack#getLore, add Component based alternatives 2021-03-19 10:00:35 +01:00
Spigot-Server-Patches apply fixup 2021-03-19 07:54:18 +01:00
licenses [CI-SKIP] Clarify project licensing 2018-03-06 20:41:03 -05:00
removed Reimplement GS4QueryEvent 2021-01-04 20:17:29 +01:00
scripts [CI-SKIP] Ignore .gitignore 2021-03-19 18:36:06 +01:00
work Updated Upstream (Bukkit/CraftBukkit) 2021-03-18 18:03:22 +01:00
.editorconfig [CI-SKIP] add .editorconfig for base code style settings 2018-08-07 01:14:22 -04:00
.gitignore Fix ./paper edit continue for Windows 2020-05-19 23:14:34 -04:00
.gitmodules Cleanup and restructure the project 2016-04-01 23:15:41 -05:00
CONTRIBUTING.md [CI-SKIP] Add `curl` requirement for building paper. (#4768) 2020-11-15 16:42:05 -06:00
LICENSE.md [CI-SKIP] Removal from the MIT list (#5345) 2021-03-12 00:36:30 +00:00
README.md [CI-SKIP] Fix YourKit links in readme, fixes #5091 2021-01-30 14:19:50 +01:00
UPDATE_NOTES.md Updated Upstream (Bukkit/CraftBukkit/Spigot) (#4728) 2020-11-02 20:22:15 -06:00
paper [CI-SKIP] Add a few missing commands to the ./paper help output 2021-01-07 21:20:35 +01:00
pom.xml Implement Brigadier Mojang API 2020-04-27 01:42:12 -04:00

README.md

Paper GitHub Workflow Status (branch)

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

Support and Project Discussion:

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

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>com.destroystokyo.paper</groupId>
    <artifactId>paper-api</artifactId>
    <version>1.16.5-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 'com.destroystokyo.paper:paper-api:1.16.5-R0.1-SNAPSHOT'
}

How To (Compiling Jar From Source)

To compile Paper, you need JDK 8, maven, and an internet connection.

Clone this repo, run ./paper jar from bash, get files.

How To (Pull Request)

See Contributing

Special Thanks To:

YourKit-Logo

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.