/Tuinity

Minecraft server software fork of Paper to improve performance without behavioural changes.

Primary LanguageShellGNU Lesser General Public License v3.0LGPL-3.0



Fork of Paper aimed at improving server performance at high playercounts.

Java CI IRC Discord

How To (Server Admins)

Tuinity uses the same paperclip jar system that Paper uses.

You can download the latest build of Tuinity by going here.

You can also build it yourself.

How To (Plugin developers)

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-R0.1-SNAPSHOT</version>
    <scope>provided</scope>
 </dependency>

Tuinity-Server maven dependency:

<dependency>
    <groupId>com.tuinity</groupId>
    <artifactId>tuinity</artifactId>
    <version>1.17-R0.1-SNAPSHOT</version>
    <scope>provided</scope>
</dependency>

There is no repository required since the artifacts should be locally installed via building Tuinity.

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.

TODO

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 ./tuinity rb, 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. As such, it contains modifications to it in this project, please see the repository for license information of modified files.

Note