Documentation
¶
Overview ¶
Package gate is the main package for running one or more Minecraft proxy editions.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var Viper = viper.New()
Viper is a viper instance initialized with defaults for the Config struct. It can be used to load in config files.
Functions ¶
func Start ¶
func Start(stop <-chan struct{}) (err error)
Start is a convenience function to setup and run a Gate instance.
It sets up a Logger, reads in a Config, validates it and sets up os signal handling before starting the instance.
The Gate is shutdown on stop channel close or on occurrence of any significant error. Config validation warnings are logged but ignored.
Types ¶
type Gate ¶
type Gate struct {
// contains filtered or unexported fields
}
Gate manages one or multiple proxy editions (Bedrock & Java).
type Options ¶
type Options struct {
// Config requires a valid Gate configuration.
Config *config.Config
// The event manager to use.
// If none is set, no events are sent.
EventMgr event.Manager
// Logger is the logger used for Gate
// and potential subcomponents.
// If not set, no logging is done.
Logger logr.Logger
}
Options are Gate options.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.