README
¶
The extensible Minecraft Proxy
Gate is an extensible, high performant & paralleled Minecraft proxy server with scalability, flexibility, cross-platform compatibility & excellent server version support - written in Go and ready for the cloud!
Website & Documentation
There is a lot to discover on Gate's website. Please refer to the website for the documentation, guides and any more information needed!
Quick Start
Follow our quick start guide on creating a simple Minecraft network!
| Platform | Installation Command |
|---|---|
| Go | go run go.minekube.com/gate@latest |
| Linux/macOS | curl -fsSL https://gate.minekube.com/install | bash |
| Windows | powershell -c "irm https://gate.minekube.com/install.ps1 | iex" |
Bedrock Cross-Play Support
Gate includes built-in Bedrock Edition support through Geyser enabling cross-play between Java Edition (PC) and Bedrock Edition (Mobile, Console, Windows) players through integrated Geyser & Floodgate technology - zero plugins required!
See the Bedrock Guide for setup instructions.
graph LR
A[Java Players<br/>PC] -->|25565| D(Gate Proxy)
B[Bedrock Players<br/>Mobile/Console/Win] -->|19132| C(Geyser)
C -->|25567| D
D -->|Java Protocol| E[Backend Server<br/>Paper/Spigot/Vanilla]
style A fill:#b36b00,stroke:#333,stroke-width:2px
style B fill:#007a7a,stroke:#222,stroke-width:2px
style C fill:#1e90ff,stroke:#222,stroke-width:2px
style D fill:#2e8b57,stroke:#222,stroke-width:2px
style E fill:#a0526d,stroke:#222,stroke-width:2px
Gate Lite Mode
Gate has a Lite Mode which is a lightweight version of Gate that can expose multiple Minecraft servers through a single port and IP address and reverse proxy players to backend servers based on the hostname/subdomain they join with.
See the Lite Mode guide for more information.
graph LR
A[Player Alice] -->|Join example.com| C(Gate Lite)
B[Player Bob] -->|Join my.example.com| C(Gate Lite)
C -->|10.0.0.1| D[Backend A]
C -->|10.0.0.2| E[Backend B]
C -->|10.0.0.3| F[Another Proxy]
linkStyle 0 stroke:orange
linkStyle 1 stroke:purple
linkStyle 2 stroke:purple
linkStyle 3 stroke:orange
Developers Starter Template
The starter template is designed to help you get started with your own Gate powered project. Fork it! 🚀 - minekube/gate-plugin-template
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
pkg
|
|
|
configs
Package configs provides embedded default configuration files.
|
Package configs provides embedded default configuration files. |
|
edition
Package edition contains packages implementing a proxy for different Minecraft editions.
|
Package edition contains packages implementing a proxy for different Minecraft editions. |
|
edition/java/auth
Package auth provides a way to authenticate joining online mode players with Mojang's session server.
|
Package auth provides a way to authenticate joining online mode players with Mojang's session server. |
|
edition/java/bossbar
Package bossbar provides a way to create and manage Minecraft boss bars for players.
|
Package bossbar provides a way to create and manage Minecraft boss bars for players. |
|
edition/java/forge/modinfo
Package modinfo provides mod information used in Forge ping responses.
|
Package modinfo provides mod information used in Forge ping responses. |
|
edition/java/proto/packet/title
Package title contains title packets.
|
Package title contains title packets. |
|
edition/java/proto/version
Package version contains helpers for working with the Minecraft Java edition versions Gate supports.
|
Package version contains helpers for working with the Minecraft Java edition versions Gate supports. |
|
edition/java/proxy
Package proxy contains Gate's Minecraft Java edition proxy implementation.
|
Package proxy contains Gate's Minecraft Java edition proxy implementation. |
|
edition/java/sound
Package sound provides a way to play and stop sounds for Minecraft players.
|
Package sound provides a way to play and stop sounds for Minecraft players. |
|
edition/java/title
Package title provides functionality for showing Minecraft titles for players.
|
Package title provides functionality for showing Minecraft titles for players. |
|
gate
Package gate is the main package for running one or more Minecraft proxy editions.
|
Package gate is the main package for running one or more Minecraft proxy editions. |
|
internal/bufpool
Package bufpool - All credits go to https://github.com/valyala/bytebufferpool.
|
Package bufpool - All credits go to https://github.com/valyala/bytebufferpool. |
|
internal/randstr
Package randstr provides basic functions for generating random bytes, string
|
Package randstr provides basic functions for generating random bytes, string |
|
internal/reload
Package reload provides configuration reloading capabilities.
|
Package reload provides configuration reloading capabilities. |
|
util/connectutil
Package connectutil provides a reference implementation for Connect integrated with the Gate proxy.
|
Package connectutil provides a reference implementation for Connect integrated with the Gate proxy. |
|
util/connectutil/single
Package single combines connect.EndpointAcceptor and connect.TunnelAcceptor into Acceptor allowing to run WatchService and TunnelService in the same instance.
|
Package single combines connect.EndpointAcceptor and connect.TunnelAcceptor into Acceptor allowing to run WatchService and TunnelService in the same instance. |
|
util/permission
Package permission is a utility package that defines primitives to allow checking a Subject for a permission.
|
Package permission is a utility package that defines primitives to allow checking a Subject for a permission. |