Tuinity uses the same paperclip jar system that Paper uses.
You can download the latest build (1.17.x) of Tuinity by going here
You can also build it yourself.
In order to use Tuinity as a dependency you must build it yourself. Each time you want to update your dependency you must re-build Tuinity.
Tuinity-API maven dependency:
<dependency>
<groupId>com.tuinity</groupId>
<artifactId>tuinity-api</artifactId>
<version>1.17.1-R0.1-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
Tuinity-Server maven dependency:
<dependency>
<groupId>com.tuinity</groupId>
<artifactId>tuinity</artifactId>
<version>1.17.1-R0.1-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
TODO nms
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 (andjre
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:
gradlew applypatches
gradlew build
gradlew paperclipjar
Once all 3 steps complete successfully, tuinity-paperclip.jar
will be placed into
the project root directory
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.
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. As such, it contains modifications to it in this project, please see the repository for license information of modified files.