Duplicate info from readme
Chase Hall
parent
f1b376434d
commit
34fcac335d
144
Configuration.md
144
Configuration.md
@ -16,6 +16,146 @@
|
||||
| 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|
|
||||
|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 | @ |
|
||||
|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.
|
||||
|
||||
`Enable webfront`
|
||||
* Enables you to monitor and control your server(s) through a web interface
|
||||
* Default — `http://0.0.0.0:1624`
|
||||
|
||||
`Enable multiple owners`
|
||||
* Enables more than one client to be promoted to level of `Owner`
|
||||
* Default — `false`
|
||||
|
||||
`Enable stepped privilege hierarchy`
|
||||
* Allows privileged clients to promote other clients to the level below their current level
|
||||
* Default — `false`
|
||||
|
||||
`Enable custom say name`
|
||||
* Shows a prefix to every message send by **IW4MAdmin** -- `[Admin] message`
|
||||
* _This feature requires you specify a custom say name_
|
||||
* _This feature only works on games that support the `sv_sayName` dvar_
|
||||
* Default — `false`
|
||||
|
||||
`Enable social link`
|
||||
* Shows a link to your community's social media/website on the webfront
|
||||
* Default — `false`
|
||||
|
||||
`Use Custom Encoding Parser`
|
||||
* Allows alternative encodings to be used for parsing game information and events
|
||||
* **Russian users should use this and then specify** `windows-1251` **as the encoding string**
|
||||
* Default — `false`
|
||||
|
||||
#### Server Configuration
|
||||
After initial configuration is finished, you will be prompted to configure your servers for **IW4MAdmin**.
|
||||
|
||||
`Enter server IP Address`
|
||||
* For almost all scenarios `127.0.0.1` is sufficient
|
||||
* Default — `n/a`
|
||||
|
||||
`Enter server port`
|
||||
* The port that your server is listening on (can be obtained via `net_port`)
|
||||
* Default — `n/a`
|
||||
|
||||
`Enter server RCon password`
|
||||
* The *\(R\)emote (Con)sole* password set in your server configuration (can be obtained via `rcon_password`)
|
||||
* Default — `n/a`
|
||||
|
||||
`Enter number of reserved slots`
|
||||
* The number of client slots reserved for privileged players (unavailable for regular users to occupy)
|
||||
* For example, if you enter **2** reserved slots on an **18** slot server, you will have **16** publicly available slots
|
||||
* Default — `0`
|
||||
|
||||
#### Advanced Configuration
|
||||
If you wish to further customize your experience of **IW4MAdmin**, the following configuration file(s) will allow you to changes core options using any text-editor.
|
||||
|
||||
#### `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 — `http://0.0.0.0:1624` (indicates that it will listen on all IP Addresses available to the default interface)
|
||||
|
||||
`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 — `windows-1252`
|
||||
|
||||
`ConnectionString`
|
||||
* Specifies the [connection string](https://www.connectionstrings.com/mysql/) to a MySQL server that is used instead of SQLite
|
||||
* Default — `null`
|
||||
|
||||
`DatabaseProvider`
|
||||
* Specifies the database provider **IW4MAdmin** should use
|
||||
* Possible values — `sqlite`, `mysql`, `postgresql`
|
||||
* Default — `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 — `5000`
|
||||
|
||||
`Servers`
|
||||
* Specifies the list of servers **IW4MAdmin** will monitor
|
||||
* Default — `[]`
|
||||
* `IPAddress`
|
||||
* Specifies the IP Address of the particular server
|
||||
* Default — `n/a`
|
||||
* `Port`
|
||||
* Specifies the port of the particular server
|
||||
* Default — `n/a`
|
||||
* `Password`
|
||||
* Specifies the `rcon_password` of the particular server
|
||||
* Default — `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 — http://gamelogserver.com/
|
||||
* Default — `null`
|
||||
* `AutoMessages`
|
||||
* Specifies the list of messages that are broadcasted to the particular server
|
||||
* Default — `[]`
|
||||
* `Rules`
|
||||
* Specifies the list of rules that apply to the particular server
|
||||
* Default — `[]`
|
||||
* `ReservedSlotNumber`
|
||||
* Specifies the number of client slots to reserve for privileged users
|
||||
* Default — `0`
|
||||
* `GameLogServerUrl`
|
||||
* Specifies the HTTP Url for the Game Log Server
|
||||
* Default — `null`
|
||||
|
||||
`AutoMessagePeriod`
|
||||
* Specifies (in seconds) how often messages should be broadcasted to each server
|
||||
* Default — `60`
|
||||
|
||||
`AutoMessages`
|
||||
* Specifies the list of messages that are broadcasted to **all** servers
|
||||
* Specially formatted **tokens** can be used to broadcast dynamic information
|
||||
* `{{TOTALPLAYERS}}` — displays how many players have connected
|
||||
* `{{TOPSTATS}}` — displays the top 5 players on the server based on performance
|
||||
* `{{MOSTPLAYED}}` — displays the top 5 players based on number of kills
|
||||
* `{{TOTALPLAYTIME}}` — displays the cumulative play time (in man-hours) on all monitored servers
|
||||
* `{{VERSION}}` — displays the version of **IW4MAdmin**
|
||||
* `{{ADMINS}}` — displays the currently connected and *unmasked* privileged users online
|
||||
* `{{NEXTMAP}}` — 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
|
||||
* `Name`
|
||||
* Specifies the name of the map as returned by the game (usually the file name sans the file extension)
|
||||
* `Alias`
|
||||
* Specifies the display name of the map (as seen while loading in)
|
||||
___
|
||||
Loading…
Reference in New Issue
Block a user