Genie

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

Contact

IRC | Discord

How To (Server Admins)

NOTE: Genie requires Java 11 or higher.

Genie 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)

Genie is based on Tuinity so 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>ca.spottedleaf.tuinity</groupId>
    <artifactId>tuinity-api</artifactId>
    <version>1.15.2-R0.1-SNAPSHOT</version>
    <scope>provided</scope>
 </dependency>

Tuinity-Server maven dependency:

<dependency>
    <groupId>ca.spottedleaf.tuinity</groupId>
    <artifactId>tuinity</artifactId>
    <version>1.15.2-R0.1-SNAPSHOT</version>
    <scope>provided</scope>
</dependency>

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

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 11+ installed to compile (and jre 11 to run)
• Anything else that paper requires to build

If all you want is a paperclip server jar, just run ./genie jar

Otherwise, to setup the Genie-API and Tuinity-Server repo, just run the following command in your project root ./genie patch additionally, after you run ./tuinity patch you can run ./genie build to build the respective api and server jars.

./genie patch should initialize the repo such that you can now start modifying and creating patches. The folder Genie-API is the api repo and the Genie-Server folder is the server repo and will contain the source files you will modify.

Creating a patch

Patches are effectively just commits in either Genie-API or Genie-Server. To create one, just add a commit to either repo and run ./genie 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.

Everything else is licensed under the MIT license, except when note otherwise. See https://github.com/starlis/empirecraft and https://github.com/electronicboy/byof for the license of material used/modified by this project.

Note

The fork is based off of aikar's EMC framework found here