Rim/IW4M-Admin
Rim/IW4M-Admin
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 30 Wiki Activity

Added some more info.

Chase Hall 2020-08-06 08:46:49 -05:00
parent 28578dc892
commit 2ea7a3b942
1 changed files with 30 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

112
Configuration.md

@ -1,25 +1,3 @@
## IW4MAdminSettings.json
### Servers
| Name | Description | Validation | Default |
|--------------------|--------------------------------------------------------|---------------------------------------------------|---------|
| IPAddress | Internet Protocol Address | [IPv4 format](https://en.wikipedia.org/wiki/IPv4) | -- |
| Port | Communication endpoint | 1-65535 | -- |
| Password | RCon password | Not empty | -- |
| ManualLogPath | Override game log path | -- | null |
| AutoMessages | List of messages to broadcast automatically | Not null | [] |
| Rules | List of rules | Not null | [] |
| ReservedSlotNumber | Number of client slots to reserve for privileged users | 0-32 | 0 |
| GameLogServerUrl | HTTP Url for the Game Log Server | HTTP endpoint | null |
| CustomHostname | Override server title (hostname) | Length >= 3 &mdash; Length <= 128 | null |
### Application
| Name | Description | Validation | Default |
|-----------------------|-----------------------------------------------------------|---------------------------------------------------|---------|
|MasterUrl | HTTP Url location of the master server | HTTP Uri | https://fn-p.master.threadsafe.sh/|
|ManualWebfrontUrl | URL for webfront (useful for things like [YADB](https://forum.awog.at/topic/89/release-yadb-yet-another-discord-bridge)) | HTTP Uri | null|
|CommandPrefix | Prefix indicating the chat message is a command | Not empty | ! |
|BroadcastCommandPrefix | Prefix indicating the chat message is a broadcast command | Not empty | @ |
### Configuration
#### Initial Configuration
When **IW4MAdmin** is launched for the _first time_, you will be prompted to setup your configuration.
@ -77,66 +55,38 @@ If you wish to further customize your experience of **IW4MAdmin**, the following
#### `IW4MAdminSettings.json`-- this file is created after initial setup
* This file uses the [JSON](https://en.wikipedia.org/wiki/JSON#JSON_sample) specification, so please validate your configuration before running **IW4MAdmin**
`WebfrontBindUrl`
* Specifies the address and port the webfront will listen on.
* The value can be an [IP Address](https://en.wikipedia.org/wiki/IP_address):port or [Domain Name](https://en.wikipedia.org/wiki/Domain_name):port
* Example http://gameserver.com:8080
* Default &mdash; `http://0.0.0.0:1624` (indicates that it will listen on all IP Addresses available to the default interface)
### Servers
| Name | Description | Validation | Default |
|--------------------|--------------------------------------------------------|---------------------------------------------------|---------|
| IPAddress | Internet Protocol Address | [IPv4 format](https://en.wikipedia.org/wiki/IPv4) | -- |
| Port | Communication endpoint | 1-65535 | -- |
| Password | RCon password | Not empty | -- |
| Rules | List of rules | Not null | [] |
| AutoMessages | List of messages to broadcast automatically | Not null | [] |
| ManualLogPath | Override game log path | -- | null |
| ReservedSlotNumber | Number of client slots to reserve for privileged users | 0-32 | 0 |
| GameLogServerUrl | HTTP Url for the Game Log Server | HTTP endpoint | null |
| CustomHostname | Override server title (hostname) | Length >= 3 &mdash; Length <= 128 | null |
`CustomLocale`
* Specifies a [locale name](https://msdn.microsoft.com/en-us/library/39cwe7zf.aspx) to use instead of system default
* Locale must be from the `Equivalent Locale Name` column
* Default &mdash; `windows-1252`
### Application
| Name | Description | Validation | Default |
|-----------------------|-----------------------------------------------------------|---------------------------------------------------|---------|
|WebfrontBindUrl | Specifies the address and port the webfront will listen on.| HTTP Uri | http://0.0.0.0:1624
|ManualWebfrontUrl | URL for webfront (useful for things like [YADB](https://forum.awog.at/topic/89/release-yadb-yet-another-discord-bridge)) | HTTP Uri | null|
|WebfrontPrimaryColor | Hex Value for the Primary Webfront color. | Hex Color Code | #
|WebfrontSecondaryColor | Hex Value for the Secondary Webfront color. | Hex Color Code | #
|WebfrontCustomBranding | Name of application. | Text | IW4MAdmin
|CommandPrefix | Prefix indicating the chat message is a command | Not empty | ! |
|BroadcastCommandPrefix | Prefix indicating the chat message is a broadcast command | Not empty | @ |
|MasterUrl | HTTP Url location of the master server | HTTP Uri | http://api.raidmax.org:5000|
|CustomLocale | Specifies a [locale name](https://msdn.microsoft.com/en-us/library/39cwe7zf.aspx) to use instead of system default | Not empty | windows-1252
|ConnectionString | Specifies the [connection string](https://www.connectionstrings.com/mysql/) to a MySQL server that is used instead of SQLite | Not empty | null
|DatabaseProvider | Specifies the database provider **IW4MAdmin** should use. (Possible values &mdash; `sqlite`, `mysql`, `postgresql`) | Not empty | sqlite
|IgnoreBots | Disables bots from being registered and tracked by **IW4MAdmin** | true/false | false
|RConPollRate | Specifies (in milliseconds) how often to poll each server for updates | Number | 5000
|AutoMessagePeriod | Specifies (in seconds) how often messages should be broadcasted to each server | Number | 60
|GlobalRules | Specifies the list of rules that apply to **all** servers` | Not empty | []
`ConnectionString`
* Specifies the [connection string](https://www.connectionstrings.com/mysql/) to a MySQL server that is used instead of SQLite
* Default &mdash; `null`
`DatabaseProvider`
* Specifies the database provider **IW4MAdmin** should use
* Possible values &mdash; `sqlite`, `mysql`, `postgresql`
* Default &mdash; `sqlite`
`Ignore Bots`
* Disables bots from being registered and tracked by **IW4MAdmin**
`RConPollRate`
* Specifies (in milliseconds) how often to poll each server for updates
* Default &mdash; `5000`
`Servers`
* Specifies the list of servers **IW4MAdmin** will monitor
* Default &mdash; `[]`
* `IPAddress`
* Specifies the IP Address of the particular server
* Default &mdash; `n/a`
* `Port`
* Specifies the port of the particular server
* Default &mdash; `n/a`
* `Password`
* Specifies the `rcon_password` of the particular server
* Default &mdash; `n/a`
* `ManualLogPath`
* Specifies the log path to be used instead of the automatically generated one
* To use the `GameLogServer`, this should be set to the http address that the `GameLogServer` is listening on
* Example &mdash; http://gamelogserver.com/
* Default &mdash; `null`
* `AutoMessages`
* Specifies the list of messages that are broadcasted to the particular server
* Default &mdash; `[]`
* `Rules`
* Specifies the list of rules that apply to the particular server
* Default &mdash; `[]`
* `ReservedSlotNumber`
* Specifies the number of client slots to reserve for privileged users
* Default &mdash; `0`
* `GameLogServerUrl`
* Specifies the HTTP Url for the Game Log Server
* Default &mdash; `null`
`AutoMessagePeriod`
* Specifies (in seconds) how often messages should be broadcasted to each server
* Default &mdash; `60`
`AutoMessages`
* Specifies the list of messages that are broadcasted to **all** servers
@ -149,8 +99,6 @@ If you wish to further customize your experience of **IW4MAdmin**, the following
* `{{ADMINS}}` &mdash; displays the currently connected and *unmasked* privileged users online
* `{{NEXTMAP}}` &mdash; displays the next map and gametype in rotation
`GlobalRules`
* Specifies the list of rules that apply to **all** servers`
`Maps`
* Specifies the list of maps for each supported game