Updated Configuration (markdown)

ME1312 2020-07-03 17:23:30 -04:00
parent 9e5ab6a4a9
commit 096e7c01b0

@ -57,8 +57,12 @@ This is the main configuration file for the SubServers platform. Other add-ons u
```yml ```yml
Settings: Settings:
Version: '00w00a' Version: '00w00a'
Smart-Fallback: true
Override-Bungee-Commands: true Override-Bungee-Commands: true
Smart-Fallback:
Enabled: true
Fallback: true
Reconnect: true
DNS-Forward: true
UPnP: UPnP:
Forward-Proxy: true Forward-Proxy: true
Forward-SubData: false Forward-SubData: false
@ -74,8 +78,12 @@ Settings:
``` ```
`Settings` **[Object]**: Settings for the SubServers.Bungee add-on<br> `Settings` **[Object]**: Settings for the SubServers.Bungee add-on<br>
&nbsp; &nbsp; `Version` **[Version]** (System): Configuration version<br> &nbsp; &nbsp; `Version` **[Version]** (System): Configuration version<br>
&nbsp; &nbsp; `Smart-Fallback` **[Boolean]**: Enables the smart confidence-based server fallback system<br>
&nbsp; &nbsp; `Override-Bungee-Commands` **[Boolean]**: Whether the default BungeeCord commands should be overridden by SubServers code<br> &nbsp; &nbsp; `Override-Bungee-Commands` **[Boolean]**: Whether the default BungeeCord commands should be overridden by SubServers code<br>
&nbsp; &nbsp; `Smart-Fallback` **[Object]**: Settings for the smarter, confidence-based server fallback system<br>
&nbsp; &nbsp; &nbsp; &nbsp; `Enabled` **[Boolean]**: Enables Smart-Fallback for when you join initially<br>
&nbsp; &nbsp; &nbsp; &nbsp; `Fallback` **[Boolean]**: Reroutes you to a fallback server when the server you're on goes down<br>
&nbsp; &nbsp; &nbsp; &nbsp; `Reconnect` **[Boolean]**: Saves the server you were last on (Requires the `reconnect_yaml` module)<br>
&nbsp; &nbsp; &nbsp; &nbsp; `DNS-Forward` **[Boolean]**: Routes you based on the address that was entered (`pvp.me1312.net` -> `PvP`)<br>
&nbsp; &nbsp; `UPnP` **[Object]**: Automatic Port Forwarding Options<br> &nbsp; &nbsp; `UPnP` **[Object]**: Automatic Port Forwarding Options<br>
&nbsp; &nbsp; &nbsp; &nbsp; `Forward-Proxy` **[Boolean]**: Whether or not to forward the proxy's listeners<br> &nbsp; &nbsp; &nbsp; &nbsp; `Forward-Proxy` **[Boolean]**: Whether or not to forward the proxy's listeners<br>
&nbsp; &nbsp; &nbsp; &nbsp; `Forward-SubData` **[Boolean]**: Whether or not to forward SubData<br> &nbsp; &nbsp; &nbsp; &nbsp; `Forward-SubData` **[Boolean]**: Whether or not to forward SubData<br>
@ -221,6 +229,11 @@ Settings:
Settings: Settings:
Version: '00w00a' Version: '00w00a'
Override-Bungee-Commands: true Override-Bungee-Commands: true
Smart-Fallback:
Enabled: true
Fallback: true
Reconnect: true
DNS-Forward: true
UPnP: UPnP:
Forward-Proxy: true Forward-Proxy: true
SubData: SubData:
@ -231,6 +244,11 @@ Settings:
`Settings` **[Object]**: Settings for the SubServers.Sync add-on<br> `Settings` **[Object]**: Settings for the SubServers.Sync add-on<br>
&nbsp; &nbsp; `Version` **[Version]** (System): Configuration version<br> &nbsp; &nbsp; `Version` **[Version]** (System): Configuration version<br>
&nbsp; &nbsp; `Override-Bungee-Commands` **[Boolean]** (Optional): Whether the default BungeeCord commands should be overridden by SubServers code<br> &nbsp; &nbsp; `Override-Bungee-Commands` **[Boolean]** (Optional): Whether the default BungeeCord commands should be overridden by SubServers code<br>
&nbsp; &nbsp; `Smart-Fallback` **[Object]**: Settings for the smarter, confidence-based server fallback system<br>
&nbsp; &nbsp; &nbsp; &nbsp; `Enabled` **[Boolean]**: Enables Smart-Fallback for when you join initially<br>
&nbsp; &nbsp; &nbsp; &nbsp; `Fallback` **[Boolean]**: Reroutes you to a fallback server when the server you're on goes down<br>
&nbsp; &nbsp; &nbsp; &nbsp; `Reconnect` **[Boolean]**: Saves the server you were last on (Requires the `reconnect_yaml` module)<br>
&nbsp; &nbsp; &nbsp; &nbsp; `DNS-Forward` **[Boolean]**: Routes you based on the address that was entered (`pvp.me1312.net` -> `PvP`)<br>
&nbsp; &nbsp; `UPnP` **[Object]**: Automatic Port Forwarding Options<br> &nbsp; &nbsp; `UPnP` **[Object]**: Automatic Port Forwarding Options<br>
&nbsp; &nbsp; &nbsp; &nbsp; `Forward-Proxy` **[Boolean]**: Whether or not to forward the proxy's listeners<br> &nbsp; &nbsp; &nbsp; &nbsp; `Forward-Proxy` **[Boolean]**: Whether or not to forward the proxy's listeners<br>
&nbsp; &nbsp; `SubData` **[Object]**: Settings to connect to SubData with<br> &nbsp; &nbsp; `SubData` **[Object]**: Settings to connect to SubData with<br>