The java-edition from srgaabriel

Hexalite Network is an open-source modular network of Minecraft: Java Edition servers inspired by Mineclub, Wynncraft and Origin Realms. This project aims to bring the best experience possible to players without the need of mods.

📚 Table of contents

💻 Technologies / Project stack
✨ Contributors
💸 Supporting
- Starring the repository
- Donations
🏟️ Contributing / Running locally
🏗️ Project structure
🎉 Third party
📜 Licensing

💻 Technologies

The technology stack in this project is pretty straightforward and consists mainly of Rust and Kotlin when talking about programming languages. For transferring data between modules, we use a gRPC server based on prost over the CBOR binary format and compressed data. It is used for requesting data, and communicating between other stuff over RabbitMQ. Every Minecraft server on Hexalite is running on top of the Purpur server software, proxied by Velocity. Purpur is a great alternative for Paper, providing a lot of new features, such as mechanics, performance improvements and useful API changes.

This is subject to change, since this type of infrastructure can improve over time. If you are interested in discussing this or any other technology topics, feel free to join our Discord server to chat with our development and artistic team.

✨ Contributors

_{Pedro Henrique}
💻 🚇 👀 📖 🌍

_Gabriel
💻 🌍

_{Breno S.}
💻 🌍

_Luis
💻

_Herocrife
🎨

🏟️ Contributing / running locally

If you are interested in contributing, please make sure to read our contributing guide and join our Discord community for further information and interaction with the developers and artists, and whoever knows what they are doing.

Prerequisites

Install the latest Early Access Project Panama Java Development Kit Build.
Install the latest version of Google's ProtoBuf source info compiler.
Install the latest nightly build of Rust. You may consider using the rustup tool to make your life easier.
Install Docker and Docker Compose for setting up the development environment in an easier way.

IMPORTANT! A build of JDK with Project Panama is really necessary to run Hexalite locally, since we depend on its nifty features in development which aren't available in other JDK distributions such as Temurin or Azul's for now. You may have issues with the toolchain being not supported by Gradle; if this is the case, you can use Gradle with Java 18, and set org.gradle.java.installations.paths=/path/to/panama/jdk in your ~/.gradle/gradle.properties file.

The reason why we will use the OpenJ9 virtual machine in the future is it is known to use less memory and CPU than Hotspot, so it is a better choice for running Minecraft servers. In contrast to this, the hotspot virtual machine is known to be more stable and more efficient in terms of IDE support, so it is a better choice for developing. Since there is no available build for OpenJ9 with Project Panama, we will use Hotspot for now.

Extra prequisites

You may also be interested on holmgr/cargo-sweep if you actively develop Rust with the nightly toolchain.

Windows:

cargo install -f cargo-binutils
rustup component add llvm-tools-preview

Linux:

clang v12+
rui314/mold

MacOS:

michaeleisel/zld

Developer resources

wiki.vg - Addresses documentation about the Minecraft: Java Edition protocol
Prisma documentation - Addresses documentation about the Prisma ORM
- Prisma Client Rust documentation
The Rust Book - Book to learn how the Rust programming language works
Kotlin language reference - Reference about the Kotlin programming language

Building everything

◉ NOTICE: If you are an IntelliJ IDEA user, make sure to exclude the following directories at the Module Settings (F4):

**/**/target

/target/

/web/node_modules

1. Compiling the command-line interface

The command-line interface is a tool written in Rust highly used in both development and productivity environments on Hexalite. It is a unified interface for doing all necessary things for running Hexalite.

You can start by cloning the repository, which needs Git to be installed in your system: git clone https://git.hexalite.org/java-edition hexalite-java-edition.
Then you can compile all the Rust-based applications by running cd hexalite-java-edition && cargo build --release.
You still need to install some Cargo binary crates though, which you can do by running cargo install cbindgen.

It is done now! You can link the compiled binaries to the $PATH by running the ./scripts/apply_cli.sh command on UNIX-based systems. I'm not too sure in how to do this on Windows, but I'm sure you can find some help there by Googling it, since it doesn't seem that hard.

2. Initializing the environment

After the compilation of the command-line interface, we need to initialize the environment. In this document, we will be referring to the command-line interface command as hexalite. It may be different in your machine if you didn't add it to the $PATH, so it probably it would be ./target/release/hexalite, assuming you already compiled it.

hexalite init ◉ This will initialize the environment, creating the .hexalite folder in your home directory, and symlinking all required files to this folder. You can get further explanation about how the command-line interface works by running hexalite help.

🏗️ Project structure

This section will cover the project structure and the files that are used in the project.

arcade/* - Every single game the Minecraft server has.
cli/* - The command-line interface.
branding - Assets related to the Hexalite branding.
common-* - Common code used in multiple modules.
docker - Compose files for Docker, for an easier setup of the development environment.
docs - Documentation for features used in this project.
kraken - A library for easier Minecraft development.
resource-pack - The source code for the resource pack generator. Output is located at resource-pack/out.
grpc-server - The gRPC server for interacting with the database other stuff.
rest-server - A public version of our gRPC server available as a REST server.
kotlin-grpc-client - A consumer library for our gRPC server.
js-rest-client - A consumer library for our REST server.
reusable-plugins - A collection of reusable plugins for the server.
web - The web interface for the server.
run - A development environment for a Purpur setup.

💸 Supporting

Starring the repository

If you do not want to help us with money, you can just star the repository, it still means a lot to us!

Donations

You can support us by the GitHub sponsors program (pending) or on OpenCollective.

🎉 Third party

We depend on many third party libraries and applications, a complete list can be found here.

📜 Licensing

To know about the license of this project, you can read the LICENSE.md file.

srgaabriel / java-edition Goto Github PK

java-edition's Introduction