mirror of
https://github.com/ME1312/SubServers-2.git
synced 2025-02-20 13:41:21 +01:00
Created Configuration (markdown)
ME1312
parent
f69504662e
commit
ce1b2a11ae
258
Configuration.md
Normal file
258
Configuration.md
Normal file
@ -0,0 +1,258 @@
|
||||
This page explains how to configure the SubServers 2 Add-ons. This page will remain updated to the latest snapshot version. Options are all assumed to be required unless otherwise noted.<br>
|
||||
|
||||
### Value Types
|
||||
The text in square brackets represents the type of value expected. The word `List` defines a list of values of the type before the word. When multiple are specified, you may chose whichever one is the most convenient. The following value types are used on this page:<br>
|
||||
`Address` - A String containing an IPv4 address (`'127.0.0.1'`)<br>
|
||||
`Boolean` - A value which can only be `true` or `false`<br>
|
||||
`Colored String` - A String that parses color codes (`'&b&lHello There!'`)<br>
|
||||
`Enum Value` - A String value that matches one from a predefined set<br>
|
||||
`File Path` - A String value representing a file path. Relative paths begin from the working directory (`~`) unless otherwise specified.
|
||||
`Object` - A group containing other settings<br>
|
||||
`Socket Address` - A String containing an IPv4 address and port number seperated by a colon (`'127.0.0.1:25565'`)<br>
|
||||
`String` - A text value (`'Hello There!'`)<br>
|
||||
`Version` - A String that accepts version formatting (`'2.13a/pr4'`)<br>
|
||||
|
||||
### Value Modifiers
|
||||
The text in parenthesis is the modifier of the value. The following modifiers are used on this page:<br>
|
||||
`System` - The system set this value, so it is not recommended for you to change it<br>
|
||||
`Optional` - The value is not required for SubServers to function normally<br>
|
||||
`<Platform> Only` - The value is only required to be correct on a specific platform. All other platforms can safely ignore this value.<br>
|
||||
<br>
|
||||
## SubServers.Bungee
|
||||
### ~/config.yml (Bungee Configuration)
|
||||
This is the main configuration file for BungeeCord itself. For values not added by SubServers, please refer to the [BungeeCord configuration documentation.](https://www.spigotmc.org/wiki/bungeecord-configuration-guide/)
|
||||
```
|
||||
player_limit: -1
|
||||
ip_forward: true
|
||||
permissions:
|
||||
default:
|
||||
- bungeecord.command.server
|
||||
- bungeecord.command.list
|
||||
admin:
|
||||
- bungeecord.command.find
|
||||
- bungeecord.command.alert
|
||||
- bungeecord.command.send
|
||||
- bungeecord.command.end
|
||||
- bungeecord.command.ip
|
||||
- bungeecord.command.reload
|
||||
timeout: 30000
|
||||
log_commands: false
|
||||
online_mode: true
|
||||
servers:
|
||||
Lobby:
|
||||
display: 'TheHub'
|
||||
group:
|
||||
- 'ExampleGroup'
|
||||
motd: '&1Just another BungeeCord - Forced Host'
|
||||
address: localhost:25565
|
||||
restricted: false
|
||||
hidden: false
|
||||
listeners:
|
||||
- query_port: 25564
|
||||
motd: '&1Another Bungee server'
|
||||
priorities:
|
||||
- Lobby
|
||||
bind_local_address: true
|
||||
tab_list: GLOBAL_PING
|
||||
query_enabled: false
|
||||
host: 0.0.0.0:25565
|
||||
forced_hosts:
|
||||
pvp.md-5.net: pvp
|
||||
max_players: 1
|
||||
tab_size: 60
|
||||
ping_passthrough: false
|
||||
force_default_server: false
|
||||
proxy_protocol: false
|
||||
disabled_commands:
|
||||
- disabledcommandhere
|
||||
network_compression_threshold: 256
|
||||
groups:
|
||||
md_5:
|
||||
- admin
|
||||
connection_throttle: 4000
|
||||
stats: f2876aa6-74d2-468c-90ee-1377111f1c9f
|
||||
forge_support: false
|
||||
```
|
||||
`servers` [Object]: Settings for each Server<br>
|
||||
It is required that you have at least one server defined here for BungeeCord to start. Note that servers defined here may be overridden by SubServers with the same name. When this happens, the configuration options for the SubServer will overwrite the options saved here; making the content of these values redundant.<br>
|
||||
<br>
|
||||
Children nodes:<br>
|
||||
`<Server Name>` [Object]: The name of this group of settings is the name of your server<br>
|
||||
`display` [String] (Optional): Set the display name for the server<br>
|
||||
`group` [String List] (Optional): Set what groups the server is in (Creates new groups when needed)<br>
|
||||
`motd` [Colored String]: Set the MOTD of the server<br>
|
||||
`address` [Socket Address]: Tell BungeeCord how to connect to the server<br>
|
||||
`restricted` [Boolean]: Require players to have a permission to be able join the server<br>
|
||||
`hidden` [Boolean] (Optional): Hide the server from server list commands like `/server`<br>
|
||||
<br>
|
||||
### ~/SubServers/config.yml (Global Configuration)
|
||||
This is the main configuration file for the SubServers platform. Other add-ons use settings in this configuration in addition to their own to work properly.
|
||||
```
|
||||
Settings:
|
||||
Version: '2.11.2a+'
|
||||
Log-Creator: true
|
||||
Override-Bungee-Commands: true
|
||||
SubData:
|
||||
Address: '0.0.0.0:4391'
|
||||
Password: 'default'
|
||||
Encryption: 'AES'
|
||||
Allowed-Connections:
|
||||
- '192.168.0.6'
|
||||
- '192.168.1.%'
|
||||
|
||||
Hosts:
|
||||
'~':
|
||||
Enabled: true
|
||||
Display: 'Default'
|
||||
Driver: 'BUILT-IN'
|
||||
Address: '127.0.0.1'
|
||||
Directory: './SubServers/Servers'
|
||||
Git-Bash: '%ProgramFiles%\Git'
|
||||
|
||||
Servers:
|
||||
'Example':
|
||||
Enabled: false
|
||||
Display: 'MyCoolServer'
|
||||
Host: '~'
|
||||
Group:
|
||||
- 'ExampleGroup'
|
||||
Port: 25567
|
||||
Motd: '&aThis is a SubServer'
|
||||
Log: true
|
||||
Directory: './Example'
|
||||
Executable: 'java -Djline.terminal=jline.UnsupportedTerminal -jar Spigot.jar'
|
||||
Stop-Command: 'stop'
|
||||
Run-On-Launch: false
|
||||
Auto-Restart: false
|
||||
Restricted: false
|
||||
Incompatible:
|
||||
- 'OtherServer'
|
||||
Hidden: false
|
||||
```
|
||||
`Settings` [Object]: Settings for the SubServers.Bungee add-on<br>
|
||||
`Version` [Version] (System): Configuration version<br>
|
||||
`Log-Creator` [Boolean]: Whether SubCreator should log the output of it's build scripts to console<br>
|
||||
`Override-Bungee-Commands` [Boolean] (Optional): Whether SubCreator should log the output of it's build scripts to console<br>
|
||||
`SubData` [Object]: Settings for the SubData Server<br>
|
||||
`Address` [Socket Address]: Address for SubData to listen on (`0.0.0.0` to listen on all addresses)<br>
|
||||
`Password` [String]: Password required for incoming connections<br>
|
||||
`Encryption` [Enum Value]: Set which cipher to use for encrypting SubData traffic<br>
|
||||
`Allowed-Connections` [Address List]: Whitelist addresses SubServers doesn't know. Integers in each address may be replaced with the wildcard `%` to match any number. (example: '192.168.0.%')<br>
|
||||
<br>
|
||||
`Hosts` [Object]: Settings for each Host<br>
|
||||
`<Host Name>` [Object]: The name of this group of settings is the name of the host<br>
|
||||
`Enabled` [Boolean]: Whether this host is enabled<br>
|
||||
`Display` [String] (Optional): Set the display name for of host<br>
|
||||
`Driver` [Enum Value]: Set which driver this host should use<br>
|
||||
`Address` [Address]: The address of this host. All subservers on this host will use this address.<br>
|
||||
`Directory` [File Path]: Path to where the servers will be saved on the machine<br>
|
||||
`Git-Bash` [File Path] (Windows Only): Path to the install location of Git Bash. This value can include system variables. (example: `%ProgramFiles%/Git`)<br>
|
||||
<br>
|
||||
`Servers` [Object]: Settings for each SubServer<br>
|
||||
`<Server Name>` [String]: The name of this group of settings is the name of your subserver<br>
|
||||
`Enabled` [Boolean]: Whether this subserver is enabled<br>
|
||||
`Display` [String] (Optional): Set the display name of this subserver<br>
|
||||
`Host` [Enum Value]: Set which host this subserver belongs to<br>
|
||||
`Group` [String List] (Optional): Set what groups the subserver is in (Creates new groups when needed)<br>
|
||||
`Port` [Integer]: Set the port number to connect to this subserver with<br>
|
||||
`Motd` [Colored String]: Set the MOTD of the subserver<br>
|
||||
`Log` [Boolean]: Whether this subserver should log to console<br>
|
||||
`Directory` [File Path]: The path to the server directory relative to the path set by the host<br>
|
||||
`Executable` [File Path/String]: A command to execute or a path to an executable script to execute relative to the directory set by the subserver<br>
|
||||
`Stop-Command` [String]: A command that will shutdown the server program<br>
|
||||
`Run-On-Launch` [Boolean]: Whether this subserver will start as soon as it's loaded<br>
|
||||
`Auto-Restart` [Boolean]: Whether this subserver should restart on an unexpected shutdown<br>
|
||||
`Restricted` [Boolean]: Require players to have a permission to be able join the subserver<br>
|
||||
`Incompatible` [Enum Value List] (Optional): List of subservers that cannot be run at the same time as this one<br>
|
||||
`Hidden` [Boolean] (Optional): Hide the server from subserver list commands like `/server`<br>
|
||||
<br>
|
||||
### ~/SubServers/lang.yml (Global Language File)
|
||||
This a language file containing all messages that are visible to players. It is updated quite frequently and is pretty self explanatory in it's structure. Everything in the `Lang` object is a Colored String that you may change as needed.<br>
|
||||
<br>
|
||||
### ~/SubServers/Templates/<Template Name>/template.yml
|
||||
SubCreator Templates have their own directory structure and template configurations. This is covered in-depth on the [SubCreator page.](https://github.com/ME1312/SubServers-2/wiki/SubCreator#subcreator-templates)<br>
|
||||
<br>
|
||||
## SubServers.Host
|
||||
### ~/config.yml
|
||||
```
|
||||
Settings:
|
||||
Version: '2.11.2a+'
|
||||
Console-Log: true
|
||||
Network-Log: true
|
||||
Server-Bind: '127.0.0.1'
|
||||
SubData:
|
||||
Name: 'ExampleHost'
|
||||
Address: '192.168.0.2:4391'
|
||||
Password: 'default'
|
||||
Encryption: 'AES'
|
||||
```
|
||||
`Settings` [Object]: Settings for the SubServers.Host add-on<br>
|
||||
`Version` [Version] (System): Configuration version<br>
|
||||
`Console-Log` [Boolean]: Whether SubCreator/SubServers should log to the SubServers.Host console<br>
|
||||
`Network-Log` [Boolean]: Whether SubCreator/SubServers should send log messages to SubServers.Bungee<br>
|
||||
`Server-Bind` [Address]: Local address for servers created by SubCreator to bind to<br>
|
||||
`SubData` [Object]: Settings to connect to SubData with<br>
|
||||
`Name` [Enum Value]: The name of the Host as defined in the global configuration. Additionally, the host specified needs to be equipped with a driver that can handle a SubData connection. (like the `NETWORK` driver)<br>
|
||||
`Address` [Socket Address]: The address to connect to the SubData Server with<br>
|
||||
`Password` [String]: The password to login with<br>
|
||||
`Encryption` [Enum Value]: Set which cipher to use for encrypting SubData traffic (Must match the one the server uses)<br>
|
||||
<br>
|
||||
## SubServers.Sync
|
||||
### ~/SubServers/sync.yml
|
||||
```
|
||||
Settings:
|
||||
Version: '2.11.2a+'
|
||||
Override-Bungee-Commands: true
|
||||
SubData:
|
||||
Name: `ExampleProxy`
|
||||
Address: '127.0.0.1:4391'
|
||||
Password: 'default'
|
||||
Encryption: 'AES'
|
||||
|
||||
Sync:
|
||||
Disabled-Commands: false
|
||||
Forced-Hosts: true
|
||||
MOTD: false
|
||||
Player-Limit: false
|
||||
Server-Priorities: true
|
||||
```
|
||||
`Settings` [Object]: Settings for the SubServers.Sync add-on<br>
|
||||
`Version` [Version] (System): Configuration version<br>
|
||||
`Override-Bungee-Commands` [Boolean] (Optional): Whether SubCreator should log the output of it's build scripts to console<br>
|
||||
`SubData` [Object]: Settings to connect to SubData with<br>
|
||||
`Name` [String] (Optional): The name that this proxy will be registered with. If this value is not present it will use the one from the RedisBungee configuration. If RedisBungee is not present then it will use a randomly generated UUID.<br>
|
||||
`Address` [Socket Address]: The address to connect to the SubData Server with<br>
|
||||
`Password` [String]: The password to login with<br>
|
||||
`Encryption` [Enum Value]: Set which cipher to use for encrypting SubData traffic (Must match the one the server uses)<br>
|
||||
<br>
|
||||
`Sync` [Object] (Optional): Additional options to be synced from SubServers.Bungee<br>
|
||||
`Disabled-Commands` [Boolean] (Optional): Sync `disabled_commands` from BungeeCord's config<br>
|
||||
`Forced-Hosts` [Boolean] (Optional): Sync `forced_hosts` from BungeeCord's config<br>
|
||||
`Motd` [Boolean] (Optional): Sync `motd` from BungeeCord's config<br>
|
||||
`Player-Limit` [Boolean] (Optional): Sync `player_limit` and `max_players` from BungeeCord's config<br>
|
||||
`Server-Priorities` [Boolean] (Optional): Sync `priorities` from BungeeCord's config<br>
|
||||
<br>
|
||||
## SubServers.Client
|
||||
### <Plugin Directory>/config.yml
|
||||
This configuration remains the same on all server platforms for ease of use.
|
||||
```
|
||||
Settings:
|
||||
Version: '2.11.2a+'
|
||||
Ingame-Access: true
|
||||
Show-Addresses: false
|
||||
Use-Title-Messages: true
|
||||
SubData:
|
||||
Address: '127.0.0.1:4391'
|
||||
Password: 'default'
|
||||
Encryption: 'AES'
|
||||
```
|
||||
`Settings` [Object]: Settings for the SubServers.Client plugin<br>
|
||||
`Version` [Version] (System): Configuration version<br>
|
||||
`Ingame-Access` [Boolean]: Whether the interface and commands will be available (toggle API-only mode)<br>
|
||||
`Show-Addresses` [Boolean]: Toggle server addresses' visibility in the interface<br>
|
||||
`Use-Title-Messages` [Boolean]: Toggle the use of title messages in the interface<br>
|
||||
`SubData` [Object]: Settings to connect to SubData with<br>
|
||||
`Name` [Enum Value] (Optional): The name of the Server as defined in the global or bungee configuration. When this value is not present the server will try to guess which server this connection belongs to using it's address and port number. If this fails, this value becomes required.<br>
|
||||
`Address` [Socket Address]: The address to connect to the SubData Server with<br>
|
||||
`Password` [String]: The password to login with<br>
|
||||
`Encryption` [Enum Value]: Set which cipher to use for encrypting SubData traffic (Must match the one the server uses)<br>
|
||||
Loading…
Reference in New Issue
Block a user