Go to file
Bjarne Koll b33b63908e
Support complex components in written book builder (#6337)
The previously existing toBuilder method defined on the CraftMetaBook
would, no matter if called on a writable or written book, return a
builder targetting a writable book, in which complex components, such as
hover or click text are not allowed.

The builer hence serializes the page components using LEGACY_UXRC to
ensure only colour may be passed. While this works as intented for
writable books, the builder fails to fully support the complex
components that may be used in a written book.

This commit implemements a child class of the CraftMetaBookBuilder, the
CraftMetaBookSignedBuilder, which builds to a CraftMetaBookSigned
instance and hence serializes the pages to json.
This builder instance is automatically supplied when calling toBuilder
on a CraftMetaBookSigned instance.

Resolves: #6296
2021-08-08 15:57:20 -07:00
.github [ci skip] Performance boost! (#5942) 2021-06-21 15:18:07 -07:00
Paper-MojangAPI Suppress deprecation registration warnings for brigadier events (#6297) 2021-07-31 07:59:22 +02:00
build-data Updated Upstream (CraftBukkit) (#6260) 2021-07-24 03:33:05 +01:00
gradle/wrapper Gradle & Paperclip updates 2021-06-14 23:17:16 -05:00
licenses [CI-SKIP] Clarify project licensing 2018-03-06 20:41:03 -05:00
patches Support complex components in written book builder (#6337) 2021-08-08 15:57:20 -07:00
scripts Clean cache on upstream update 2021-06-15 01:38:41 -07:00
test-plugin [ci skip] Add a test plugin (#6133) 2021-07-09 03:04:33 -07:00
work Updated Upstream (Bukkit/CraftBukkit) 2021-08-04 16:26:56 +01:00
.editorconfig Update editorconfig 2021-06-14 21:02:20 -07:00
.gitattributes Fix patch, fix .gitattributes file name 2021-06-12 14:09:11 +02:00
.gitignore [ci skip] Add a test plugin (#6133) 2021-07-09 03:04:33 -07:00
.gitmodules Remove Paperclip submodule 2021-06-15 01:44:13 -05:00
CONTRIBUTING.md [CI-SKIP] Add PR rebasing steps (#5634) 2021-05-16 16:29:19 +00:00
LICENSE.md Update email & name (DenWav) 2021-07-19 21:07:53 -05:00
README.md [ci skip] More badges and things to README.md (#5338) 2021-07-08 16:41:46 +02:00
build.gradle.kts Fix Java toolchain configuration to work on arm macOS 2021-08-01 02:55:02 -05:00
gradle.properties Update paperweight to 1.1.9 (#6284) 2021-07-28 02:00:41 -07:00
gradlew Did anyone say gradle? and paperweight? potentially even mojmap?! 2021-06-11 09:45:34 +02:00
gradlew.bat gradlew.bat crlf fix (#5810) 2021-06-12 22:34:05 +01:00
settings.gradle.kts [ci skip] Add a test plugin (#6133) 2021-07-09 03:04:33 -07:00

README.md

Paper GitHub Workflow Status (branch) Read the Docs (version) version Sonatype Nexus (Query Options) Discord

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

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.