https://github.com/byteflux/nozzle
An experimental fork of Paper used for testing performance fixes and feature ideas.
https://github.com/byteflux/nozzle
Last synced: 12 months ago
JSON representation
An experimental fork of Paper used for testing performance fixes and feature ideas.
- Host: GitHub
- URL: https://github.com/byteflux/nozzle
- Owner: Byteflux
- Created: 2020-01-06T21:52:47.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-11-21T03:55:47.000Z (over 5 years ago)
- Last Synced: 2025-03-11T20:46:03.310Z (over 1 year ago)
- Language: Shell
- Homepage:
- Size: 51.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Nozzle
An experimental fork of [Paper](https://github.com/PaperMC/Paper) used for testing performance fixes and feature ideas. Nozzle is a personal project and does **not** come with any promise of support. Contributions are reviewed and considered.
If you're a casual user looking for a well-supported, modern server software, please consider using Paper. It's actively maintained by a fantastic team with support offered over [Discord](https://discord.gg/papermc).
## Compiling
At this time there aren't any official precompiled builds of Nozzle hosted anywhere. The only officially supported method of obtaining a build of Nozzle is to compile it yourself.
### Requirements:
* [Java Development Kit 8](https://adoptopenjdk.net/) or higher (must be JDK, not JRE)
* [Maven 3](https://maven.apache.org/download.cgi)
* Git
* Bash
**Windows users:** If you're trying to compile Nozzle on Windows, it's recommended that you use either [Git for Windows](https://gitforwindows.org/) or [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/about) for Git and Bash.
#### Clone the repository:
```
git clone https://github.com/Byteflux/Nozzle.git
```
#### Compile the server jar:
Make sure you're working within the cloned Nozzle repository.
```
cd Nozzle/
```
The following command will perform any necessary setup and build the server jar.
```
./nozzle jar
```
Upon a successful build, the server jar will be located at `Nozzle-Server/target/nozzle.jar`.
## Contributing
The process for editing and creating patches for contribution is identical to Paper. Please refer to [Paper's documentation](https://github.com/PaperMC/Paper/blob/master/CONTRIBUTING.md) to learn more, replacing references to Paper with Nozzle where appropriate.