Matherionity

This Tuinity fork is no longer used on the Matherion.eu servers. The development team will not continue development.

The truly batteries-included Paper/Tuinity fork.

The new API

While the old, legacy Bukkit API is still accessible and will continue to be updated, when making new plugins, you can choose to use the new API. The new API is not fully complete though, as Matherionity is in early development. Also some parts of the API are subject to change, however that may only happen in major releases.

Features

Redis
Database Connection (ORM Lite Entity Framework)
New Plugin Manager, inspired by Velocity (TBD)
Server Sync through network

Requirements

Java 15+
- Though Matherionity will most likely work with older versions, it is not supported and the CI is only setup to make Java 15 builds. If you want to use older Java versions, you will have to build it manually.
MySQL
Redis

Development Requirements:

Maven
Git
Bash
GNU Patch

Getting started

Assuming you have a Matherionity jar, create a new folder with it inside. Open your terminal and enter:

$ java -jar matherionity.jar

This will start the Matherionity server.

Development

Matherionity uses patches. To learn more about them, see Understanding Patches.

In the folder root, you will have a tuinity shell script which is useful for development.

Compiling the JAR

If you just want to compile the jar, use:

$ ./tuinity jar

Note: In Windows, please use Git Bash.

Modifying the code

If you want to modify the code, use:

$ ./tuinity apply

This command will prepare everything for you and apply all patches. Once it's finished, you will see two folders - Tuinity-Server & Tuinity-API.

Rebuilding patches

To rebuild all patches, first commit in the Tuinity-Server and/or Tuinity-API repository. Then, use:

$ ./tuinity rebuild

This will rebuild all patches.

The API

Database

Matherionity uses ORMLite for all database actions. In order to use the database, you will have to create a model (essentially just a POJO with few annotations).

For example:

package eu.matherion.plugin.db;

import com.j256.ormlite.field.DatabaseField;
import com.j256.ormlite.table.DatabaseTable;

@DatabaseTable
class User {

    @DatabaseField(id = true)
    private Integer id;

    @DatabaseField(unique = true)
    private String username;

    @DatabaseField
    private String password;
    
    public Integer getId() {
        return id;
    }
    
    // ...
}

In your Main class, register the model like this:

package eu.matherion.plugin;

import eu.matherion.plugin.db.User;
import org.bukkit.plugin.JavaPlugin;
import java.util.List;

class Main extends JavaPlugin {

    @Override
    public List<Class> provideDatabaseEntities() {
        return List.of(User.class);
    }

}

And that's it. Now, how the heck do I make queries? For that, you can access the DatabaseManager through Server#getDatabaseManager(). The DatabaseManager has a getDao(Class) function. Use it to get a DAO (Data Access Object) class for your model (in this case User).

package eu.matherion.plugin;

// ...

import com.j256.ormlite.dao.Dao;

class Main extends JavaPlugin {

    // ...

    @Override
    public void onEnable() {
        // Integer is the ID type, User is the model
        Dao<User, Integer> userDao = Bukkit.getServer().getDatabaseManager().getDao(User.class);
    
        // Creating users:
        User newUser = userDao.create(new User(/* your logic to create the User class */));
        
        // Updaing users:
        User existingUser = /* your logic to fetch the user */;
        existingUser.username = "different username";
        userDao.update(existingUser);
    
        // Fetching users:
        userDao.queryForEq("username", "username"); // get by row, value
        userDao.queryForAll(); // get all
        userDao.queryForId(1); // get by id
        userDao.queryForSameId(/* another User */); // get by the same id as another User class instance
    }

}

For more info, please refer to the ORMLite Documentation or JavaDocs.

If you however need to use the raw connection, you can get a eu.matherion.api.database DatabaseConnection via DatabaseManager#getConnection(). DatabaseConnection is a small interface providing DatabaseManager with Java's Connection. The default implementation (eu.matherion.server.database.impl.HikariConnection) uses HikariCP, but if you want to create the connection differently or use a different SQL database, you can create your own implementation.

matherioneu / matherionity