Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rgst-io/minecraft-preempt

Automatically start your minecraft server when a user joins
https://github.com/rgst-io/minecraft-preempt

minecraft minecraft-realms

Last synced: 3 months ago
JSON representation

Automatically start your minecraft server when a user joins

Host: GitHub
URL: https://github.com/rgst-io/minecraft-preempt
Owner: rgst-io
License: gpl-3.0
Created: 2019-08-04T08:27:29.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2024-09-13T14:56:40.000Z (5 months ago)
Last Synced: 2024-09-14T05:41:54.177Z (5 months ago)
Topics: minecraft, minecraft-realms
Language: Go
Size: 521 KB
Stars: 20
Watchers: 3
Forks: 4
Open Issues: 2
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        # minecraft-preempt

A lightweight Minecraft server manager. Starts a server when users join, and stops them when they leave.

## Supported Clouds

- `gcp`

- `docker`

## Usage

**Hint**: There's an example configuration in [`./config`](./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