Hub

This project allows to turn-on a minecraft server as a lobby for a party server.

Tools

The server is built using Kotlin and Minestom. The version of tools used is specified in the build.gradle.kts file.

The entrypoint of the program is located here.

How to use

In order to use the Hub server, you need to compile the program using gradle command:

gradle shadowJar
# or
gradlew shadowJar

When the compilation is done, a jar file will be generated in the build/libs folder.

We advise you to move this jar file in a empty directory to turn-on the server.

To turn-on the server, you need to execute the following command:

java -jar hub.jar

When you execute for the first time the server, a configuration file will be generated in the same directory.

You can modify this file to change the server configuration.

Configuration

You can retrieve the default configuration file here.

The configuration is generated automatically when you execute the server for the first time. The format used is HOCON.

When you execute the server, it will load the configuration named server.conf. However, you can define another configuration file to use with the following command:

java -jar hub.jar /path/to/config/file.conf

Test

The code is tested using JUnit and can be executed using the following command:

gradle test
# or
gradlew test