gate

README

Gate (alpha)

Gate is an extensible Minecraft proxy written in Go.

This project is in its early stages, not yet ready for production and subject to have breaking changes, but you can already start playing around with it!

It will be tested & used in production by the Minekube network when there is a "stable enough" release.

Target audiences

• simple Minecraft network admins and
• advanced networks wanting performance while operating at a massive scale

What Gate does

The whole point of a Minecraft proxy is to be able to move players between servers without fully disconnecting them, like switching the world but server-wise.

Similar to the proxies Velocity, BungeeCord, Waterfall etc. Gate delivers rich interfaces to interact with connected players on a network of Minecraft servers.

Therefore, Gate reads all packets send between players (Minecraft client) and servers (e.g. Minecraft spigot, paper, sponge, ...), logs state changes and emits different events that custom plugins/code can react to.

Quick sample setup

This is a simple sample setup of a Minecraft network using Gate proxy.

You will only need a JRE (Java Runtime Environment, 8 or higher).

1. git clone https://github.com/minekube/gate.git
2. Go to docs/sample
3. Open a terminal in this directory and run the pre-compiled executable
   • linux: ./gate
   • windows: gate.exe
   • Or build an executable yourself. ;)
4. Open two terminals, one for each server1 & server2.
   • Run java -jar server.jar to run both servers.

Now you can connect to the network on localhost:25565 with Minecraft version 1.8.9. (Newer versions will be easily supported very, very soon!)

Checkout the /server command (temporarily hardcoded until commands system has been added).

There will be an expressive documentation website for Gate later on!

Known Bugs / Limitations

Remember that Gate is in a very early stage and there are many more things planned (e.g. command system, more events, stability etc.).

• Can't login sometime in online mode.
  • Dev note: Is this due to Mojang API database latencies when replicating data for the hasJoined entpoint?
• Login hangs (Started bridging backend server to player)
  • Please just restart the proxy. (A fix is on the way...)

Extending Gate with custom code

• Native Go
• Script languages

Native Go

You can import Gate as a Go module and use it like a framework in your own external projects.

Go get it into your project

• go get -u go.minekube.com/gate

create a proxy.New(...), register servers and event subscribers and start proxy.Listen(...) for connections.

TODO: code examples

Script languages

To simplify and accelerate customization of Gate there will be added support for scripting languages such as Tango and Lua to extend Gate.

This feature will be added when highly requested.

Anticipated future of Gate

• Gate will be a high performance & cloud native Minecraft Proxy ready for massive scale in the cloud!

• Players can always join and will never be kicked if there is no available server to connect to, or the network is too full. Instead, players will be moved to an empty virtual room simulated by the proxy to queue players to wait.

• Distant future, or maybe not too far? A proxy for Java & Bedrock edition to mix and match players & servers of all kinds. (protocol translation back and forth...)