Documentation

1.1 Setup

quinilo

28 Apr 2026 — 1 min read

Important

Please note that this documentation ist incomplete because we are changing fundermental stuff. Once we are done, all articles will be updatet and new ones will be added.

Setting up your StreamlineCloud instance can be as easy as downloading and executing one single file or (nearly) as terrifying as installing Arch Linux from scratch. For beginners, we obviously recommend the easy way, but each setup has its own advantages.

Prerequisites:

We recommend at least 4GB of ram and a modern CPU.
A Linux based, modern and secure server operating system. (like Debian 12/13).
A modern version of the Java runtime installed, at least 21. We recommend SdkMan for managing multiple Java instances.
We strongly recommend setting up an additional user for security reasons.

[!] Linux is recommended, Microslop Windows works for local testing but may be unstable - but if you think hosting your server on Windows is a good idea, the problem is likely located between your chair and keyboard. ;-)

The easy way

We assume that you are using a Debain based version of Linux, if you don't you'll probably know what to do instead.

Fist install wget:

apt install wget

Open your user's home folder:

cd ~/

3. Download

StreamlineCloud:
Go to the releases section of this repository and copy the url of the latest release.
You can find the latest release here.

Download the ZIP file:

wget <url>

Unzip it:

unzip streamlinecloud_image.zip

Delete the zip file:

rm streamlinecloud_image.zip

Open the directory:

cd streamlinecloud_image

Now, you can start StreamlineCloud:

java -jar streamlinecloud_<VERSION>.jar

5.3 Load Balancers

With load balancers you can spread your players across multiple proxy servers. The loadbalancers is the first instance the client communicates with. To see a list of your running load balancers just type loadbalancer list Creating a new load balancer loadbalancer create <name> <port> <targetGroup&

5.2 Fallback

Fallback control is an optional feature that automatically stops and starts fallback servers based on the network online count. Fallback servers are your "lobby" servers. You can change your fallback group in the config. Configuring fallback control Just open data/config.json and take a look at the

6.2 Plugins

Implementation Please make sure you have added our repo to your project! Gradle Implementing StreamlineCloudMC dependencies { implementation "net.streamlinecloud:streamlinecloud-mc:BETA-0.5" } Maven Implementing StreamlineCloudMC <dependencies> <dependency> <groupId>net.streamlinecloud</groupId> <artifactId>streamlinecloud-mc</artifactId> <version&

6.1 API Implementation

First you should add the StreamlineCloud repo to your project. Gradle Add the following code to your build.gradle / build.gradle.kts file. repositories { maven { url "https://streamlinecloud.github.io/repo/" } } Maven Add the following code to your pom.xml file. <repositories> <repository> <