Skip to content

Latest commit

 

History

History
32 lines (24 loc) · 2.39 KB

README.md

File metadata and controls

32 lines (24 loc) · 2.39 KB
Raw

Firework

firework_rocket Firework is a new Paper-based server software derived from Purpur. Firework un-patches many controversial changes introduced in upstream server softwares, such as duplication patches and changes to mob spawning behaviors. Firework aims to restore vanilla-like behavior while maintaining the excellent performance gains introduced by Spigot and Paper. It also preserves the extreme customizability introduced with Purpur. We sincerely hope you enjoy playing on Firework as much as we enjoy developing it!

Firework is developed in collaboration with nota-noob for the Outcast SMP.

Downloads

Stable

We recommend grabbing the stable server JAR for Firework from GitHub Releases.

Bleeding-Edge

If you'd like to live on the bleeding-edge of Firework development, grab the server JAR from GitHub Actions. These versions are not be extensively tested and may contain server-breaking bugs!

Contributing

Issues

If you found a bug, performance problem, or the server JAR crashes, please report file an issue report on Github Issues. If you'd like your issue to be resolved as fast as possible, please include all information relevant to your issue.

Pull Requests

We welcome all pull requests! Please make sure that your pull request adds a feature or solves an issue. Pull requests linked with issues are especially appreciated!

Compiling

Patches are server extensions, which can be found in the /patches directory.

To generate your own JAR from Firework's source code, run these commands in the root directory of your downloaded Firework folder:

./gradlew applyPatches
./gradlew build
./gradlew createReobfPaperclipJar

The generated JAR file should be located in the /build/libs directory and named firework-paperclip-*.jar. You can either point your launch script to this new JAR or rename it to something else, such as server.jar.

License

This repository is licensed under the MIT license. All current patches are licensed under the MIT license, but upstream patches may be licensed differently. Please refer to the patch headers for patch-specific licenses.