Structure

If you installed via the CLI, you don't have to follow these steps. However, it is advised to still read through it, so you know how SimpleCloud operates.

To make SimpleCloud work, we utilize a Controller (formerly known as Master), that manages server starts and handles API calls and Groups. This Controller itself is not able to start servers, so for it to do something you need a Server Host Droplet (formerly known as Wrapper). This droplets main objective is to actually start Servers, therefore templates are also managed by this droplet. This means you can easily implement Multi-Root by just starting up a Server Host Droplet on each root server.

Before you read further, please first understand how Controller and Server Host Droplet operate.

File structure

We advise you to structure your files like this, as it works best in our experience

.
├── controller-runtime.jar
├── droplets/
│   └── serverhost-droplet/
│       ├── serverhost-droplet.jar
│       ├── config.yml
│       ├── cache
│       ├── options/
│       │   ├── configurators/
│       │   │   ├── spigot.yml
│       │   │   ├── ...
│       │   │   └── velocity.yml
│       │   ├── lobby.yml
│       │   └── proxy.yml
│       └── templates/
│           ├── lobby.yml
│           └── proxy.yml
├── templates/
│   ├── lobby/
│   │   └── ...
│   └── proxy/
│       └── ...
├── groups/
│   ├── lobby.yml
│   └── proxy.yml
└── running/
    ├── lobby/
    │   └── lobby-1/
    │       └── ...
    └── proxy/
        └── proxy-1/
            └── ...

To achieve this file structure, start up the controller jar in your installation dir.

screen -S controller java -jar controller-runtime

This will generate all needed files. Now stop the controller using CTRL+C, and drop the Server Host Droplet jar into droplets/serverhost-droplet. You can now start Controller and Server Host Droplet, to get a running SimpleCloud instance!

# example command starting the controller in a screen
screen -S controller java -jar controller-runtime

# example starting the serverhost in a screen
# to achieve our advised structure, you need to use
# the TEMPLATE_PATH and RUNNING_PATH options
screen -S serverhost java -jar droplets/serverhost-droplet/serverhost-droplet.jar --TEMPLATE_PATH "../../templates" --RUNNING_PATH "../../running"

If you dont want to execute these commands every time, you can use our Runner