Skip to content

Repository files navigation

SimpleCloud Gate

Banner


SimpleCloud Gate is Minekube Gate with SimpleCloud plugins built in.

Features

  • Automatic SimpleCloud server registration
  • Player routing, join targets, and kick fallbacks
  • Configurable commands such as /lobby
  • Support for existing Connection plugin v2 configs

Installation

Download the binary for your platform from GitHub Releases. On Linux or macOS, make it executable and start it with your network settings:

chmod +x gate_0.74.9_linux_amd64
export SIMPLECLOUD_NETWORK_ID="your-network-id"
export SIMPLECLOUD_NETWORK_SECRET="your-network-secret"
./gate_0.74.9_linux_amd64

Use the filename for your platform. Configuration files are created in simplecloud-connection/ on first startup. By default, joins, /lobby, and fallbacks use servers whose names start with lobby.

See the configuration guide for settings and compatibility.

Using your own plugins

In your Gate project, add our Connection plugin as a dependency:

go get github.com/simplecloudapp/simplecloud-gate@v0.74.9

Import it in your entry point:

import connection "github.com/simplecloudapp/simplecloud-gate/plugins/connection-plugin"

Register it alongside your own proxy.Plugin before starting Gate:

proxy.Plugins = append(proxy.Plugins, connection.Plugin, myPlugin)
gate.Execute()

Replace myPlugin with your plugin, then build with go build .. Plugins are compiled into the binary. Our configuration stays in simplecloud-connection/.

Releases

Depot CI checks for Gate updates daily. Releases use the same versions, binary names, and platforms as Gate, with SimpleCloud plugins included. See release maintenance for workflow setup and manual runs.

Contributing

Read our Contribution Guide before contributing.

git clone https://github.com/simplecloudapp/simplecloud-gate.git
cd simplecloud-gate
go build ./...
go test ./...
go vet ./...
python3 -m unittest discover -s scripts -p '*_test.py'

Use the Go version declared in go.mod or newer. Each SimpleCloud plugin has its own folder under plugins/, starting with plugins/connection-plugin.

License

This repository is licensed under the MIT License.

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages