Skip to content

A simple, modular and leightweight Minecraft cloud system desgined for being high-available, easy to use and easy to extend.

License

Notifications You must be signed in to change notification settings

BLUEAMETHYST-Studios/bluecloud

Repository files navigation

Logo by Bing AI

🔮 BlueCloud

Version Discord server License: GPL v3

A simple, modular and leightweight Minecraft cloud system desgined for being high-available, easy to use and easy to extend.

Warning

Do not use the cloud yet, it's still work in progress.

🎯 Goals

Our goals is not to create a production-ready cloud system. We want to learn more about backend development. If you are searching for a production-ready cloud system, you should take a look at nextCluster.

🍏 Features

Feature Description Status
Runner The module that handles process creation. 🚧
API A api for developers using dependency injection. 🚧
Wrapper The wrapper between the node and the runner. 🚧
Node The main part of the cloud system. 🚧
Templates A template system for services.
Sync A synchronisation service for the cloud system. (e.g. Netty)
CLI A command line interface for the cloud system.
Website A website for this project.
Dashboard A web interface for managing the cloud.
Modules A module system for the cloud system
Docker A Docker wrapper for cloud services.
Kubernetes A Kubernetes wrapper for cloud services.

📦 Modules

Module Description Status
Rest-API A rest api for the cloud system.
Proxy-Module A module consisting of an maintenance, motd and tablist system.
NPCs An NPC system that gives players the opportunity to connect to other servers.
Signs An Sign system that gives players the opportunity to connect to other servers.
Ingame-Notify A ingame notification system (e.g. when a cloud service starts).
Webhook-Notify A webhook for notifications (e.g. when a cloud service starts).
GeyserMC-Integration An integration for GeyserMC Standalone as a module.
Scaling An autoscaling solution for BlueCloud.

📱 Platforms

Note

Bedrock platforms are planned for the future.

Platform Description Status
Velocity A modern Minecraft Proxy solution. 🚧
PaperMC A modern Spigot Fork. 🚧
FabricMC A modern modded Minecraft Server solution.

⬇️ Installation

Currently, you have to compile it yourself.

git clone https://github.com/BLUEAMETHYST-Studios/bluecloud.git
cd bluecloud
./gradlew build

😎 Develop with BlueCloud

Module Description available on
api The API for developers using dependency injection. Modules, Plugins
node Could be used for modules. Modules
runner Could be used to implement new ServiceProcessTypes. Modules
wrapper Could be used to modify the Wrapper logic. Modules
common Contains useful utilities. - unsafe to use! Modules

🚧 Dependencies

Important

Since this cloud system is not production-ready, we do not provide any dependencies. If you still want to use it you can push it to your MavenLocal by using gradlew :api:publishToMavenLocal.

Maven
<dependencies>
    <dependency>
        <groupId>me.blueamethyst.bluecloud</groupId>
        <artifactId>api</artifactId>
        <version>${VERSION}"</version>
        <scope>provided</scope>
    </dependency>
</dependencies>
Gradle
dependencies {
    compileOnly 'me.blueamethyst.bluecloud:api:${VERSION}'
}
Gradle (KTS)
dependencies {
    compileOnly("me.blueamethyst.bluecloud:api:${VERSION}")
}

About

A simple, modular and leightweight Minecraft cloud system desgined for being high-available, easy to use and easy to extend.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages