mirror of
https://github.com/ME1312/SubServers-2.git
synced 2024-11-25 19:56:24 +01:00
Updated Configuration (markdown)
ME1312
parent
99b7e98b5f
commit
95e76a99bc
@ -45,13 +45,13 @@ servers:
|
|||||||
`restricted` **[Boolean]**: Require players to have a permission to be able join 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>
|
`hidden` **[Boolean]** (Optional): Hide the server from server list commands like `/server`<br>
|
||||||
<br>
|
<br>
|
||||||
### [~/SubServers/config.yml](https://github.com/ME1312/SubServers-2/blob/master/SubServers.Bungee/src/net/ME1312/SubServers/Bungee/Library/Files/config.yml) (Global Configuration)
|
### ~/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.
|
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:
|
Settings:
|
||||||
Version: '2.11.2a+'
|
Version: '00w00a'
|
||||||
|
Smart-Fallback: true
|
||||||
Override-Bungee-Commands: true
|
Override-Bungee-Commands: true
|
||||||
Run-On-Launch-Timeout: 0
|
|
||||||
UPnP:
|
UPnP:
|
||||||
Forward-Proxy: true
|
Forward-Proxy: true
|
||||||
Forward-SubData: false
|
Forward-SubData: false
|
||||||
@ -59,15 +59,15 @@ Settings:
|
|||||||
SubData:
|
SubData:
|
||||||
Address: '0.0.0.0:4391'
|
Address: '0.0.0.0:4391'
|
||||||
Password: 'default'
|
Password: 'default'
|
||||||
Encryption: 'AES'
|
Encryption: 'RSA/AES'
|
||||||
Allowed-Connections:
|
Whitelist:
|
||||||
- '192.168.0.6'
|
- '192.168.0.6'
|
||||||
- '192.168.1.%'
|
- '192.168.1.%'
|
||||||
```
|
```
|
||||||
`Settings` **[Object]**: Settings for the SubServers.Bungee add-on<br>
|
`Settings` **[Object]**: Settings for the SubServers.Bungee add-on<br>
|
||||||
`Version` **[Version]** (System): Configuration version<br>
|
`Version` **[Version]** (System): Configuration version<br>
|
||||||
|
`Smart-Fallback` **[Boolean]**: Enables the smart confidence-based server fallback system<br>
|
||||||
`Override-Bungee-Commands` **[Boolean]**: Whether the default BungeeCord commands should be overridden by SubServers code<br>
|
`Override-Bungee-Commands` **[Boolean]**: Whether the default BungeeCord commands should be overridden by SubServers code<br>
|
||||||
`Run-On-Launch-Timeout` **[Integer]** (Optional): The amount of seconds the auto-starter should wait for a SubData connection from a subserver before moving on to the next one<br>
|
|
||||||
`UPnP` **[Object]**: Automatic Port Forwarding Options<br>
|
`UPnP` **[Object]**: Automatic Port Forwarding Options<br>
|
||||||
`Forward-Proxy` **[Boolean]**: Whether or not to forward the proxy's listeners<br>
|
`Forward-Proxy` **[Boolean]**: Whether or not to forward the proxy's listeners<br>
|
||||||
`Forward-SubData` **[Boolean]**: Whether or not to forward SubData<br>
|
`Forward-SubData` **[Boolean]**: Whether or not to forward SubData<br>
|
||||||
@ -81,7 +81,11 @@ Settings:
|
|||||||
**->** `AES-128`<br>
|
**->** `AES-128`<br>
|
||||||
**->** `AES-192`<br>
|
**->** `AES-192`<br>
|
||||||
**->** `AES-256`<br>
|
**->** `AES-256`<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>
|
**->** `RSA/AES`: An alias for RSA-2048/AES-128<br>
|
||||||
|
**->** `RSA-2048/AES-128`<br>
|
||||||
|
**->** `RSA-3072/AES-192`<br>
|
||||||
|
**->** `RSA-4096/AES-256`<br>
|
||||||
|
`Whitelist` **[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>
|
<br>
|
||||||
```
|
```
|
||||||
Hosts:
|
Hosts:
|
||||||
@ -108,7 +112,12 @@ Hosts:
|
|||||||
`Git-Bash` **[File Path]** (Windows Only): Path to the install location of Git Bash. This value can include system variables.<br>
|
`Git-Bash` **[File Path]** (Windows Only): Path to the install location of Git Bash. This value can include system variables.<br>
|
||||||
`Log-Creator` **[Boolean]**: Whether SubCreator should log the output of it's scripts to console<br>
|
`Log-Creator` **[Boolean]**: Whether SubCreator should log the output of it's scripts to console<br>
|
||||||
<br>
|
<br>
|
||||||
|
### ~/SubServers/servers.yml (Global Configuration)
|
||||||
|
This is the configuration file that defines the SubServers themselves. Other add-ons use settings in this configuration in addition to their own to work properly.
|
||||||
```
|
```
|
||||||
|
Settings:
|
||||||
|
Version: '00w00a'
|
||||||
|
Override-Bungee-Commands: true
|
||||||
Servers:
|
Servers:
|
||||||
'Example':
|
'Example':
|
||||||
Enabled: false
|
Enabled: false
|
||||||
@ -129,6 +138,9 @@ Servers:
|
|||||||
- 'OtherServer'
|
- 'OtherServer'
|
||||||
Hidden: false
|
Hidden: false
|
||||||
```
|
```
|
||||||
|
`Settings` **[Object]**: Settings for the SubServers.Bungee add-on<br>
|
||||||
|
`Version` **[Version]** (System): Configuration version<br>
|
||||||
|
`Run-On-Launch-Timeout` **[Integer]** (Optional): The amount of seconds the auto-starter should wait for a SubData connection from a subserver before moving on to the next one<br>
|
||||||
`Servers` **[Object]**: Settings for each SubServer<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>
|
`<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>
|
`Enabled` **[Boolean]**: Whether this subserver is enabled<br>
|
||||||
@ -148,14 +160,15 @@ Servers:
|
|||||||
`Stop-Action` **[Enum Value]**: Set what should happen after the server stops. Valid values:<br>
|
`Stop-Action` **[Enum Value]**: Set what should happen after the server stops. Valid values:<br>
|
||||||
**->** `NONE`: Do nothing on stop<br>
|
**->** `NONE`: Do nothing on stop<br>
|
||||||
**->** `RESTART`: Restart if it stopped unexpectedly<br>
|
**->** `RESTART`: Restart if it stopped unexpectedly<br>
|
||||||
**->** `REMOVE_SERVER`: Remove the server on stop<br>
|
**->** `REMOVE_SERVER`: Remove the server from memory on stop<br>
|
||||||
**->** `DELETE_SERVER`: Delete the server on stop<br>
|
**->** `RECYCLE_SERVER`: Move the server files 'Recently Deleted' on stop<br>
|
||||||
|
**->** `DELETE_SERVER`: Delete the server files on stop<br>
|
||||||
`Run-On-Launch` **[Boolean]**: Whether this subserver will start as soon as it's loaded<br>
|
`Run-On-Launch` **[Boolean]**: Whether this subserver will start as soon as it's loaded<br>
|
||||||
`Restricted` **[Boolean]**: Require players to have a permission to be able join the subserver<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>
|
`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>
|
`Hidden` **[Boolean]** (Optional): Hide the server from subserver list commands like `/server`<br>
|
||||||
<br>
|
<br>
|
||||||
### [~/SubServers/lang.yml](https://github.com/ME1312/SubServers-2/blob/master/SubServers.Bungee/src/net/ME1312/SubServers/Bungee/Library/Files/lang.yml) (Global Language File)
|
### ~/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>
|
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>
|
<br>
|
||||||
### ~/SubServers/Templates/<Template Name>/template.yml
|
### ~/SubServers/Templates/<Template Name>/template.yml
|
||||||
@ -165,7 +178,7 @@ SubCreator Templates have their own directory structure and template configurati
|
|||||||
### [~/config.yml](https://github.com/ME1312/SubServers-2/blob/master/SubServers.Host/src/net/ME1312/SubServers/Host/Library/Files/config.yml)
|
### [~/config.yml](https://github.com/ME1312/SubServers-2/blob/master/SubServers.Host/src/net/ME1312/SubServers/Host/Library/Files/config.yml)
|
||||||
```
|
```
|
||||||
Settings:
|
Settings:
|
||||||
Version: '2.11.2a+'
|
Version: '00w00a'
|
||||||
Console-Log: true
|
Console-Log: true
|
||||||
Network-Log: true
|
Network-Log: true
|
||||||
Server-Bind: '127.0.0.1'
|
Server-Bind: '127.0.0.1'
|
||||||
@ -173,7 +186,7 @@ Settings:
|
|||||||
Forward-Servers: false
|
Forward-Servers: false
|
||||||
SubData:
|
SubData:
|
||||||
Name: 'ExampleHost'
|
Name: 'ExampleHost'
|
||||||
Address: '192.168.0.2:4391'
|
Address: '127.0.0.1:4391'
|
||||||
Password: 'default'
|
Password: 'default'
|
||||||
Encryption: 'AES'
|
Encryption: 'AES'
|
||||||
```
|
```
|
||||||
@ -187,14 +200,13 @@ Settings:
|
|||||||
`SubData` **[Object]**: Settings to connect to SubData with<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.<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.<br>
|
||||||
`Address` **[Socket Address]**: The address to connect to the SubData Server with<br>
|
`Address` **[Socket Address]**: The address to connect to the SubData Server with<br>
|
||||||
`Password` **[String]**: The password to login with<br>
|
`Password` **[String]** (Optional): 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>
|
<br>
|
||||||
## SubServers.Sync
|
## SubServers.Sync
|
||||||
### [~/SubServers/sync.yml](https://github.com/ME1312/SubServers-2/blob/master/SubServers.Sync/src/net/ME1312/SubServers/Sync/Library/Files/config.yml)
|
### [~/SubServers/sync.yml](https://github.com/ME1312/SubServers-2/blob/master/SubServers.Sync/src/net/ME1312/SubServers/Sync/Library/Files/config.yml)
|
||||||
```
|
```
|
||||||
Settings:
|
Settings:
|
||||||
Version: '2.11.2a+'
|
Version: '00w00a'
|
||||||
Override-Bungee-Commands: true
|
Override-Bungee-Commands: true
|
||||||
UPnP:
|
UPnP:
|
||||||
Forward-Proxy: true
|
Forward-Proxy: true
|
||||||
@ -202,7 +214,6 @@ Settings:
|
|||||||
Name: 'ExampleProxy'
|
Name: 'ExampleProxy'
|
||||||
Address: '127.0.0.1:4391'
|
Address: '127.0.0.1:4391'
|
||||||
Password: 'default'
|
Password: 'default'
|
||||||
Encryption: 'AES'
|
|
||||||
```
|
```
|
||||||
`Settings` **[Object]**: Settings for the SubServers.Sync add-on<br>
|
`Settings` **[Object]**: Settings for the SubServers.Sync add-on<br>
|
||||||
`Version` **[Version]** (System): Configuration version<br>
|
`Version` **[Version]** (System): Configuration version<br>
|
||||||
@ -212,8 +223,7 @@ Settings:
|
|||||||
`SubData` **[Object]**: Settings to connect to SubData with<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>
|
`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>
|
`Address` **[Socket Address]**: The address to connect to the SubData Server with<br>
|
||||||
`Password` **[String]**: The password to login with<br>
|
`Password` **[String]** (Optional): 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>
|
<br>
|
||||||
```
|
```
|
||||||
Sync:
|
Sync:
|
||||||
@ -235,23 +245,21 @@ Sync:
|
|||||||
This configuration remains the same on all server platforms for ease of use.
|
This configuration remains the same on all server platforms for ease of use.
|
||||||
```
|
```
|
||||||
Settings:
|
Settings:
|
||||||
Version: '2.11.2a+'
|
Version: '00w00a'
|
||||||
Ingame-Access: true
|
API-Only-Mode: false
|
||||||
Show-Addresses: false
|
Show-Addresses: false
|
||||||
Use-Title-Messages: true
|
Use-Title-Messages: true
|
||||||
SubData:
|
SubData:
|
||||||
Name: 'Example'
|
Name: 'Example'
|
||||||
Address: '127.0.0.1:4391'
|
Address: '127.0.0.1:4391'
|
||||||
Password: 'default'
|
Password: 'default'
|
||||||
Encryption: 'AES'
|
|
||||||
```
|
```
|
||||||
`Settings` **[Object]**: Settings for the SubServers.Client plugin<br>
|
`Settings` **[Object]**: Settings for the SubServers.Client plugin<br>
|
||||||
`Version` **[Version]** (System): Configuration version<br>
|
`Version` **[Version]** (System): Configuration version<br>
|
||||||
`Ingame-Access` **[Boolean]**: Whether the interface and commands will be available (API-only mode)<br>
|
`API-Only-Mode` **[Boolean]**: Whether the interface and commands will be available (toggles API-only mode)<br>
|
||||||
`Show-Addresses` **[Boolean]**: Toggle server addresses' visibility in the interface<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>
|
`Use-Title-Messages` **[Boolean]**: Toggle the use of title messages in the interface<br>
|
||||||
`SubData` **[Object]**: Settings to connect to SubData with<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>
|
`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>
|
`Address` **[Socket Address]**: The address to connect to the SubData Server with<br>
|
||||||
`Password` **[String]**: The password to login with<br>
|
`Password` **[String]** (Optional): 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