whitegrouse / gomint Goto Github PK

GoMint is an open-source Minecraft Bedrock Edition server software implementation that is still work in progress. The goal is to provide a server implementation aiming for performance and stability with support for plugins. Purely written in Java.

Currently, GoMint is in a fast development-mode. The API is in all corners not stable and may change over time. The goal is to develop an API with the implementation problems we face. We will break the API multiple times until we reach the first release. To keep the impact minimal we deprecate symbols and provide better alternatives you can use.

- Deprecated symbols (packages, fields, methods, classes etc.) will be deleted after two weeks of deprecation

Compiling GoMint is actually pretty easy. We'll guide you through the compilation step by step and address troubleshooting.

Prerequisites
For compiling GoMint, you will need some prerequisites:

• Git
• Maven
• JDK 11

Compiling
This project's choice of build tool is Maven. To compile GoMint using Maven follow these steps:

• Open up a terminal
• Change the working directory to the cloned GoMint repository
• Type the following command: mvn clean install (You can append -T 4C if you've got a decent machine)
• Let it compile. This will take some time. Grab a drink and relax.

Troubleshooting
No compile troubleshooting available.

This project's choice of license is BSD 3-Clause. You may find the license file in the project's root directory.