Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hpfxd/pandaspigot

Fork of Paper for 1.8.8 focused on improved performance and stability.
https://github.com/hpfxd/pandaspigot

bukkit java minecraft paper paperspigot pvp spigot

Last synced: about 1 month ago
JSON representation

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

Awesome Lists containing this project

README

        

# PandaSpigot [![Build](https://img.shields.io/github/actions/workflow/status/hpfxd/PandaSpigot/build.yml?branch=master&label=Build)](https://github.com/hpfxd/PandaSpigot/actions/workflows/build.yml) [![Discord](https://img.shields.io/discord/1048733138655924274?label=Discord)](https://discord.gg/m6vCCX6Hvr) [![Servers](https://img.shields.io/bstats/servers/15154?label=Servers)](https://bstats.org/plugin/bukkit/PandaSpigot/15154)
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](./patches/).

## Using
You can download the latest pre-built server JAR by clicking the download button below.
[![Download](https://custom-icon-badges.demolab.com/badge/-Download-blue?style=for-the-badge&logo=download&logoColor=white)](https://downloads.hpfxd.com/v2/projects/pandaspigot/versions/1.8.8/builds/latest/downloads/paperclip)

For support, please join our [Discord](https://discord.gg/m6vCCX6Hvr).

## API
See our API patches [here](./patches/api/).

Maven

```xml


hpfxd-repo
https://repo.hpfxd.com/releases/


com.hpfxd.pandaspigot
pandaspigot-api
1.8.8-R0.1-SNAPSHOT
provided

```

Gradle (kts)

```kotlin
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](https://github.com/PaperMC/Paper/blob/ver/1.16.5/CONTRIBUTING.md), 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!