Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tuinity/tuinity
Minecraft server software fork of Paper to improve performance without behavioural changes.
https://github.com/tuinity/tuinity
bukkit burritos craftbukkit hacktoberfest java minecraft minecraft-api minecraft-performance minecraft-server paper-fork
Last synced: about 4 hours ago
JSON representation
Minecraft server software fork of Paper to improve performance without behavioural changes.
- Host: GitHub
- URL: https://github.com/tuinity/tuinity
- Owner: Tuinity
- License: lgpl-3.0
- Archived: true
- Created: 2018-12-15T05:19:03.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-08-29T21:41:17.000Z (about 3 years ago)
- Last Synced: 2024-09-27T11:42:29.461Z (about 4 hours ago)
- Topics: bukkit, burritos, craftbukkit, hacktoberfest, java, minecraft, minecraft-api, minecraft-performance, minecraft-server, paper-fork
- Language: Shell
- Homepage:
- Size: 3.57 MB
- Stars: 756
- Watchers: 41
- Forks: 185
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: licenses/GPL.md
Awesome Lists containing this project
README
## How To (Server Admins)
Tuinity uses the same paperclip jar system that Paper uses.
You can download the latest build (1.17.x) of Tuinity by going [here](https://ci.codemc.io/job/Spottedleaf/job/Tuinity-1.17/)
You can also [build it yourself](https://github.com/Tuinity/Tuinity#building).
## How To (Plugin developers)
In order to use Tuinity as a dependency you must [build it yourself](https://github.com/Tuinity/Tuinity#building).
Each time you want to update your dependency you must re-build Tuinity.
Tuinity-API maven dependency:
```xml
com.tuinity
tuinity-api
1.17.1-R0.1-SNAPSHOT
provided
```
Tuinity-Server maven dependency:
```xml
com.tuinity
tuinity
1.17.1-R0.1-SNAPSHOT
provided
```
TODO nms
## Building
Requirements:
- You need `git` installed, with a configured user name and email.
On Windows you need to run from git bash.
- You need `maven` installed.
- You need `jdk` 16+ installed to compile (and `jre` 16+ to run).
- Anything else that `paper` requires to build.
To set up the `Tuinity-API` and `Tuinity-Server` repo to begin editing/reading source code,
clone the Tuinity repo and run `gradlew applypatches` from the root directory.
To build Tuinity, run the following commands in the root directory after cloning the
Tuinity repo:
1. `gradlew applypatches`
2. `gradlew build`
3. `gradlew paperclipjar`
Once all 3 steps complete successfully, `tuinity-paperclip.jar` will be placed into
the project root directory
#### Creating a patch
Patches are effectively just commits in either `Tuinity-API` or `Tuinity-Server`.
To create one, just add a commit to either repo and run `./gradlew rebuildpatches`, and a
patch will be placed in the patches folder. Modifying commits will also modify its
corresponding patch file.
## License
The PATCHES-LICENSE file describes the license for api & server patches,
found in `./patches` and its subdirectories except when noted otherwise.
The fork is based off of PaperMC's fork example found [here](https://github.com/PaperMC/paperweight-examples).
As such, it contains modifications to it in this project, please see the repository for license information
of modified files.
