PandaSpigot

Fork of Paper for 1.8.8 focused on improved performance and stability.

Highlights

• Backported API enhancements from newer versions

  • ServerTickStartEvent & ServerTickEndEvent
  • PlayerChunkLoadEvent & PlayerChunkUnloadEvent
  • PlayerHandshakeEvent
  • EntityMoveEvent

• Greatly improved network performance

  • Updating to Netty 4.1 offers the ability to use newer Java versions with epoll on Linux.
  • Improved flush handling to massively improve entity tracker performance.
  • Support for Unix domain sockets to avoid the overhead of TCP when using a proxy on the same machine.
  • Using LazyRunnables to avoid expensive thread wakeup calls when sending non-flushed packets.

• More configuration options, such as:

  • Customizable knockback
  • World and player data saving

See a full list of patches here.

Using

You can download the latest pre-built artifact here.

For support, please join our Discord.

API

See our API patches here.

Maven

<repositories>
    <repository>
        <id>hpfxd-repo</id>
        <url>https://repo.hpfxd.com/releases/</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>com.hpfxd.pandaspigot</groupId>
        <artifactId>pandaspigot-api</artifactId>
        <version>1.8.8-R0.1-SNAPSHOT</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

Gradle (kts)

repositories {
    mavenCentral()
    maven(url = "https://repo.hpfxd.com/releases/")
}

dependencies {
    compileOnly("com.hpfxd.pandaspigot:pandaspigot-api:1.8.8-R0.1-SNAPSHOT")
}

Building

To compile PandaSpigot, you'll need:

• JDK 8 (or above)
• Git
• Bash

Building, patching, and compiling are all done through the main panda script.

PandaSpigot can be built by running ./panda jar, and you will find the final Paperclip jar in paperclip.jar

Contributing

You can mostly follow Paper's contributing guide, just remember:

• Multi-line changes start with // PandaSpigot start and end with // PandaSpigot end
• If the change isn't obvious, add a small explanation like this: // PandaSpigot start - reason
• One-line changes should have // PandaSpigot at the end of the line.
• Follow Java code style (aka. Oracle style), with some exceptions:
  • If you are modifying upstream files, keep your diff size minimal. Going over 80 characters per line is fine to make this happen.
  • When in doubt or the code around your change is in a clearly different style, use the same style as the surrounding code.

When contributing, please think about the side effects of any changes you write. Plugin compatibility is important, and we wish to minimize any breakage.

Please do not open pull requests for features that you cannot justify the existence of, and the added maintenance costs of that come along with them. If you are thinking of adding a feature that may be controversial, please open an issue first!