Giter Club home page Giter Club logo

tuinity's Introduction

Tuinity

Fork of paper, aimed at improving server performance at high playercounts. The fork is based off of aikar's EMC framework found here: https://github.com/starlis/empirecraft

Note that this project requires java 11+.

Contact

IRC | Discord

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.

Plugin developers

In order to use Tuinity as a dependency you must following the steps laid out in Building and setting up and build tuinity. 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 tuinity.

Building and setting up

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

Run the following commands in the root directory:

./tuinity patch

This should initialize the repo such that you can now start modifying and creating patches. The folder Tuinity-API is the api repo and the Tuinity-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 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.

Building

Use the command ./tuinity build to build the api and server. Compiled jars will be placed under Tuinity-API/target and Tuinity-Server/target.

To get a paperclip jar, run ./tuinity jar.

tuinity's People

Contributors

spottedleaf avatar jroy avatar electronicboy avatar denwav avatar clrxbl avatar stephan-gh avatar silverwolfg11 avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.