config

Documentation

Index

• Variables
• type API
• type Bedrock
• type Config
  • func (c *Config) Validate() (warns []error, errs []error)
• type Editions
• type HealthService
• type Java

Variables

var DefaultConfig = Config{
	Config: jconfig.DefaultConfig,
	Editions: Editions{
		Java: Java{
			Enabled: true,
			Config:  jconfig.DefaultConfig,
		},
		Bedrock: Bedrock{
			Enabled: false,
			Config:  bconfig.DefaultConfig,
		},
	},
	HealthService: HealthService{
		Enabled: false,
		Bind:    "0.0.0.0:9090",
	},
	Connect: connect.DefaultConfig,
	API: API{
		Enabled: false,
		Config:  api.DefaultConfig,
	},
}

DefaultConfig is a default Config.

Types

type API

type API struct {
	Enabled bool       `json:"enabled,omitempty" yaml:"enabled,omitempty"`
	Config  api.Config `json:"config,omitempty" yaml:"config,omitempty"`
}

API is the configuration for the Gate API.

type Bedrock

type Bedrock struct {
	Enabled bool           `json:"enabled,omitempty" yaml:"enabled,omitempty"`
	Config  bconfig.Config `json:"config,omitempty" yaml:"config,omitempty"`
}

Bedrock edition.

type Config

type Config struct {
	// Config is the Java edition configuration.
	// It is an alias for Editions.Java.Config.
	Config jconfig.Config `json:"config,omitempty" yaml:"config,omitempty"`
	// See Editions struct.
	Editions Editions `json:"editions,omitempty" yaml:"editions,omitempty"`
	// See HealthService struct.
	HealthService HealthService `json:"healthService,omitempty" yaml:"healthService,omitempty"`
	// See Connect struct.
	Connect connect.Config `json:"connect,omitempty" yaml:"connect,omitempty"`
	// See API struct.
	API API `json:"api,omitempty" yaml:"api,omitempty"`
}

Config is the root configuration of Gate.

func (*Config) Validate

func (c *Config) Validate() (warns []error, errs []error)

Validate validates a Config and all enabled edition configs (Java / Bedrock).

type Editions

type Editions struct {
	Java    Java    `json:"java,omitempty" yaml:"java,omitempty"`
	Bedrock Bedrock `json:"bedrock,omitempty" yaml:"bedrock,omitempty"`
}

Editions provides Minecraft edition specific configs. If multiple editions are enabled, cross-play is activated. If no edition is enabled, all will be enabled.

type HealthService

type HealthService struct {
	Enabled bool   `json:"enabled,omitempty" yaml:"enabled,omitempty"`
	Bind    string `json:"bind,omitempty" yaml:"bind,omitempty"`
}

HealthService is a GRPC health probe service for use with Kubernetes pods. (https://github.com/grpc-ecosystem/grpc-health-probe)

type Java

type Java struct {
	Enabled bool           `json:"enabled,omitempty" yaml:"enabled,omitempty"`
	Config  jconfig.Config `json:"config,omitempty" yaml:"config,omitempty"`
}

Java edition.