WolfAdmin is very flexible and configurable. Currently it has over 30 settings which allow you to customize messages, adjust the module's behaviour or disable some functionality completely.Table of contents
Settings allow the module's features to behave in a different way, or disable some functionality completely. The list below is an overview of the settings that you can use to customize your server.
For installations running version 1.2.0 and later, you can find all of these settings in the wolfadmin.toml file in your mod folder (in fs_homepath). This is a TOML-formatted file.
For installations running versions before 1.2.0, the related CVAR that toggles the same functionality is also listed. This file follows the same syntax as the shrubbot.cfg file.
Specify the operating system that the server is running on.
type: unix, windows
standalone (g_standalone) added in 1.2.0
Enable or disable standalone mode.
Enable the printing of debug statements to client consoles.
For installations running version 1.1.x or lower, you can find these settings in wolfadmin.cfg. There are no CVARs for these settings due to the sensitivity of credentials.
type added in 1.1.0
Set the type of database to use.
type: sqlite3, mysql
file added in 1.1.0
Set the file of the database (SQLite3 only).
Set the hostname of the database server (MySQL only).
Set the port of the database server (MySQL only).
Set the database on the database server (MySQL only).
Set the username on the database server to use (MySQL only).
Set the password which is used for the user (MySQL only).
chat (g_logChat) added in 1.2.0
Sets the name of the chat log file. When nothing is set, chat logging is disabled.
admin (g_logAdmin) added in 1.2.0
Sets the name of the admin log file. When nothing is set, admin logging is disabled.
Set the minimum amount of omnibots which will be playing on the server.
Set the amount of omnibots which will be playing when someone uses !needbots.
Toggles whether warn history is enabled.
Set the maximum amount of renames a player can do within a minute.
Set the minimum difference in team balance before the evener puts someone or multiple people to the other team.
Set the maximum difference in team balance before the evener will shuffle the teams. Set to 0 to disable this feature.
selection (g_evenerPlayerSelection) added in 1.1.0
Set the selection of players that are used in the balancing process.
- 0 random balancing
- 1 only dead players
- 2 last joined player
- 4 no objective carriers
Set the interval, in seconds, for checking whether the teams are balanced or not. Set to 0 to disable the evener completely.
Toggles whether revive announcements are displayed.
Set the timeout, in seconds, after which next map voting is disabled.
Set voting types, separated by commas, which are not allowed to be called by a player, unless this player has the special % shrubbot flag.
Set the message which will displayed when a player connects to the server (will not be displayed on next map/map restart).
default: "^dwolfadmin: ^9This server is running WolfAdmin, type ^7/wolfadmin ^9for more information."
Set the area where the welcome message is displayed.
Sets the name of the rules config file. When nothing is set, rules display is disabled.
default: "rules.toml" changed in 1.2.0
Sets the name of the greetings config file. When nothing is set, greetings are disabled.
default: "greetings.toml" changed in 1.2.0
Set the area where greetings are displayed.
Enable greetings for bots.
Enable records for bots.
Sets the name of the spree records config file. When nothing is set and the database type is config files, spree records are disabled.
default: "sprees.toml" changed in 1.2.0
messages (g_spreeMessages) added in 1.2.0
Toggles which sprees to display.
- 0 no sprees will be displayed
- 1 enable kill sprees
- 2 enable death sprees
- 4 enable revive sprees
Toggles whether spree records and revive sprees are enabled.
Each player can have a greeting, either specified by the level of the player or a GUID. If a player has both a greeting specified by his/her level and one by GUID, the latter will have priority.
In the examples below, a player with GUID XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX and level 0 would see the latter greeting (Welcome back [name]^9!). Any other player with level 0 would see Welcome a guest! and hear Provide sniper cover!. Note that the greeting sounds are relative to the /sound/ directory in the .pk3 files. added in 1.0.1
TOML-based added in 1.2.0
For installations running version 1.2.0 and later, you can find all of these greetings in the greetings.toml file in your mod folder (in fs_homepath). This is a TOML-formatted file.
[[level]] level = 0 greeting = "Welcome a guest!" sound = "chat/axis/955a.wav" [[user]] guid = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" greeting = "Welcome back [N]^9!" sound = ""
Config-based removed in 1.2.0
For installations running versions before 1.2.0, these greetings can be configured through the greetings.cfg in the mod folder (in fs_homepath). This file follows the same syntax as the shrubbot.cfg file.
[level] level = 0 greeting = Welcome a guest! sound = chat/axis/955a.wav [user] guid = XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX greeting = Welcome back [N]^9! sound =
The rulebook of your server can be structured by WolfAdmin's support for rules. This makes it easy for server admins to show the rulebook to online players or to highlight a specific rule when it's needed.
In the examples below, any player that is allowed to execute the !rules command, will be able to show NO spawnkilling! to the rest of the players online by typing !rules sk.
TOML-based added in 1.2.0
For installations running version 1.2.0 and later, you can find all of these rules in the rules.toml file in your mod folder (in fs_homepath). This is a TOML-formatted file.
[[rule]] shortcut = "sk" rule = "^1NO ^7spawnkilling^9!"
Config-based removed in 1.2.0
For installations running versions before 1.2.0, these rules can be configured through the rules.cfg in the mod folder (in fs_homepath). This file follows the same syntax as the shrubbot.cfg file.
[rule] shortcut = sk rule = ^1NO ^7spawnkilling^9!
This system is only enabled in standalone mode.
Access control lists can be changed through the server console using the acl [action] command. The command currently offers the following functionality:
list all available levels and the amount of players in each level
addlevel [id] [name]
add a new level
remove a level
relevel [id] [newid]
move all players from one level to another
list all permissions in a level
isallowed [id] [permission]
check if a level has a certain permission
addpermission [id] [permission]
add a permission to a level
removepermission [id] [permission]
remove a permission from a level
copypermissions [id] [newid]
copy all permissions from one level to another
remove permissions from a level
When running the module in standalone mode, you will be able to grant administrators commands and abilities through permissions. These can be granted using the commands described above.
|throw||!throw !launch !fling added in 1.3.0|
|noinactivity added in 1.3.0||Player cannot be automatically kicked or put spec due to inactivity.|
|novote||Player cannot be vote-kicked, vote-muted, or complained against.|
|nocensor added in 1.3.0||Player will not be auto-censored or spam protected.|
|nobalance added in 1.3.0||Player can switch teams at any time, regardless of team balance.|
|novotelimit added in 1.3.0||Player can call vote at any time. Disabled voting or voting limits do not apply to the player.|
|noreason||Player can issue commands without a reason.|
|perma||Player can !ban without a time limit, the ban is a permanent ban.|
|teamcmds||Player can do the shrubbot commands via the team and fireteam chats.|
|silentcmds||Player can run commands silently in the console using /!command.|
|spy added in 1.3.0||Player can see Allied and Axis team chats as a spectator.|
|incognito||Player is shown as a level 0 with no AKA output in !listplayers.|
|immune||Player is immune to all shrubbot commands.|
When running the module in add-on mode, the ACL system is not available. Instead, to make the new functionality available, levels require additional shrubbot flags.
The flags should match the settings used on a community server. For example, !plock has the same flag as !lock and !listaliases is similar to !finger. The following table lists all the flags and their features.
|h||!listmaps, !rules silent|
!balance, !putbots nq silent
|C||!listmaps, !rules etpub nq|
|I||!stats, !sprees nq|
|R||!dewarn removed in 1.2.0, !showwarns|
|%||no vote restrictions|