Gate Minecraft Proxy

You can install Gate using several methods depending on your platform:

• Go: Use go run to execute the latest version directly.
• Linux/macOS: Use curl to pipe the installation script to bash.
• Windows: Use powershell to pipe the installation script to iex.

# 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"

If you are building your own Gate-powered project or plugin, use the official starter template to begin development. You can fork the template at minekube/gate-plugin-template on GitHub.

# Fork the template to get started
# https://github.com/minekube/gate-plugin-template

Gate provides built-in Bedrock Edition support using integrated Geyser and Floodgate technology. This allows Bedrock players (Mobile, Console, Windows) to join Java Edition (PC) servers without requiring additional plugins.

To enable this feature, set bedrock to true in your configuration.

bedrock: true

The Source interface represents the entity invoking a command. It can be a player or the server console/terminal.

Any type implementing Source must satisfy:

1. permission.Subject: To allow for permission-based command requirements.
2. SendMessage(msg component.Component, opts ...MessageOption) error: To allow the command to communicate back to the invoker.

Functions like SourceFromContext and ContextWithSource allow you to safely retrieve or inject the Source into a context.Context for use within command handlers.

Gate can handle protocol translation using managed vialite. This allows Java clients to connect to backend servers running different Minecraft versions without needing a separate Via sidecar.

When enabled, Gate automatically manages the vialite subprocess: it resolves the latest stable release, downloads the checksummed artifact to a local cache, and routes backend connections through it.

To enable managed Via in classic proxy mode, use the following configuration:

config:
  via:
    enabled: true

Gate is a high-performance Minecraft proxy. You can run it using the gate command. The CLI supports configuration via files (YAML, JSON), environment variables, and command-line flags. Flags provided at runtime will overwrite values found in the configuration file.

# Run with default config (./config.yml)
gate

# Run with a specific config file
gate --config ./my-config.yaml

# Run with debug mode enabled
gate --debug

# Show version
gate --version

The following fields are used in the VELOCITY_SYNC.md log to track upstream synchronization and reviews.

| Field | Applies to | Meaning |
|---|---|---|
| `date` | both | ISO `YYYY-MM-DD` of the sync or review |
| `kind` | both | `sync` or `review` |
| `summary` | both | What was ported, or what was reviewed and why it was not ported |
| `upstream_commit` | `sync` | Full 40-hex upstream SHA that was ported |
| `gate_commit` | `sync` | Full 40-hex Gate SHA that landed it |
| `gate_pr` | `sync` | Gate PR number |
| `upstream_range` | `review` | The upstream range examined |
| `upstream_commit_count` | `review` | How many commits the range held |
| `ported` | `review` | `none`, or what was taken from the range |

The gate binary is the entrypoint for the Gate Minecraft Proxy. It uses the gate.Execute() function to initialize and run the command-line interface, which handles proxy configuration, management, and execution.

package main

import (
	"go.minekube.com/gate/cmd/gate"
)

func main() {
	gate.Execute()
}