README
¶
minecraft-preempt
A lightweight Minecraft server manager. Starts a server when users join, and stops them when they leave.
Supported Clouds
gcpdocker
Usage
Hint: There's an example configuration in ./config.
First, define a configuration file for your server. The format is like so:
Top level
| Key | Description |
|---|---|
listenAddress |
The address to listen on. |
servers |
Array of all servers |
Server
| Key | Description |
|---|---|
hostname |
The hostname of the server. |
listenAddress |
The address to listen on. |
gcp |
The GCP configuration |
docker |
The Docker configuration |
whitelist |
List of users allowed to connect |
Cloud Configurations
GCP
| Key | Description |
|---|---|
project |
The GCP project ID |
zone |
The GCP zone |
instance |
The GCP instance name |
Docker
| Key | Description |
|---|---|
containerID |
Container ID or name |
Specifying a configuration can be done with --config, for a file path.
Or, for serverless environments, the config can be specified with the
CONFIG environment variable.
License
GPL-3.0
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
minecraft-preempt
Package main implements a minecraft server proxy that proxies connections to relevant servers, stopping and starting them as needed.
|
Package main implements a minecraft server proxy that proxies connections to relevant servers, stopping and starting them as needed. |
|
minecraft-preempt-agent
Package main implements a lightweight agent that runs a minecraft server (via docker-compose) and handles shutting down the server when the proxy informs it to.
|
Package main implements a lightweight agent that runs a minecraft server (via docker-compose) and handles shutting down the server when the proxy informs it to. |
|
internal
|
|
|
cloud
Package cloud contains the interfaces and shared types between cloud providers.
|
Package cloud contains the interfaces and shared types between cloud providers. |
|
version
Package version contains the version of the program.
|
Package version contains the version of the program. |
Click to show internal directories.
Click to hide internal directories.