The configuration file is automatically created in the working directory.
The file name is config.json.
This is an example configuration file with two servers. Remember to install the chat command plugin if you need it and to configure the permissions.
{
"Servers": {
"ServerName1": {
"Addr": "minetest.local:30000"
},
"ServerName2": {
"Addr": "minetest.local:30001"
}
}
}The configuration file contains JSON data. The fields are as follows.
NoPlugins
Type: bool
Default: false
Description: Plugins are not loaded if this is true.
NoAutoPlugins
Type: bool
Default: false
Description: Plugin subdirectories are not built automatically if this is true.
CmdPrefix
Type: string
Default: ">"
Description: A chat message is handled as a chat command
if it is prefixed by this.
RequirePasswd
Type: bool
Default: false
Description: Empty passwords are rejected if this is true.
SendInterval
Type: float32
Default: 0.09
Description: The recommended send interval for clients.
The proxy itself doesn't have a fixed send interval.
UserLimit
Type: int
Default: 10
Description: The maximum number of players that can be connected to the proxy
at the same time.
AuthBackend
Type: string
Default: "files"
Values: "files", "mtsqlite3", "mtpostgresql"
Description: The authentication backend to use.
Consider converting your existing database instead of loading it directly.
AuthPostgresConn
Type: string
Default: ""
Description: The postgres connection string for the authentication database.
Used in conjunction with the mtpostgresql authentication backend.
BindAddr
Type: string
Default: ":40000"
Description: The proxy will listen for new clients on this address.
DefaultSrv
Type: string
Default: ""
Description: The default server to connect new clients to. May be a group.
SrvSelector
Type: string
Default: ""
Description: The server selection handler to use for new clients.
Only useful when combined with a plugin providing a handler with that name.
Servers
Type: map[string]Server
Default: map[string]Server{}
Description: The list of internal servers served by this proxy.
The first server is the default server new clients are connected to.
Server.Addr
Type: string
Default: ""
Description: The network address and port of an internal server.
Server.MediaPool
Type: string
Default: Server name (map key)
Description: The media pool this server is part of.
See [media_pools.md](https://github.com/HimbeerserverDE/mt-multiserver-proxy/blob/main/doc/media_pools.md)
for more information.
Server.Groups
Type: []string
Default: []string{}
Description: The server groups this server is in. Group hopping and default server
selection accept server groups on top of regular server names,
randomly choosing one of its servers. If a server name and a group name
are in conflict, the server name is preferred.
This feature can be used to implement simple load balancing.
See [server_groups.md](https://github.com/HimbeerserverDE/mt-multiserver-proxy/blob/main/doc/server_groups.md)
for more information.
Server.Fallback
Type: string
Default: ""
Description: The name of the server a client should fall back to if this server
shuts down, crashes gracefully or the network connection disconnects.
ForceDefaultSrv
Type: bool
Default: false
Description: Players are connected to the default server instead of
the server they were playing on if this is true.
KickOnNewPool
Type: bool
Default: false
Description: Players are kicked if a new media pool is added
by reloading the config if this is true.
CSMRF
Type: CSMRF
Default: CSMRF{}
Description: The CSM Restriction Flags to send to clients.
Don't rely on this since it can trivially be bypassed.
CSMRF.NoCSMs
Type: bool
Default: false
Description: Loading CSMs is disabled if this is true.
CSMRF.ChatMsgs
Type: bool
Default: false
Description: CSMs can send chat messages if this is true.
CSMRF.ItemDefs
Type: bool
Default: false
Description: CSMs can read item definitions.
CSMRF.NodeDefs
Type: bool
Default: false
Description: CSMs can read node definitions.
CSMRF.NoLimitMapRange
Type: bool
Default: false
Description: CSMs can look nodes up no matter how far away they are.
CSMRF.PlayerList
Type: bool
Default: false
Description: CSMs can access the player list.
MapRange
Type: uint32
Default: 0
Description: The maximum distance from which CSMs can read the map.
DropCSMRF
Type: bool
Default: false
Description: Servers cannot override CSM Restriction Flags if this is true.
Groups
Type: map[string][]string
Default: map[string][]string{}
Description: The list of permission groups.
See [permissions.md](https://github.com/HimbeerserverDE/mt-multiserver-proxy/blob/main/doc/permissions.md)
for details on the permission system.
Groups[k]
Type: []string
Default: []string{}
Description: The list of permissions the group has.
Trailing wildcards are supported: Permissions with an asterisk at the end
match any permission requirement that starts with the string preceeding it.
Asterisks in other places are treated as regular characters.
UserGroups
Type: map[string]string
Default: map[string]string{}
Description: This sets the group of a user.
See [permissions.md](https://github.com/HimbeerserverDE/mt-multiserver-proxy/blob/main/doc/permissions.md)
for details on the permission system.
UserGroups[k]
Type: string
Default: "default"
Description: The group of the user.
List
Type: List
Default: List{}
Description: This contains information on how to announce to the server list.
List.Enable
Type: bool
Default: false
Description: If this is set to true server list announcements are sent.
List.Addr
Type: string
Default: ""
Description: The base URL of the list server.
List.Interval
Type: int
Default: 300
Description: The interval between server list announcements.
List.Name
Type: string
Default: ""
Values: Any non-zero string
Description: The name to be displayed on the server list.
List.Desc
Type: string
Default: ""
Description: The description for the server list.
List.URL
Type: string
Default: ""
Description: The website for this server.
List.Creative
Type: bool
Default: false
Description: The creative server list flag.
List.Dmg
Type: bool
Default: false
Description: The damage server list flag.
List.PvP
Type: bool
Default: false
Description: The PvP server list flag.
List.Game
Type: string
Default: ""
Description: The subgame displayed on the server list.
List.FarNames
Type: bool
Default: false
Description: The server list flag that shows whether far players are visible.
List.Mods
Type: []string
Default: []string{}
Description: The list of mods to be displayed on the server list.