GitHub - wizard45/AdKats: Battlefield Advanced In-Game Admin for PRoCon Frostbite

UPDATE 6.5.0.0 POSTED! Click here for details

New Extension! Click below for ability to enforce loadouts on-spawn!

Overview

Admin Toolset with a plethora of features, ~90 available in-game commands, and many customization options. AdKats focuses on making in-game admins more efficient and accurate at their jobs, with flexibility for almost any setup. Includes a cross-server ban enforcer with advanced enforcement features, metabans support, global admin management, cross-server player messaging, and the BFAdminCP 2.0+ for web-based control has been released. Designed for groups with high-traffic servers and many admins, but will function just as well for small servers.

Extensive In-Game Commands. Commands for player killing, kicking, punishing, banning, unbanning, moving, joining, whitelisting, messaging, etc, etc... ~90 available in-game commands. Commands can be accessed from in-game, Procon's chat window, database, HTTP server, and from other plugins.
Editable Ranks and Roles. Custom ranks and roles can be created for users, with each role given access to only the commands you want them to use. Default guest role is given to all players, and can be edited to your desired specs. Roles and powers are automatically synced between servers, so you only need to change user information once. Soldiers assigned to users will also keep their powers even if they change their in-game names.
Setting sync between servers. All changes to plugin settings are stored in the database, and can be automatically synced between your Procon layers. Setting up new layers or switching layers is a breeze, as the settings for existing servers are automatically imported on startup.
Infraction Tracking System. Punish/Forgive players for breaking rules on your servers. Everything is tracked, so the more infractions they commit, the worse their punishment automatically gets. Created so all players can be treated equally based on their history, regardless of who is issuing punishments against them. Heavily customizable.
Player Reputation System. System based on issued commands from and against players, forming a reputation on the server. Documentation below. Local leaderboard for reputation given in the BFAdminCP 2.0+.
Quick Player Report and Admin Call Handling, with email support. Notification system and quick handling features for all admin calls and player reports. Reports can be referenced by number for instant action. Automatic PBSS are triggered on reported players.
Orchestration and Server List Management. Server reserved slots, server spectator slots, autobalancer whitelising through MULTIBalancer, ping kick whitelists, and several others can all be automatically handled through the AdKats user list and orchestration commands.
AdKats Ban Enforcer. AdKats can enforce bans across all of your servers, and can enforce on all metrics at the same time. System will automatically import bans from your servers and consolidate them, and can import existing bans from the BF3 Ban Manager plugin's tables. Full documentation below.
BF3/BF4 "Hacker-Checker" with Whitelist. BF3Stats and BF4Stats are internally used to pull player information, and can be enabled for automatic cheat/hack detection with a couple clicks. Please read documentation before enabling.
Automatic Updates. AdKats can automatically update itself when stable releases are made, all it requires is a Procon instance reboot to run updated versions. This can be disabled, but is recommended to keep enabled.
Ping Enforcer. Automatic kick system based on ping, with moving average calculation, customizable messages, logged kicks, and manual ping options.
AFK Manager. Automatic kick system based on player AFK time, with manual kick command. Customizable durations, and option to ignore chat messages counting toward active time.
Internal SpamBot with Whitelist. SpamBot with options for simultaneous say, yell, and tell. Customizable interval between each type of message, and ability to whitelist players/admins from seeing spam messages.
Commander Manager. Commanders can cause team imbalance when the server is in low population. This manager allows control of commanders in those cases.
Cross-Server Player Messaging. Private conversations between players can operate not only within the same server, but will work between any online server in the database, and even between BF3 and BF4.
Admin Assistants. When fully used this can turn your regular playerbase into a human autoadmin. Trusted players can fill the gaps normal autoadmins don't see, utilizing the report system, and keeping your server under control even when admins are offline.
Email Notification System. Email addresses can be added to every user, and once enabled they will be sent emails for player reports and admin calls. I am currently working on adding command parsing on reply to emails, and possibly text message command support in the future.
Fuzzy Player Name Completion. Fully completes partial or misspelled player names. I've been consistently able to find almost any player only a few characters from their name.
Player Muting. Players can be muted if necessary, giving warnings and kicks if they talk. Automatic mute for language can be orchestrated using Insane limits.
Player Joining. Player's squads can be joined via command, and locked squads can be unlocked for admin entry.
Player Locking. Players can be locked from admin commands for a specific timeout, the main purpose is if a certain admin is handling them (checking stats for cheat detection, records, etc.) they shouldn't be interrupted by another admin acting on the player.
Player Assist. Player's want to play with their friends, but you don't want to imbalance the teams? The assist command lets any player join the weak team to help them out and squad up with friends without hurting the server.
Yell/Say Pre-Recording. Use numbers to reference predefined messages. Avoid typing long reasons or messages. e.g. @kill player 3
Server Rule Management. Server rules can be listed, requests for rules logged, rules targeted at players, and rules can be distributed between servers automatically.
External Controller API. AdKats can be controlled from outside the game through systems like BFAdminCP 2.0+, and through other plugins like Insane Limits. For example, you can issue AdKats punish commands from Insane Limits or ProconRulz and have them logged like any other admin command.
Internal Implementation of TeamSwap. Queued move system for servers that are consistently full, players can be queued to move to full teams once a slot opens.
Metabans Support. When using ban enforcer, all bans can be optionally submitted to metabans, and removed when a player is unbanned.
Editable In-Game Commands. Command text, logging options, and enable options can be edited to suit your needs.
Full Logging. One of the main reasons AdKats was created in the first place. All admin activity is trackable via the database per your custom settings for every command, so holding your admins accountable for their actions is quick and painless. And, if you are using BFAdminCP 2.0+ nobody but your highest admins will need manual Procon access.
Setting Lock. The settings page in AdKats can be locked with a password. This means even admins with access to plugin settings can be blocked from changes using the password.
Performance. All actions, messaging, database communications, and command parsing take place on their own threads, minimizing performance impacts.

AdKats was inspired by the gaming community A Different Kind (=ADK=)
Visit ADKGamers.com to say thanks!

Development by Daniel J. Gradinjan (ColColonCleaner)

If you find any bugs, please submit them HERE and they will be fixed ASAP.

1. A MySQL Database

A MySQL database accessible from your Procon layer is required. AdKats checks the database for needed tables on connect.

Getting a Database: Usually the hosting company for your layers can provide you a database, and using that is advisable as the latency between Procon and the DB will be the lowest possible. Or even better if you're hosting layers on a VPS just create a local database by downloading the appropriate installer from MySQL's website. We use our webserver for database hosting and that works great. Be cautious of free database options and services, those paths usually have restrictions on database size and are hosted on unreliable servers, which can lead to many problems down the road.

2. XpKiller's "Procon Chat, GUID, Stats and Mapstats Logger" Plugin

AdKats will only run if one of this plugin is (1) using the same database AdKats uses, and (2) running on every battlefield Server you plan to install AdKats on. Running it along-side AdKats on each Procon layer will ensure these conditions are met.

The latest universal version of XpKiller's Stat Logger can be downloaded from here: Procon Chat, GUID, Stats and Mapstats Logger

The BF3 only version of stat logger can be used with AdKats too, but it limits some of the functionality.

3. Web Request Access

AdKats uses web statistics and requests to manage players types, hack detection, user lists, and updates. The list of domains/sub-domains AdKats must be able to access for proper function are documented below in the "Web Requests" section.

Install XpKiller's Stat logger plugin. Download and install the latest universal version of XpKiller's Procon Chat, GUID, Stats and Mapstats Logger. Make sure stat logger is running without error for a few minutes after installation. If you are already running the BF3 only version of stat logger, that is fine, but the universal version is preferred for full functionality.
GO BACK TO STEP 1 AND INSTALL STAT LOGGER. I cannot emphasize this enough; Far too many people have posted issues because they refuse to follow instructions. Do NOT attempt to install AdKats until that plugin is running without issue.
Set up the database. Run the contents of the AdKats Database Setup Script on your database, on the same schema stat logger uses. WARNING, if you already have AdKats installed, this will completely wipe your existing information for this plugin. The script must be run by an account with permissions to create tables, triggers, and stored procedures.
Download the plugin. Download the Latest Stable Release of AdKats
Add the plugin to Procon. Add the plugin file (AdKats.cs) to Procon as you would any other, in either the plugins/BF3 or plugins/BF4 folder depending on which game your layer is running on.
Enter database credentials. All database connection information must be entered in the settings tab before AdKats can run.
Enable AdKats. AdKats will confirm all dependencies and show confirmation in the console. If startup completes and provides notification it is running, then all is well. AdKats will automatically update itself with new patches and releases. Enjoy your new admin tool!

If you have any problems installing AdKats please let me know on the MyRCON forums, or on Github as an issue and I'll respond promptly.

Trouble running the setup SQL script. If this happens it is most likely your database provider has restricted your access to create either triggers, stored procedures, or both. These elements are required for AdKats to properly function, and thus it cannot be run without them. Please talk with your database provider and gain access to creation of stored procedures and triggers.
"Stat logger tables missing" on first run after setting up the plugin. Confirm you have run the stat logger plugin on the same layer and it is functioning without error. If it is, try rebooting your layer.
Suggest more for this list if you run across them.

User Ranks and Roles

On first enable you will need to add a user before you can access a majority of the in-game commands. You can have as many users as you want. When a user is added you need to assign them a role. The default role is "Default Guest" and the allowed commands for that role are shown to you in the role section. The default guest role cannot be deleted, but can be edited to your heart's content. You can add more roles by typing a new role name in the "add role" field. Any newly added roles default to allow all commands, so you will need to edit the allowed commands for new roles. When you change a user's role and they are currently in-game they will be told that their role has changed, and what it was changed to.

Once a user is added you need to assign their soldiers. If you add a user with the same name as their soldier(s), their soldier(s) will be added automatically. Users can have multiple soldiers, so if your admins have multiple accounts you can assign all of those soldiers under their user. All soldiers added need to be in your database before they can be added to a user. This system tracks user's soldiers, so if they change their soldier names they will still have powers without needing to contact admins about the name change. Type their soldier's name in the "new soldier" field to add them. It will error out if it cannot find the soldier in the database. To add soldiers to the database quickly after installing stat logger for the first time, have them join any server you are running this version of AdKats on and their information will be immediately added.

The user list is sorted by role ID, then by user name. Any item that says "Delete?" you need to type the word delete in the line and press enter.

Full Logging

All commands, their usage, who used them, who they were targeted on, why, when they were used, and where from, are logged in the database. All plugin actions are additionally stored in Procon's event log for review without connecting to the database. Player's name/IP changes are logged and the records connected to their player ID, so tracking players is easier.

Infraction Tracking System

Infraction Tracking commands take the load off admins remembering which players have broken server rules, and how many times. These commands have been dubbed "punish" and "forgive". Each time a player is punished a log is made in the database; The more punishes they get, the more severe the action gets. Available punishments include: kill, kick, temp-ban 60 minutes, temp-ban 1 day, temp-ban 1 week, temp-ban 2 weeks, temp-ban 1 month, and permaban. The order and severity of punishments can be configured to your needs.

Detailed Stuff: After a player is punished, their total points are calculated using this very basic formula: (Punishment Points - Forgiveness Points) = Total Points Then an action is decided using Total Points from the punishment hierarchy. Punishments should get harsher as the player gets more points. A player cannot be punished more than once every 20 seconds; this prevents multiple admins from accidentally punishing a player multiple times for the same infraction.

TeamKilling Management

The punish and forgive commands in AdKats are admin use only. If you would like to integrate a teamkill punish/forgive system with the AdKats punish system, use the Team Kill Tracker Plugin and enable the AdKats integration settings.

IRO Punishments

When a player is punished, and has already been punished in the past 10 minutes, the new punish counts for 2 points instead of 1 since the player is immediately breaking server rules again. A punish worth 2 points is called an "IRO" punish by the plugin, standing for Immediate Repeat Offence. "[IRO]" will be appended to the punish reason when this type of punish is activated.

Punishment Hierarchy

The punishment hierarchy is configurable to suit your needs, but the default is below.

Total Points	Punishment Outcome	Hierarchy String
Less than 1	Warn	warn
1	Warn	warn
2	Kill	kill
3	Kick	kick
4	Temp-Ban 1 hour	tban60
4	Temp-Ban 2 hours	tban120
5	Temp-Ban 1 Day	tbanday
6	Temp-Ban 1 Week	tbanweek
7	Temp-Ban 2 Weeks	tban2weeks
8	Temp-Ban 1 Month	tbanmonth
9	Perma-Ban	ban
Greater Than 9	Perma-Ban	ban

Players may also be 'forgiven', which will reduce their Total Points value by 1 each time, this is useful if you have a website where players can apologize for their actions in-game. Players can be forgiven into negative total point values which is why a 'less than 1' clause is needed.

You can run multiple servers with this plugin on the same database; A different ID is automatically assigned to each server. If you want punishments to increase on this server when infractions are committed on others set "Combine Server Punishments" to true. Rule breaking on another server won't cause increase in punishments on the current server if "Combine Server Punishments" is false. This is available since many groups run different rule sets on each server they own, so players breaking rules on one server may not know rules on another, so they get a clean slate.

Suggestions: When deciding to use this system, 'punish' should be the only command used for player rule-breaking. Other commands like kill, or kick are not counted in the system since sometimes players ask to be killed, admins kill/kick themselves, or players get kicked for AFKing. Kill and kick should only be used for server management. Direct temp ban and ban are of course still available for hacking/glitching situations, but that is the ONLY time they should be used.

Player Reputation System

Reputation is a numeric for how helpful a player is to the server. The more they help admins by reporting rule breakers, especially from spectator, or assisting the weak team, the more their reputation increases. Committing infractions, breaking server rules, getting banned, etc, reduces their server reputation.

Reputation starts at zero, and is capped between -1000 and 1000, so it's easy to get/lose rep early on, but harder near the top/bottom. Players will never reach -1000 or 1000 reputation, but can get close. Each command a player issues, and every command issued against them, has a reputation amount; Some good, some bad. Every time a player's reputation changes, you are notified of the change in chat.

The following are ways reputation can be gained:

Issuing good reports on players. Just reporting someone gives rep, but when an admin accepts the report or acts on it it's triple the rep bonus.
Reporting from spectator. Reporting from spectator is worth much more than reporting in-game. Players are sacrificing their game time to help a server and should be rewarded.
Using @assist. Sometimes teams really need help, and sometimes a player's friends are stuck on the weak team. Helping them and the server out by using this command to switch increases rep greatly.

If a player has infractions on their record, that causes a reputation reduction, but the reduction they cause reduces over time. So if they have infractions on their record, simply not committing them for a while reduces the rep loss caused. It does not reduce completely however, they will need to report some rule breakers to get it positive again.

Ban Enforcer

AdKats can enforce bans across all of your servers. The Ban Enforcer will import and consolidate bans from every Procon instance you run. Bans can be made by name, GUID, IP, any combination, or all at once. The default ban is by EA GUID only, this default can be edited but is not recommended. Banned players are told how long their ban will last, and when a banned player attempts to re-join they are told the remaining time on their ban. Using ban enforcer also gives access to the unban and future-ban commands.

The Enforcer works properly with existing auto-admins, and any bans added manually through Procon will be automatically imported by the system. A mini-ban-management section is added to the plugin settings when you enable this, however, for full fledged ban management it helps to run the BFAdminCP 2.0+ by Prophet731. Ban enforcer's options are simply too much for the plugin setting interface to house properly. Use of the ban enforcer is optional because of this slight dependency, and is disabled by default.

Ban Enforcer can be enabled with the "Use Ban Enforcer" setting. On enable it will import all bans from your ban list then clear it. Once you enable enforcer you will be unable to manage any bans from Procon's banlist tab. Disabling ban enforcer will repopulate Procon's banlist with the imported bans, but you will lose any additional information ban enforcer was able to gather about the banned players.

Reasoning behind creation, for those interested: We had tried many other ban management systems and they all appeared to have some significant downfalls. Developing this allowed for some nice features not previously available.

I can bypass Procon's banlist completely, this way no data is lost on how/why/who created the ban or on who it's targeted.
I can enforce bans by any parameter combination (Name, GUID, IP), not just one at a time.
Players can now be told how much time is left on their ban dynamically, every time they attempt to join.
Tracking of bans added through in-game commands or autoadmins on any server is a cakewalk now, so clan leaders don't need to go great lengths to look things up.

Several other reasons as well, but overall it was a fantastic move, and thankfully we had the devs available to make it happen.

Report/CallAdmin System w/Email Support

When a player puts in a proper @report or @admin all in-game admins are notified. Reports are logged in the database with full player names for reporter/target, and the full reason for reporting. Uses of @report and @admin with this plugin require players to enter a reason, and will tell them if they haven't entered one. It will not send the report to admins unless reports are complete, which cleans up what admins end up seeing for reports.

Using Report IDs

Reports and calls are issued a random three digit ID which expires either at the end of each round, or when it is used. These ID's can be used in any other action command, simply use that ID instead of a player-name and reason (e.g. waffleman73 baserapes, another player reports them and gets report ID 582, admins just use @punish 582 instead of @punish waffleman73 baserape). Confirmation of command with @yes is required before a report ID is acted on. Players are thanked for reporting when an admin uses their report ID. Other online admins are informed when an admin acts on a report by ID, either with action, deny, or accept.

Report Emails

When email usage is enabled, all users with access to player interaction commands will get an email containing the report information.

Report PBSS

Automatic Punkbuster screenshots are triggered on reported players.

Admin Assistants

This system has been completely revamped in 4.1.0.0, and several hidden features have now been released to the public. We utilized the full system on our no explosives server with great success, mainly catching things autoadmin cannot. Basically this system automatically tracks who the trusted players in your servers are, and who are reliable sources of reports.

Basic Functionality

The system makes use of the report IDs assigned to each round report. When a player sends a report, and an admin uses the report by ID, the report is logged as confirmed. Once you enable Admin Assistants, AA status is given once the player has X confirmed reports in the past month or 75+ total confirmed reports. A player with AA status is informed of their status on first spawn in the server after joining. If you enable the admin assistant perk, players with AA status are given access to the teamswap and online-admins commands for the duration they maintain AA status. These command perks are basically incentives to report rule-breakers. Whether a player has AA status is calculated when they join the server, and that status will remain for the duration they are in the server. When an admin assistant sends a report, to the admins their name is prefixed with [AA] to note it as a (most likely) reliable report. Likewise if an admin assistant is the target of a report, their name is prefixed with a clan-tag-like code. (e.g. Report [512]: [AA]ColColonCleaner reported [AA]SomeOtherAA for using explosives).

Advanced Usage (Auto-Handling)

The advanced functionality of this system is now released to the public as testing is complete. This subsection uses your AAs as a collective human autoadmin.

Players with AA status can conditionally have their reports acted on by the internal autoadmin.
A list of trigger words or phrases of any length can be defined in AdKats settings.
If an AA report reason contains any of those trigger words or phrases then autoadmin will act on their report with a
punish on the target player, using the reason they entered.
This was originally intended for cases when admins are offline and unable to answer reports, but has now been added
for all cases.
If admins are offline, and the report matches criteria, autoadmin will punish the target player after 5 seconds.
If admins are online, a 45 second window is given for the admin to act on the report before automatic handling
fires.
Admins can use any action command just like normal (e.g. @kill ID, @punish ID, etc...), but can also use the new
@accept, @ignore, and @deny commands.
@accept will confirm the report but take no action against the target player.
@ignore is used for bad or invalid reports, the report is removed from the list and no action is taken.
@deny is for malicious reports and abuse of the report system, this command will destroy a reporter's reputation and
hurt their AA status.<br/><br/>

Exceptions and Security Measures:
Automatic handling will not be taken if the target of a report is an admin or another AA, a real admin must act on
the report.
Automatic action will also not be taken if the target player has already been acted on in some way in the past 60
seconds.

Extended Round Statistics

Basic round statistics can be found through stat logger in the tbl_mapstats table, but these stats only give basic information at round end. AdKats adds a table tbl_extendedroundstats, which shows how matches progress while the round is still going, not just at the end. Every 30 seconds, the current round ID, round duration, team counts, ticket counts, ticket difference rates, team total scores, score rates, and a timestamp are logged in the table. A display of this information (in part) can be seen in the BFAdminCP 2.0+ server stats page. Logging starts at the beginning of each round, it will not start immediately for the current round when AdKats enables.

Player Muting

Players can be muted using the mute command. Muting lasts until the end of the round. Players who talk in chat after being muted will be killed each time they talk (up through X chat messages). On the (X+1)th chat message they are kicked from the server. A player coming back during the same round is kicked again on their first chat message. No action other than kill or kick is used by this system. There will be no way to un-mute players, there was a reason they were muted, and they can talk again next round. Admins cannot mute other admins.

Player Joining

Players can be joined using the join command. Joining either works off of player name or report ID. Issuing the command will place you in the targeted player's squad if there is room available. The command is available to all players, but for the general public will only operate for the same team. If user has TeamSwap or higher access, this will work across teams. If user has admin access, the target squad will be unlocked for their entry. NOTE: For cross-team joining, TeamSwap queues are not used, so if there is no room on the target team you will need to retry the command once room is available.

Pre-Messaging

A list of editable pre-defined messages can be added in settings, then admins can use the message ID instead of typing the whole message in. Example: "@say 2" will send the second pre-defined message.

Use @whatis [preMessageID] to find out what a particular ID links to before using it in commands.

Anywhere a reason or message is needed, a preMessage ID can be used instead.
Example: 4th preMessage is "Baserape. Do not shoot uncap."
"@punish muffinman 4" will punish them for the above reason. Even more useful is using report IDs with this, for example someone reports muffinman for "baseraping asshat" and gets report ID 283. You don't want "baseraping asshat" to be the actual reason entered, so you can just do "@punish 283 4", and he will get the proper punish message.

TeamSwap

TeamSwap is NOT an autobalancer (look up other plugins for that functionality), it is for manual player moving only.

TeamSwap is a server-smart player moving system which offers two major benefits over the default system. Normally when trying to move a player to a full team the command just fails at the server level, now the player is dropped on a queue until a slot opens on that side. They can keep playing on their side until that slot opens, since when it does they are immediately slain and moved over to fill it. Secondly it allows whitelisted (non-admin) players the ability to move themselves between teams as often as they want (within a ticket count window). This is currently not an available option in default battlefield aside from Procon commands since the game limits players to one switch per gaming session. Whitelisted players can type '@moveme' and TeamSwap will queue them. This is meant to be available to players outside the admin list, usually by paid usage to your community or to clan members only. Admins can also use '@moveme', and in their case it bypasses the ticket window restriction. When players are moved by admins, use the moveme command, or use assist, they are locked to that team for the current round. When a player is moved by admin, multibalancer unswitcher is disabled for a few seconds to remove the chance of autobalancer fighting admin moves.

Requiring Reasons

Any ommand which might lead to actions against players are required to have a reason entered, and will cancel if no reason is given. Players (even the most atrocious in some cases) should know what they were acted on for, and it's also a good way to hold admins accountable for their actions. The minimum number of characters for reasons is editable in plugin settings. The editable setting only applies to admin commands, and the default value is 5 characters. Reports and Admin calls are hardcoded to 1 character minimum reason lengths.

Setting Sync

Plugin settings are automatically synced to layers every 5 minutes from their particular server IDs. Settings for each plugin instance are stored in the database by server ID. Enter an existing server ID in the setting import field and all settings from that instance will be imported to this instance. Settings on the current instance will be overwritten by the synced settings. Whenever a setting is changed, that change is persisted to the database.

Special Player Lists

Special player list table "adkats_specialplayers" has been added. In this table, players can be added to any desired group accepted by AdKats. Valid groups are currently slot_reserved, slot_spectator, whitelist_multibalancer, blacklist_dispersion, and whitelist_hackerchecker. Players can be added by ID, or by identifier (name, guid, or IP), and can be assigned a game and server to apply them to. If you use player IDs then you wont need to update player names if they change their names, the player names will automatically update when they join the server; This is especially good to use when whitelisting for the hacker-checker. Leave fields blank to indicate wildcard, for example leaving the server column blank for player will mean it applies to all servers of their game. If you specify the server, the group you have them assigned to will only apply for that one server. Each special player list entry now has an effective and expiration date, stored in UTC time.

3rd Party Plugin Orchestration

Orchestration table "adkats_orchestration" has been added. All entries in this table are polled every 5 minutes and sent to the appropriate plugins. Add entries to that table with a given server ID, plugin name, plugin setting name, and setting value. AdKats will send those settings to the target plugins every 5 minutes.

Internal Hacker-Checker with Whitelist

The "Hacker-Checker", however strangely named, is a system for automatically catching and acting on players with suspicious or impossible statistics.

The system uses BF3Stats.com and BF4Stats.com for player stats, and is able to catch both aimbots and damage mods. To avoid false positives, only weapons that fire bullets (no crossbow, M320, Knife, etc), and deal less than 50% damage per shot are included in the calculations. This removes all equipment, sniper rifles, shotguns, and heavy-hitting pistols like the magnum/rex from damage calculations. For the remaining weapons there are three checks each one goes through, customizable to your desired trigger levels.

Damage Mod Checker

Damage per shot for all known weapons is held on the AdKats repository, and is downloaded when the plugin enables. If a weapon damage is not found in that repository, the weapon damage from BFXStats API is used instead. Those values are not always correct, so inform ColColonCleaner about any new weapons or missing entries. The damage per shot each player gets with that weapon is calculated from BF3Stats/BF4Stats. The threshold you set for this check is the percentage above normal required to trigger the ban. We have ours set at 50% above normal damage (just 50 in the setting). e.g. A weapon is dealing at least 150% of the damage it normally should. (A 25 DPS assault rifle is dealing 37.5+ DPS) Every ban on trigger level 50 on our servers has been examined personally, and this check has never triggered a false positive. 50 kills with the weapon in question are required to trigger a ban using this check.

Aimbot Checker

For this check only automatic weapons from specific categories are used in the calculation. This includes Sub Machine Guns, Assault Rifles, Carbines, and Machine Guns. Handguns, snipers, equipment, etc are not included since their HSK values can vary drastically. This limit is simple, if the headshot/kill percentage for any valid weapon is greater than your trigger level, the ban is issued. HS/K percentage for even the top competitive players caps at 38%, so we set our value much higher than that. We started with 70% HS/K, and no false positives were found with that value, but lower as desired. The minimum we allowed during testing was 50%. 100 kills with the weapon in question are required to trigger this check.

KPM Checker

Be careful with this one, this is where a lot of legit competitive players reside. This check should only be used to request video gameplay of players to prove their play, then whitelist the player. For this check all weapons aside from melee weapons and equipment are included. This includes Sub Machine Guns, Assault Rifles, Carbines, Machine Guns, Handguns, and Sniper Rifles. This check uses weapon time and total kills, rather simple, just kills/total minutes. If that value is greater than your trigger level the ban is issued. After some research and testing the value used on our servers is the default, 4.5. 100 kills with the weapon in question are required to trigger this check.

Posting Method

The heaviest hacked weapon (the one farthest above normal) is the one displayed in the ban reason using the following formats:
Damage Mod Bans:
DPS Automatic Ban [WEAPONNAME-DPS-KILLS-HEADSHOTS]
Aimbot Bans:
HSK Automatic Ban [WEAPONNAME-HSK-KILLS-HEADSHOTS]
KPM Bans:
KPM Automatic Ban [WEAPONNAME-KPM-KILLS-HEADSHOTS]

DPS bans take priority over HSK bans, and HSK over KPM.
Whitelisting can either be done using the hcwhitelist command, or by entering their player ID, name, guid, or IP in the adkats_specialplayers table using the group "whitelist_hackerchecker"
If a player is not found on BF3Stats or BF4Stats, AdKats will keep checking for stats every couple minutes while they are in the server, stopping if they leave.

Additional info posts about the calculations:
https://forum.myrcon.com/showthread.php?6045-AdKats-Advanced-In-Game-Admin-and-Ban-Enforcer-4-0-0-0&p=90700&viewfull=1#post90700
https://forum.myrcon.com/showthread.php?6045-AdKats-Advanced-In-Game-Admin-and-Ban-Enforcer-4-0-0-0&p=92106&viewfull=1#post92106

Automatic Updates

AdKats is set up to automatically update itself when stable releases are made, so there is no need to upload newer versions to your layer once you are running it. Once the update is automatically downloaded and patched, all it requires is a Procon reboot to run the updated version. Admins will be informed of available updates when they are published, or if the plugin was able to automatically update, that the Procon instance needs to be rebooted. The automatic update process can be disabled for those who want to manually update, but it is enabled by default.

Ping Enforcer

Ping enforcer allows control of players over a certain average ping, with several key options. A linearly interpolated moving average is used to monitor ping of all players in the server, kicking players after a minimum monitor time is reached, and a minimum number of players are in the server. The system can kick for missing ping, and attempt to manually ping players whose pings are not given by the server.

Players who join the server and are over the limit are warned about it in chat. Players whose ping is normal, but spikes over your limit, are warned about the spike.

Admins are automatically whitelisted, but the entire user list can be optionally whitelisted, or a given subset of role keys. Individual players can be whitelisted with the pwhitelist command.

AFK Manager

AFK Manager allows control over players staying in the server without contributing. Kicking AFK players can be done automatically, or via the AFK command. When automatic kick is enabled it will monitor all players in the server, kicking them after the trigger AFK time is reached, but only if the number of players in the server is over a certain amount.

Chat can be optionally ignored, so players just spamming chat without playing can be removed from the server.

Admins are automatically whitelisted, but the entire user list can be optionally whitelisted, or a given subset of role keys. Spectators are immune to AFK kicks.

Internal SpamBot with Whitelist

The internal SpamBot is much akin to that found in other plugins, with a few added bells and whistles. Automatic messages can be set in separate lists for say, yell, and tell options. Each list has its own interval that can be customized, the defaults being 300, 600, and 900 seconds, respectively.

The key difference is that admins and whitelisted players can be blocked from seeing SpamBot messages. This way your admins' chat are not cluttered with messages meant only for promotion or information they already know.

Individual players can be whitelisted from seeing messages using the spamwhitelist command.

Commander Manager

In cases of low population, commanders can mean the difference between a balanced server and baserape. This manager will not allow players to join as commander until a specified minimum number of players are in the server.

We found a good value to be 40 players on 64p servers.

Surrender Vote System

Surrender is used when one team is much stronger than another, to the point of it becoming nearly impossible for the losing team to move around the map. With this system players can vote to end the round with the current winning team as winner, having the running autobalancer scramble teams for a more balanced game next match.

There are 3 commands that are used for surrender vote, surrender, votenext, and nosurrender. Access to these three commands, or a subset of them, must be given to your "Guest" role in the role settings section before this system can be used.

surrender. This command is usable by both teams, but will be translated to votenext if used by the winning team. Players on the losing team don't want to sit though a baserape, this command lets them vote toward round surrender. It adds one vote toward surrender.
votenext. This command is usable by both teams, but will be translated to surrender if used by the losing team. Players on the winning team will sometimes find it boring sitting at a baserape, this command lets them place their vote toward ending the round. It adds one vote toward surrender.
nosurrender. This command is usable only by the losing team. If someone doesn't think the situation is bad enough to warrant a surrender, they can use this command to vote against it. Removes one vote toward surrender.

Minimum player counts, minimum ticket differences, and minimum ticket difference rates can be added as limits for starting a round surrender. These are important as they prevent players from starting a surrender vote when it's not warranted or necessary.

A timeout can be added to the surrender vote. When enabled and the timeout expires after starting the vote, the vote is canceled and all votes removed.

Auto-Surrender/Auto-Nuke System

Sometimes surrender vote is not enough to help the server. This system uses ticket loss/gain rates to automatically trigger either round surrender on the losing team, or auto-nuke on the winning team. This system should not be used on servers that run mixed mode, as different modes will have drastically different ticket rates.

Do not enable this system until you have analyzed the ticket loss/gain rates that consistently happen during baserape on the particular server you wish to enable this on. Using the 'Display Ticket Rates in Procon Chat' setting in section A12 will display the rates in the Procon chat tab for analysis. Once you have the values you can set the windows for winning/losing team ticket rates, activating auto-surrender or auto-nuke.

Other limits like minimum ticket difference and trigger count help make sure the ticket rates it sees are actually from a baserape and not from any other case.

Once a round matches all of the parameters you set, auto-surrender or auto-nuke is triggered. Auto-surrender will cause the round to end, in favor of the current winning team. Auto-nuke will kill every player on the winning team that is currently alive; It will typically issue 1-3 times, making sure all players are dead.

Automatic Database Disconnect/Malfunction Handling System

If the connected database goes offline, or becomes over encumbered to the point of being unusable, AdKats will automatically handle that state. If that state is reached, AdKats will temporarily halt all interaction with the database, disable stat logger, and wait for the situation to be rectified. Checks for fixed connection are made every 30 seconds, and once restored stat logger and AdKats connections with the database are re-enabled.

Commanding AdKats from External Source

BFAdminCP 2.0+ can be used for this.

There are currently two ways to interact with AdKats externally. (A third coming soon if possible).

Adding Database Records

Have your external system add a row to the record table with a new record to be acted on. All information is needed in the row just like the ones sent from AdKats to the database. Review the ones already in your database before attempting this, and ask ColColonCleaner any questions you may have. The only exception is you need to make the 'adkats_read' column for that row = "N", this way AdKats will act on that record. Every 5-10 seconds the plugin checks for new input in the table, and will act on them if found.

Using external plugin API

Two available MatchCommands have been added, one for issuing commands through AdKats, and the second for fetching admin lists. These can be called by other plugins to integrate their functionality with AdKats and its database.

FetchAuthorizedSoldiers

Plugin: AdKats
Method: FetchAuthorizedSoldiers
Parameters:

caller_identity String with ID unique to the plugin sending the request. No whitespace or special characters. e.g. "InsaneLimits"
response_requested true
response_class Class/plugin where the callback will be sent.
response_method Method within the target plugin that will accept the response
user_subset "admin", "elevated", or "all". Admin meaning they have access to player interaction commands, elevated meaning they do not. Returns all soldiers in that subset.
user_role Returns all soldiers belonging to users in a specific role.

(user_subset and user_role cannot be used at the same time, pick one or the other.)

Response:

caller_identity AdKats
response_requested false
response_type FetchAuthorizedSoldiers
response_value List of soldiers that matched the given parameters. CPluginVariable.EncodeStringArray used to compact into one field. CPluginVariable.DecodeStringArray can be used to parse the field back into an array.

IssueCommand

Plugin: AdKats
Method: IssueCommand
Parameters:

caller_identity String with ID unique to the plugin sending the request. No whitespace or special characters. e.g. "InsaneLimits"
response_requested true/false. Whether the caller would like a response with the outcome of the command.
response_class Only if response_requested is true. Class/plugin where the callback will be sent.
response_method Only if response_requested is true. Method within the target plugin that will accept the response.
command_type Command key that references the desired command. Examples: player_kill, player_ban_perm, admin_say.
command_numeric Used for commands like player_ban_temp that require a numerical input. Currently player_ban_temp is the only command that requires a command numeric, and will throw errors if a numerica is not provided. In all other cases this field is optional.
source_name Name of the source you would like database logged. For example an admin name, plugin name, or a custom name like AutoAdmin.
target_name The exact name of the target you would like to issue the command against, usually a player name. For commands like admin_nuke which don't accept a player name, special syntax is used, documentation of such is provided in the readme.
target_guid Only required when binding to onJoin, onLeave, or other events where the player may not be loaded into AdKats' live player list yet. If the player cannot be found in the live player list by target_name then this guid is used to fetch their information from the database and perform the command.
record_message The message or reason that should be used with the command. e.g. Baserape. Message can be up to 500 characters.

Response:

caller_identity AdKats
response_requested false
response_type IssueCommand
response_value List of all messages sent for the command, comparable to what an admin would see in-game. CPluginVariable.EncodeStringArray used to compact into one field. CPluginVariable.DecodeStringArray can be used to parse the field back into an array. If the command succeeds withouth issue there should (generally) only be one message.

If all the required parameters are provided, the command will execute and log to the database. Response sent if it was requested.

Plugin Example:

var requestHashtable = new Hashtable{
     {"caller_identity", "YourPlugin"},
     {"response_requested", false},
     {"command_type", "player_ban_perm"},
     {"source_name", "AutoTest"},
     {"target_name", "ColColonCleaner"},
     {"target_guid", "EA_698E70AF4E420A99824EA9A438FE3CB1"},
     {"record_message", "Testing"}
};
ExecuteCommand("procon.protected.plugins.call", "AdKats", "IssueCommand", "YourPlugin", JSON.JsonEncode(requestHashtable));

InsaneLimits Example (OnKill Activation):

Hashtable command = new Hashtable();
command.Add("caller_identity", "InsaneLimits");
command.Add("response_requested", false);
command.Add("command_type", "player_punish");
command.Add("source_name", "AutoAdmin");
command.Add("target_name", player.Name);
command.Add("target_guid", player.EAGuid);
command.Add("record_message", "Using restricted weapon " + kill.Weapon);
plugin.CallOtherPlugin("AdKats", "IssueCommand", command);

You can edit the text for each command to suit your needs in plugin settings.

Commands can be accessed with '!', '@', '.', '/!', '/@', '/.', or just '/'.

Any action command given with no parameters (e.g. '!kill') will target the speaker. If admins want to kill, kick, or even ban themselves, simply type the action command without any parameters. Any action command when given a player name (other than moving players) will require a reason.

Command	Default Text	Params	Description
Confirm Command	yes	None	The in-game command used for confirming other commands when needed. Must be active. Must be accessible under 'Any'. Must use 'yes' as command text. Cannot be denied for any role.
Cancel Command	no	None	The in-game command used to cancel other commands when needed. Must be active. Must be accessible under 'Any'. Must use 'no' as command text. Cannot be denied for any role
Kill Player	kill	None OR [player][reason] OR [reportID] OR [reportID][reason]	The in-game command used for killing players. If the player is dead, they will be killed on spawn.
Kill Player (Force)	fkill	None OR [player][reason] OR [reportID] OR [reportID][reason]	Bypasses all extra functionality of the regular kill command, issuing admin kill on them immediately.
Kick Player	kick	None OR [player][reason] OR [reportID] OR [reportID][reason]	The in-game command used for kicking players.
Temp-Ban Player	tban	[duration] OR [duration][player][reason] OR [duration][reportID] OR [duration][reportID][reason]	The in-game command used for temp-banning players. Default time is in minutes, but the number can have a letter after it designating the units. e.g. 2h for 2 hours. Valid suffixes are m, h, d, w, and y.
Perma-Ban Player	ban	None OR [player][reason] OR [reportID] OR [reportID][reason]	The in-game command used for perma-banning players.
Future Perma-Ban Player	fban	[time] OR [time][player][reason] OR [time][reportID] OR [time][reportID][reason]	The in-game command used for future-banning players. Default time is in minutes, but the number can have a letter after it designating the units. e.g. 2h for 2 hours. Valid suffixes are m, h, d, w, and y. Future ban is the exact opposite of a temp-ban. Enter the time the player has until they are permabanned. This is used for requesting action/videos/etc from players, giving them a time frame to do so. Ban is enforced on-join only, not during gameplay. This command can only be used when ban enforcer is enabled.
Unban Player	unban	[player] OR [player][reason]	The in-game command used for unbanning players. This command can only be used when ban enforcer is enabled.
Punish Player	punish	None OR [player][reason] OR [reportID] OR [reportID][reason]	The in-game command used for punishing players. Will add a Punish record to the database, increasing a player's total points according to your settings, and issue the configured action for that point value.
Forgive Player	forgive	None OR [player][reason] OR [reportID] OR [reportID][reason]	The in-game command used for forgiving players. Will add a Forgive record to the database, decreasing a player's total points by 1.
Warn Player	warn	None OR [player][reason] OR [reportID] OR [reportID][reason]	The in-game command used for warning players. This will give them a verbal warning across their screen, and log that they were warned.
Mute Player	mute	None OR [player][reason] OR [reportID] OR [reportID][reason]	The in-game command used for muting players. Players will be muted till the end of the round, X kills then kick if they keep talking. Admins cannot be muted.
Reserved Slot Player	reserved	[duration or 'perm'] OR [duration or 'perm'][player] OR [duration or 'perm'][player][reason]	The in-game command used for adding a player to reserved slots for the current server. The setting "Feed Server Reserved Slots" must be enabled to use this command.
Un-Reserved Slot Player	unreserved	[player]	The in-game command used for removing a player from reserved slots for the current server. The setting "Feed Server Reserved Slots" must be enabled to use this command.
Spectator Slot Player	spectator	[duration or 'perm'] OR [duration or 'perm'][player] OR [duration or 'perm'][player][reason]	The in-game command used for adding a player to spectator list for the current server. The setting "Feed Server Spectator List" must be enabled to use this command.
Un-Spectator Slot Player	unspectator	[player]	The in-game command used for removing a player from spectator slots for the current server. The setting "Feed Server Spectator List" must be enabled to use this command.
Ping Whitelist Player	pwhitelist	[duration or 'perm'] OR [duration or 'perm'][player] OR [duration or 'perm'][player][reason]	The in-game command used for adding a player to the ping kick whitelist for all servers.
Un-Ping Whitelist Player	unpwhitelist	[player]	The in-game command used for removing a player from ping kick whitelist for all servers.
AA Whitelist Player	aawhitelist	[duration or 'perm'] OR [duration or 'perm'][player] OR [duration or 'perm'][player][reason]	The in-game command used for adding a player to the Admin Assistant whitelist for all servers.
Un-AA Whitelist Player	unaawhitelist	[player]	The in-game command used for removing a player from Admin Assistant whitelist for all servers.
SpamBot Whitelist Player	spamwhitelist	[duration or 'perm'] OR [duration or 'perm'][player] OR [duration or 'perm'][player][reason]	The in-game command used for adding a player to the SpamBot whitelist for all servers.
Un-SpamBot Whitelist Player	unspamwhitelist	[player]	The in-game command used for removing a player from SpamBot whitelist for all servers.
MULTIBalancer Whitelist Player	mbwhitelist	[duration or 'perm'] OR [duration or 'perm'][player] OR [duration or 'perm'][player][reason]	The in-game command used for adding a player to MULTIBalancer whitelist for the current server. The setting "Feed MULTIBalancer Whitelist" must be enabled to use this command.
Un-MULTIBalancer Whitelist Player	unmbwhitelist	[player]	The in-game command used for removing a player from MULTIBalancer whitelist for the current server. "Feed MULTIBalancer Whitelist" must be enabled to use this command.
MULTIBalancer Disperse Player	disperse	[duration or 'perm'] OR [duration or 'perm'][player] OR [duration or 'perm'][player][reason]	The in-game command used for adding a player to MULTIBalancer even dispersion for the current server. The setting "Feed MULTIBalancer Even Dispersion List" must be enabled to use this command.
Un-MULTIBalancer Disperse Player	undisperse	[player]	The in-game command used for removing a player from MULTIBalancer even dispersion for the current server. "Feed MULTIBalancer Even Dispersion List" must be enabled to use this command.
Spectator Blacklist Player	specblacklist	[duration or 'perm'] OR [duration or 'perm'][player] OR [duration or 'perm'][player][reason]	The in-game command used for adding a player to the Spectator Blacklist for all servers. Players under this group will not be able to enter the server as a spectator.
Un-Spectator Blacklist Player	unspecblacklist	[player]	The in-game command used for removing a player from Spectator Blacklist for all servers.
Report Whitelist Player	rwhitelist	[duration or 'perm'] OR [duration or 'perm'][player] OR [duration or 'perm'][player][reason]	The in-game command used for adding a player to the Report Whitelist for all servers. Players under this group cannot be reported.
Un-Report Blacklist Player	unrwhitelist	[player]	The in-game command used for removing a player from Report Whitelist for all servers.
Populator Whitelist Player	popwhitelist	[duration or 'perm'] OR [duration or 'perm'][player] OR [duration or 'perm'][player][reason]	The in-game command used for adding a player to the Populator Whitelist for all servers. Used when only allowing approved populators to be considered for automatic populator perks. Setting section B27-2.
Un-Populator Blacklist Player	unpopwhitelist	[player]	The in-game command used for removing a player from Populator Whitelist for all servers.
TeamKillTracker Whitelist Player	tkwhitelist	[duration or 'perm'] OR [duration or 'perm'][player] OR [duration or 'perm'][player][reason]	The in-game command used for adding a player to the TeamKillTracker Whitelist for all servers. "Feed TeamKillTracker Whitelist" must be enabled to use this command.
Un-TeamKillTracker Blacklist Player	untkwhitelist	[player]	The in-game command used for removing a player from TeamKillTracker Whitelist for all servers. "Feed TeamKillTracker Whitelist" must be enabled to use this command.
On-Death Move Player	move	None OR [player] OR [reportID]	The in-game command used for moving players between teams. Will add players to the "on-death" move list, when they die they will be sent to TeamSwap. If the player is already dead, this command automatically changes to force move.
Force-Move Player	fmove	None OR [player] OR [reportID]	The in-game command used for force-moving players between teams. Will immediately send the given player to TeamSwap.
Join Player	join	[player] OR [reportID]	The in-game command used for joining player's squads. Will immediately send the speaker to the target if possible, within access limitations.
Pull Player	pull	[player]	Pulls a player to your current squad, killing them in the process.
Mark Player	mark	[player]	Marks a player for admin notification if they leave the server.
Lock Player	lock	[player]	Locks a player from admin commands for 10 minutes. Only the locking admin will be able to act on them.
Unlock Player	unlock	[player]	Allows the locking admin to unlock a currently locked player.
TeamSwap Self	moveme	None	The in-game command used for moving yourself between teams. Will immediately send the speaker to TeamSwap.
Report Player	report	[player][reason]	The in-game command used for reporting players. Must have a reason, and will inform a player otherwise when used incorrectly. Will log a Report in the database (External GCP pulls from there for external admin notifications), and notify all in-game admins. Informs the reporter and admins of the report ID, which the punish system can use.
Call Admin	admin	[player][reason]	The in-game command used for calling admin attention to a player. Same deal as report, but used for a different reason. Informs the reporter and admins of the report ID, which the punish system can use.
Accept Round Report	accept	[reportID]	The in-game command used for accepting reports as confirmed.
Deny Round Report	deny	[reportID]	The in-game command used for denying reports.
Ignore Round Report	ignore	[reportID]	The in-game command used for ignoring reports.
Contest Report	contest	None	Usable by players to contest round reports before admins act on them.
Admin Say	say	[message] OR [preMessageID]	The in-game command used to send a message through admin chat to the whole server.
Player Say	psay	[player][message] OR [player][preMessageID]	The in-game command used for sending a message through admin chat to only a specific player.
Admin Yell	yell	[message] OR [preMessageID]	The in-game command used for to send a message through admin yell to the whole server.
Player Yell	pyell	[player][message] OR [player][preMessageID]	The in-game command used for sending a message through admin yell to only a specific player.
Admin Tell	tell	[message] OR [preMessageID]	The in-game command used for to send a message through both admin say and admin yell to the whole server.
Player Tell	ptell	[player][message] OR [player][preMessageID]	The in-game command used for sending a message through both admin say and admin yell to only a specific player.
Log Player Information	log	[player][message]	The in-game command used for logging a message on a player's record. Does not affect their gameplay in any way.
Player Private Message	msg	[player][message]	Opens a conversation with the given player. The player can either be in the current server, or any other BF3/BF4 server on your database.
Player Private Reply	r	[message]	Replies to a currently open conversation with the given message.
Admin Private Message	adminmsg	[message]	Sends a message to all online admins in the server. They can then open a private message with the sender to reply to the admin message.
What Is	whatis	[commandName] OR [preMessageID]	The in-game command used for finding out what a particular preMessage ID, or command name, means.
Lead Current Squad	lead	none OR [player]	The in-game command used to the speaker to leader of their current squad. When targeted at a player, that player will be given leader of their current squad. Only available in BF4.
Request Rules	rules	none OR [player]	The in-game command used to request the server rules. When targeted at a player, that player will be told the server rules. When targeted at a player, the command goes on timeout for that player.
Request Reputation	rep	none OR [player]	The in-game command used to request the server reputation. When targeted at a player, you will be told that player's reputation. Requesting a player's reputation other than your own is admin only.
Vote Surrender	surrender	none	The in-game command used for starting/voting for a round surrender. Losing team specific, but either surrender or votenext can be used.
Vote Next Round	votenext	none	The in-game command used for starting/voting for a round surrender. Losing team specific, but either surrender or votenext can be used.
Vote Against Surrender	nosurrender	none	The in-game command used for voting AGAINST a currently active round surrender. This command may only be used by the losing team.
Assist Losing Team	assist	none	The in-game command used to join the weak/losing team.
Request Online Admins	admins	none	The in-game command used to get the list of current online admins.
Request Uptimes	uptime	none	The in-game command used to get the uptime of the server, procon/layer, AdKats, and several other things.
List Round Reports	reportlist	none	The in-game command used to get the latest 6 unanswered round reports.
VOIP	voip	None	The in-game command used for sending VOIP server info to the speaker.
Kill Self	killme	None	The in-game command used for killing the speaker.
Restart Current Round	restart	None	The in-game command used for restarting the round.
Run Next Round	nextlevel	None	The in-game command used for running the next map in current rotation, but keep all points and KDRs from this round.
Restart AdKats	prestart	none	The in-game command used for rebooting the AdKats instance. Requires confirmation.
Shutdown Server	shutdown	none	The in-game command used for shutting down/rebooting the Battlefield server. Requires confirmation.
End Current Round	endround	[US/RU]	The in-game command used for ending the current round with a winning team. Either US or RU.
Server Nuke	nuke	[US/RU/ALL]	The in-game command used for killing all players in a subset. US, RU, or ALL will work.
Server Countdown	cdown	[squad/team/all] [seconds] [reason]	The in-game command used for issuing countdowns on a subset of players.
SwapNuke Server	swapnuke	none	The in-game command used for team-switching all players in the server. THIS IS EXPERIMENTAL, AND SHOULD BE USED WITH CAUTION. MULTIBalancer unswitcher is automatically disabled when using this command, and re-enabled once complete.
Kick All Guests	kickall	None	The in-game command used for kicking all players except admins.
Fetch Player Info	pinfo	[player]	Fetches extended information about the player. Player name, ID, role, team name, team posision, current score, time first seen, amount of time spent on current server, city location, IP change count, reports from/against during current round, infraction points, last punishment time/reason, reputation, and previous names.
Fetch Player Chat	pchat	None OR [chatLines] OR [player] OR [chatLines][player] OR self [player] OR [chatLines] self [player] OR [player1][player2] OR [chatLines][player1][player2]	Fetches chat history or conversation history between players.
Dequeue Player Action	deq	[player]	Canceles all queued actions on the target player. Moves, kills, etc.
Request Server Commands	help	None	Lists the server commands you can access.
Find Player	find	[player]	Returns the team, position, and score, of the targeted player.
Manage AFK Players	afk	None	Calls the AFK Management functionality manually. Cannot be used if AFK payers are being managed automatically.
Plugin Update	pupdate	None	Calls manual update of AdKats source and any connected extensions to their latest versions.

Some layer providers require whitelisting of connections through their firewall.

For AdKats to function properly, requests to the following domains/sub-domains must be allowed from your layer:

Domain	Usage
api.bf3stats.com	Player statistic tracking.
api.bf4stats.com	Player statistic tracking.
raw.github.com	Global configuration/documentation fetching, and database updates.
raw.githubusercontent.com	Global configuration/documentation fetching, and database updates.
sourceforge.net	Source updates.
api.gamerethos.net	Version management, and backup source for definition files.
ip-api.com	Player location tracking.
metabans.com	Ban enforcer posting.
www.timeanddate.com	Global UTC Timestamp

All are either simple GET or POST requests.

BF4DB.com might be used in the future to trigger updates on players BF4Stats data.

The following URLS are used for reputation stats, special player groups, database updates, and weapon stats for hacker-checker:

Link	Usage
adkatsreputationstats.json	Command Reputation Constants
adkatsspecialgroups.json	Special Player Group Definitions
adkatsupdates.json	Database Updates
adkatsweaponstats.json	Battlefield Weapon Stats (Damages)

AdKats issues specific server commands to execute its functions, and run properly. Below are their listings, usages, and intervals of usage.

Command	Usage	Interval
serverInfo	Fetching server info	Plugin start, 10 second interval.
vars.teamFactionOverride	Fetching team definitions	Plugin start, round start.
punkBuster.pb_sv_command	Triggering punkbuster screenshots	Admin report and calladmin commands.
squad.private	Setting whether a squad should be private or not	Admin join and pull commands.
squad.leader	Assigning squad leader	Admin lead commands.
player.isAlive	(BF4 only) Checking if a player is alive	Kill and move commands.
admin.killPlayer	Killing players	Admin kill and nuke commands, either automatic or manual.
admin.movePlayer	Moving players between teams	Admin move commands, and players attempting to move from locked teams.
admin.kickPlayer	Kicking players	Admin kick commands, either automatic or manual.
admin.say	Sending say to either server or private player	Admin say and tell commands, along with any automated functions that require notification to the user.
admin.yell	Sending yell to either server or private player	Admin yell and tell commands, along with any automated functions that require unavoidable notification to the user.
admin.listPlayers	Listing current server players	Plugin start, 10 second interval when TeamSwap queues are not empty.
admin.shutDown	Shutting down/rebooting the battlefield server	Admin shutdown commands.
banList.list	Listing current server banlist	If Ban Enforcer is enabled, when new ban(s) are added to the server, if not, after adding new bans to the server.
banList.add	Adding entries to the server ban list	Admin ban commands, either automatic or manual, when ban enforcer is disabled, or when importing bans from ban enforcer back into the server.
banList.save	Saving the server ban list	After adding new bans to the server, or, if ban enforcer is enabled, after clearing the server ban list.
mapList.restartRound	Restarting the current level, removing scores.	Admin restartLevel commands.
mapList.runNextRound	Running the next map in the list, keeping scores.	Admin nextLevel commands.
mapList.endRound	Ending the current round with a winner.	Admin endLevel commands, round timer, surrender vote, and auto-surrender.
reservedSlotsList.remove	Removing entries from the reserved slot list.	Reserved slot orchestration.
reservedSlotsList.add	Adding entries to the reserved slot list.	Reserved slot orchestration.
reservedSlotsList.save	Saving the server reserved slot list	Reserved slot orchestration.
reservedSlotsList.list	Fetching updated server reserved slot list	Reserved slot orchestration.
spectatorList.remove	(BF4 only) Removing entries from the allowed spectator list.	Allowed spectator orchestration.
spectatorList.add	(BF4 only) Adding entries to the allowed spectator list.	Allowed spectator orchestration.
spectatorList.save	(BF4 only) Saving the server allowed spectator list	Allowed spectator orchestration.
spectatorList.list	(BF4 only) Fetching updated server allowed spectator list	Allowed spectator orchestration.

0. Instance Settings:

'Auto-Enable/Keep-Alive' - When this is enabled, AdKats will auto-recover from shutdowns and auto-restart if disabled.

1. Server Settings:

'Lock Settings - Create Password' - Lock settings with a new created password > 5 characters.
'Lock Settings' - Lock settings with the existing settings password.
'Unlock Settings' - Unlock settings with the existing settings password.
'Setting Import' - Enter an existing server ID here and all settings from that instance will be imported here. All settings on this instance will be overwritten.
'Server ID (Display)' - ID of this server. Automatically set via the database.
'Server IP (Display)' - IP address and port of this server. Automatically set via Procon.
'Low Population Value' - Number of players at which the server is deemed 'Low Population'.
'High Population Value' - Number of players at which the server is deemed 'High Population'.

2. MySQL Settings:

'MySQL Hostname' - Hostname of the MySQL server AdKats should connect to.
'MySQL Port' - Port of the MySQL server AdKats should connect to, most of the time it's 3306.
'MySQL Database' - Database name AdKats should use for storage. Creation script given in database section.
'MySQL Username' - Username of the MySQL server AdKats should connect to.
'MySQL Password' - Password of the MySQL server AdKats should connect to.

3. User Settings:

'Add User' - Add a user to the user list by entering their unique username here.
*User Email* - Current stored email of the listed user.
*User Expiration* - Date that the user will revert to Default Guest role.
*User Notes* - Any notes that are logged for the user.
*User Role* - Current role of the listed user.
*Delete User?* - Type delete in this line to delete the listed user.
*Add Soldier?* - Type a logged soldier name in this line to connect it to the listed user. Unique soldiers cannot be connected to more than one user at a time.
*Delete Soldier?* - Type delete in this line to remove the listed soldier connection from the user.

3-2. Special Player Settings:

*Special Player Group Name* (Display) - Displays all current players matching the given special player group for either all servers or this server specifically.

4. Role Settings:

'Add Role' - Type a new role name in this line to add a new role. Role names must be unique.

Listed below "Add Role" are all the command assignments for each role. Change Allow/Deny for each command for the different user roles to control their access. Type delete in the "delete?" line to delete the user role. When a user role is deleted, all users on that role are changed to the Default Guest role. You cannot delete the Default Guest role.

4-2. Role Group Settings:

Listed in this section is an entry for each possible special player group, on every role in your role list. Setting 'Assign' to any entry will place all users/soldiers under that role on the selected special player group. Some settings are forced to 'Assign' per settings in other places in the program, for example if you've fed reserved slots for admins that group is force assigned for all admin roles.

5. Command Settings:

'Minimum Required Reason Length' - The minimum length a reason must be for commands that require a reason to execute. This only applies to admin commands.
'Minimum Report Handle Seconds' - The minimum number of seconds before a report can be acted on by admins using report ID.
'Maximum Temp-Ban Duration Minutes' - The maximum number of minutes that a temp-ban can be issued for.
'Allow Commands from Admin Say' - When this is enabled, all admins with procon access have unrestricted access to all enabled commands through procon's chat tab. When issuing commands through procon's chat tab, the commands must be prefixed with a / for them to work.
'Bypass all command confirmation -DO NOT USE-' - Disables all command confirmation. Do not use this setting unless you want to kick/ban the wrong people.
'External plugin player commands' - List of commands (witjh prefixes) that general players can access. Currently used for the help command.
'External plugin admin commands' - List of commands (with prefixes) that admins can access. Currently used for the help command.

6. Command List:

*Active* - Globally disable or enable the given command.
*Logging* - Set whether usage of this command is logged. All commands log by default.
*Text* - Globally change the in-game text for this command. Command text must be unique.
*Access Method* - The method that must be used to access this command from in-game. Either 'Any', 'AnyHidden', 'AnyVisible', 'GlobalVisible', 'TeamVisible', 'SquadVisible'.

7. Punishment Settings:

'Punishment Hierarchy' - List of punishments in order from lightest to most severe. Index in list is the action taken at that number of points.
'Combine Server Punishments' - Whether to make punishes from all servers on this database affect players on this server. Default is false.
'Only Kill Players when Server in low population' - When server population is below 'Low Server Pop Value', only kill players, so server does not empty. Player points will be incremented normally.
'Use IRO Punishment' - Whether the IRO punishment described in the infraction tracking docs will be used.
'IRO Timeout Minutes' - Number of minutes after a punish that IRO status expires for the next punish.
'IRO Punishment Overrides Low Pop' - When punishing players, if a player gets an IRO punish, it will ignore whether server is in low population or not.

8. Email Settings:

'Send Emails.' - Whether sending emails will be enabled. By default the adkatsbattlefield gmail account will be used to send emails. When this is true, all reports and admin calls will be send to the supplied email addresses on users and the extra email list.
'Use SSL?' - Whether SSL will be used in connection to given SMTP server.
'SMTP-Server address.' - Address of the SMTP server.
'SMTP-Server port.' - Port to use for the SMTP server.
'Sender address.' - The email address used to send all emails.
'SMTP-Server username.' - The username used to authenticate into the SMTP server.
'SMTP-Server password.' - The password used to authenticate into the SMTP server.
'Custom HTML Addition.' - Custom HTML to add to the end of each email. String replacements include. %player_id%, $player_name%, %player_guid%, %player_pbguid%, and %player_ip%.
'Extra Recipient Email Addresses.' - List of all extra email addresses beside user email addresses that you would like to blast.
'Only Send Report Emails When Admins Offline.' - Only send report notification emails when there are no admins in the server.

9. TeamSwap Settings:

'Ticket Window High' - When either team is above this ticket count, nobody (except admins) will be able to use TeamSwap.
'Ticket Window Low' - When either team is below this ticket count, nobody (except admins) will be able to use TeamSwap.

A10. Admin Assistant Settings:

'Enable Admin Assistants' - Whether admin assistant statuses can be assigned to players.
'Minimum Confirmed Reports Per Month' - How many confirmed reports the player must have in the past month to be considered an admin assistant.
'Enable Admin Assistant Perk' - Whether admin assistants will get the TeamSwap perk for their help.
'Use AA Report Auto Handler' - Whether the internal auto-handling system for admin assistant reports is enabled.
'Auto-Report-Handler Strings' - List of trigger words/phrases that the auto-handler will act on. One per line.

A11. Player Mute Settings:

'On-Player-Muted Message' - The message given to players when they are muted by an admin.
'On-Player-Killed Message' - The message given to players when they are killed for talking in chat after muting.
'On-Player-Kicked Message' - The message given to players when they are kicked for talking more than X times in chat after muting.
'# Chances to give player before kicking' - The number of chances players get to talk after being muted before they are kicked. After testing, 5 appears to be the perfect number, but change as desired.
'Ignore commands for mute enforcement' - Whether to ignore commands when enforcing mute status on a player.

A12. Messaging Settings:

'Display Admin Name in Kick and Ban Announcement' When players are kicked or banned from the server, the whole server is told. This changes whether the message includes the kicking or banning admin name, instead of just "admin".
'Display New Player Announcement' - Whether to inform admins when a player joins the server for the first time.
'Display Player Name Change Announcement' - Whether to inform admins when a player joins the server with a changed name.
'Display Targeted Player Left Notification' - Whether to inform admins when a player they acted on leaves the server.
'Display Ticket Rates in Procon Chat' - Whether to display team ticket loss/gain rates in the Procon chat tab. Useful for setting values in auto-surrender.
'Inform reputable players and admins of admin joins' - Whether to tell admins and reputable players that an admin joins the server.
'Inform players of reports against them' - Whether to inform targeted players when someone reports them.
'Player Inform Exclusion Strings' - List of words or phrases that will cancel informing reported players. For example, use if you don't want players to know if someone reports them with "hack", or "cheat" in the message.
'Yell display time seconds' - The integer time in seconds that yell messages will be displayed.
'Pre-Message List' - List of messages, mapped to IDs, that can be used in action commands. e.g. !kill mustardman 23. The !whatis command can be used to check what each ID references.
'Require Use of Pre-Messages' - Whether using pre-messages in commands is required instead of custom messages.
'Use first spawn message' - Whether to use the first spawn message for players.
'First spawn message text' - Message to send players when they first spawn in the server. Uses tell.
'Use First Spawn Reputation and Infraction Message' - Whether to inform players of their current server reputation and infraction count after the first spawn message is shown.

A12-2. SpamBot Settings:

'SpamBot Enable' - Whether to enable the SpamBot.
'SpamBot Say List' - List of messages to send to the server as SAY.
'SpamBot Say Delay Seconds' - The number of seconds between each SAY message is sent.
'SpamBot Yell List' - List of messages to send to the server as YELL.
'SpamBot Yell Delay Seconds' - The number of seconds between each YELL message is sent.
'SpamBot Tell List' - List of messages to send to the server as TELL.
'SpamBot Tell Delay Seconds' - The number of seconds between each TELL message is sent.
'Exclude Admins and Whitelist from Spam' - Whether to exclude admins and whitelisted players from seeing any messages sent from the SpamBot.

A13. Banning Settings:

'Use Additional Ban Message' - Whether to have an additional message append on each ban.
'Additional Ban Message' - Additional ban message to append on each ban. e.g. "Dispute at www.yourclansite.com"
'Procon Ban Admin Name' - Admin name that will be used for bans filed via procon.

A13-2. Ban Enforcer Settings:

'Use Ban Enforcer' - Whether to use the internal AdKats Ban Enforcer.
'Enforce New Bans by NAME' - Whether to use a player's name to ban them. (Insecure, players can change their names)
'Enforce New Bans by GUID' - Whether to use a player's EA GUID to ban them. (Secure, players cannot change their GUIDs)
'Enforce New Bans by IP' - Whether to use a player's IP Address to ban them. (Somewhat secure, experienced players can change their IP, and IP bans can hit multiple players.)
'Use Metabans?' - Whether to use metabans functionality when banning/unbanning in ban enforcer.
'Metabans Username' - Username for authentication to your metabans account.
'Metabans API Key' - API Key for your metabans account.

A13-3. Mini Ban Management:

'NAME Ban Count' - How many NAME bans are currently being enforced by AdKats Ban Enforcer.
'GUID Ban Count' - How many EA GUID bans are currently being enforced by AdKats Ban Enforcer.
'IP Ban Count' - How many IP bans are currently being enforced by AdKats Ban Enforcer.
'Ban Search' - Enter a full or partial player name here and AdKats will display all ACTIVE matching bans.

A14. External Command Settings:

'AdKatsLRT Extension Token' - Usable with AdKatsLRT - OnSpawn Loadout Enforcer plugin. Once that plugin is purchased, the token can be placed here for automatic install/updates.
'Fetch Actions from Database' - When activated, AdKats will check the database every few seconds for new records added which are targeted at that particular server. It will run the action for new records and mark them read.

A15. VOIP Settings:

'Server VOIP Address' - String that will be sent to players using the VOIP command.

A16. Orchestration Settings:

'Feed MULTIBalancer Whitelist' - When enabled, the adkats_specialplayers table (group: whitelist_multibalancer) is used to feed MULTIBalancer's player whitelist.
'Automatic MULTIBalancer Whitelist for Admins' - When enabled, all admins in your User List will be given whitelist from balance in MULTIBalancer.
'Feed MULTIBalancer Even Dispersion List' - When enabled, the adkats_specialplayers table (group: blacklist_dispersion) is used to feed MULTIBalancer's even dispersion list.
'Feed TeamKillTracker Whitelist' - When enabled, the TeamKillTracker whitelist will include all players in the TeamKillTracker whitelist special player group.
'Automatic TeamKillTracker Whitelist for Admins' - When enabled, all admins in your User List will be given an automatic TeamKillTracker whitelist.
'Feed Server Reserved Slots' - When enabled, players in the reserved slot special player group will be assigned a reserved slot. Any modifications of the reserved slot list outside of Adkats will be erased.
'Automatic Reserved Slot for Admins' - When enabled, all admins in your User List will be given a reserved slot.
'Feed Server Spectator List' - When enabled, the servers spectator list will include all AdKats user's soldiers.
'Automatic Spectator Slot for Admins' - When enabled, all admins in your User List will be given a spectator slot.
'Feed Stat Logger Settings' - When enabled, stat logger is fed settings appropriate for AdKats, including correct database time offset, instant chat logging, etc.
The following settings are sent to stat logger when using the "Feed Stat Logger Settings" orchestration option:
- "Servertime Offset" (TIME OFFSET CONVERSION TO UTC TIME)
- "Enable Chatlogging?" "Yes"
- "Instant Logging of Chat Messages?" "Yes"
- "Enable Statslogging?" "Yes"
- "Enable Weaponstats?" "Yes"
- "Enable KDR correction?" "Yes"
- "MapStats ON?" "Yes"
- "Session ON?" "Yes"
- "Save Sessiondata to DB?" "Yes"
- "Log playerdata only (no playerstats)?" "No"
"Enable Live Scoreboard in DB" is forced on at all times.
'Post Stat Logger Chat Manually' - Sometimes stat logger chat upload glitches and stops, this overrides that posting and uploads all chat to the database manually.
'Post Server Chat Spam' - Whether to include server spam messages when posting stat logger chat manually.
'Exclude Commands from Chat Logs' - Whether to exclude messages containing commands from being stored in the database.

A17. Round Settings:

'Round Timer: Enable' - When enabled, rounds will be limited to X minutes.
'Round Timer: Round Duration Minutes' - Number of minutes that the round will last before the current winning team wins (Will only work correctly in conquest/domination at the moment).

A18. Internal Hacker-Checker Settings:

'HackerChecker: Enable' - Whether the internal BF3Stats hacker-checker is enabled.
'HackerChecker: DPS Checker: Enable' - Whether the Damage Mod portion of the hacker-checker is enabled.
'HackerChecker: DPS Checker: Trigger Level' - The percentage over normal weapon damage that will cause a ban. 50 kills minimum to trigger. After 3 months of testing, 50 is the best value, and has not issued a single false positive in that time.
'HackerChecker: DPS Checker: Ban Message' - Message prefix to use when banning for damage mod.
'HackerChecker: HSK Checker: Enable' - Whether the Aimbot portion of the hacker-checker is enabled.
'HackerChecker: HSK Checker: Trigger Level' - The headshot/kill ratio for automatic weapons that will trigger a ban. 100 kills minimum to trigger. After 3 months of testing, we suggest setting between 50 and 70 depending on the severity you want to enforce. You will get some false positives down near 50 but will catch many more aimbotters, setting near 70 will not result in any false positives but also wont catch as many aimbotters.
'HackerChecker: HSK Checker: Ban Message' - Message prefix to use when banning for high HSK.
'HackerChecker: KPM Checker: Enable' - Whether the KPM portion of the hacker-checker is enabled.
'HackerChecker: KPM Checker: Trigger Level' - Kills-per-minute with any included weapon that will trigger the ban.
'HackerChecker: KPM Checker: Ban Message' - Message prefix to use when banning for high KPM.

A19. Server Rules Settings:

'Rule Print Delay' - Delay in seconds after the command is issued that commands start being sent to the player.
'Rule Print Interval' - Number of seconds between each rule being sent to the player.
'Server Rule List' - List of rules for the server. Raw messages can be used here, or alternatively pre-message IDs.
'Server Rule Numbers' - Whether to include the rule numbers at the beginning of each line during rule printing.

B20. AFK Settings:

'AFK System Enable' - Whether to enable the AFK management system.
'AFK Ignore Chat' - Events are used to cancel AFK timeout for players. When this is enabled, players just sitting in the spawn screen chatting will be kicked. They must play in order to stay in the server..
'AFK Auto-Kick Enable' - Whether to automatically kick using the trigger time. When disabled, the afk command must be used for kicking afk players.
'AFK Trigger Minutes' - The number of minutes a player can do nothing before being considered AFK.
'AFK Minimum Players' - Minimum number of players that must be in the server before the system will kick AFK players.
'AFK Ignore User List' - Whether to ignore all users on the user list.
'AFK Ignore Roles' - Visible when not ignoring all users on the user list. List the role keys that will be ignored.

B21. Ping Enforcer Settings:

'Ping Enforcer Enable' - Whether to enable the Ping Enforcer.
'Ping Moving Average Duration sec' - The amount of time that should be used to average the player pings. Default is a 3 minute window.
'Ping Kick Low Population Trigger ms' - The minimum ping that will trigger a kick in low population.
'Ping Kick Medium Population Trigger ms' - The minimum ping that will trigger a kick in medium population.
'Ping Kick High Population Trigger ms' - The minimum ping that will trigger a kick in high population.
'Ping Kick Full Population Trigger ms' - The minimum ping that will trigger a kick in full population.
'Ping Kick Minimum Players' - The minimum number of players that must be in the server before ping kicks will happen.
'Kick Missing Pings' - Whether to kick players for having missing ping.
'Attempt Manual Ping when Missing' - If the server does not provide the player a ping, attempt to fetch their ping manually from the Procon instance.
'Ping Kick Ignore User List' - Whether to ignore all users on the user list.
'Ping Kick Ignore Roles' - List the role keys that will be ignored.

B22. Commander Manager Settings:

'Commander Manager Enable' - Whether to enable the Commander Manager.
'Minimum Players to Allow Commanders' - Commanders will be automatically kicked when attempting to join with active player count less than this value. Existing commanders will be kicked if player count drops below 2/3 of this value.

B23. Player Locking Settings:

'Player Lock Manual Duration Minutes' - When locking players via command, they will be locked for the given duration in minutes.
'Automatically Lock Players on Admin Action' - When a player is acted on by an admin, they will be automatically locked from action by other admins.
'Player Lock Automatic Duration Minutes' - When automatically locking players, they will be locked for the given duration in minutes.

B24. Surrender Vote Settings:

'Surrender Vote Enable' - Whether to enable the Surrender Vote System.
'Percentage Votes Needed for Surrender' - Percentage of a team required for surrender vote to complete.
'Minimum Player Count to Enable Surrender' - The minimum number of players that must be in the server for a surrender vote to be allowed.
'Minimum Ticket Gap to Surrender' - The minimum difference in tickets between teams for a surrender vote to be allowed.
'Enable Required Ticket Rate Gap to Surrender' - Whether to require a minimum ticket loss/gain rate between teams before a surrender vote is allowed. Use 'Display Ticket Rates in Procon Chat' in section A12 to monitor ticket loss/gain rates.
'Minimum Ticket Rate Gap to Surrender' - The minimum difference in ticket rates between teams for a surrender vote to be allowed.
'Surrender Vote Timeout Enable' - Whether to enable a timeout on the surrender vote. After this timeout all votes will be removed, and the surrender vote will be stopped.
'Surrender Vote Timeout Minutes' - The number of minutes after surrender vote start that it will time out and remove all votes.

B25. Auto-Surrender Settings:

'Auto-Surrender Enable' - Whether to enable the Auto-Surrender System. When enabled, all below values must be contained in a round for it to trigger an automatic round surrender.
'Auto-Surrender Use Optimal Values for Metro Conquest' - If you are running Metro 2014 on Conquest, use this setting, it will issue auto-surrender when a baserape happens and the weak team cannot recover.
'Auto-Surrender Use Optimal Values for Locker Conquest' - If you are running Operation Locker on Conquest, use this setting, it will issue auto-surrender when a baserape happens and the weak team cannot recover.
'Auto-Surrender Minimum Ticket Gap' - The minimum difference in ticket counts between teams for auto-surrender to fire.
'Auto-Surrender Use Adjusted Ticket Rates' - Adjusted ticket rates are designed for modes where player spawns affect ticket count, like conquest and domination, it removes them from the equation leaving only flags affecting the ticket rates.
'Auto-Surrender Losing Team Rate Window Max' - The losing team's ticket rate must not be greater than this value for auto-surrender to fire.
'Auto-Surrender Losing Team Rate Window Min' - The losing team's ticket rate must not be less than this value for auto-surrender to fire.
'Auto-Surrender Winning Team Rate Window Max' - The winning team's ticket rate must not be greater than this value for auto-surrender to fire.
'Auto-Surrender Winning Team Rate Window Min' - The winning team's ticket rate must not be less than this value for auto-surrender to fire.
'Auto-Surrender Trigger Count to Surrender' - Triggers happen every 10 seconds. The above values must be hit this number of times for auto-surrender to fire. Admins are informed of triggers every
'Auto-Surrender Message' - The message that will be sent to the server when an auto-surrender is fired. Place %WinnerName% in the string for the name of the winning team.
'Nuke Winning Team Instead of Surrendering Losing Team' - When an auto-surrender would have been triggered on the losing team due to the settings above, instead, nuke the winning team. It will be common for 1-3 nukes to be issued within a few seconds of each other, to make sure all players both currently alive and about to spawn are dead.
'Auto-Nuke Message' - The message that will be sent to the server when an auto-nuke is fired. Place %WinnerName% in the string for the name of the winning team being nuked.
'Start Surrender Vote Instead of Surrendering Losing Team' - When an auto-surrender would have been triggered on the losing team due to the settings above, instead, simply start a surrender vote, with AutoAdmin giving 1 vote toward surrender.

B26. Statistics Settings:

'Post Map Benefit/Detriment Statistics' - Whether to post statistics on which maps are most beneficial/detrimental to the population of the server. Queries to extract meaning from this information can be aquired in the main AdKats forum thread.
'Post Win/Loss/Baserape statistics' - Whether to post statistics on wins, losses, and baserape causing players. Requires auto-surrender to be enabled and configured, and only works as intended when not using the auto-nuke or auto-vote settings.

B27. Player Monitor Settings:

'Monitor Baserape Causing Players' - When enabled, players who cause baserape will be automatically monitored and can be acted on in setting section B27-1. Requires posting win/loss/baserape statistics.
'Monitor Populator Players - Thanks CMWGaming' - When enabled, players who help populate servers can be automatically monitored and given perks in setting section B27-2.

B27-1. Baserape Causing Player Monitor Settings:

'Baserape Causing Players (Display)' - Current display of baserape causing players using the below options.
'Past Days to Monitor Baserape Causing Players' - Past days worth of stats to be considered when calculating baserape causing players.
'Count to Consider Baserape Causing' - Number of baserapes contributed to in the considered duration in order to be considered baserape causing. Players must meet this stat, and either have a win/loss ratio over 1.25, or have more than 10% of their played matches end with them baseraping.
'Automatic Dispersion for Baserape Causing Players' - When enabled, players causing baserape are automatically included in the MULTIBalancer dispersion list.
'Automatic Assist Trigger for Baserape Causing Players' - When enabled, players causing baserape will be automatically sent to the weak team if auto-surrender begins its countdown. Number of auto-surrender triggers are automatically doubled if this case triggers.

B27-2. Populator Monitor Settings - Thanks CMWGaming:

'Populator Players (Display)' - Current display of populator players using the below options.
'Monitor Specified Populators Only' - When enabled, players must be placed under populator whitelist in order to be considered for populator status on this server.
'Monitor Populators of This Server Only' - When enabled, only population counts of this server are used to count toward populator stats on this server.
'Count to Consider Populator Past Week' - Players will be considered populator if they have this many populations in the past week.
'Count to Consider Populator Past 2 Weeks' - Players will be considered populator if they have this many populations in the past 2 weeks.
'Enable Populator Perks.' - When enabled, populator perk options are made visible.
'Populator Perks - Reserved Slot.' - When enabled, populators are given reserved slots.
'Populator Perks - Autobalance Whitelist.' - When enabled, populators are given MULTIBalancer whitelist.
'Populator Perks - Ping Whitelist.' - When enabled, populators are given whitelist from ping kicks.
'Populator Perks - TeamKillTracker Whitelist.' - When enabled, populators are given a whitelist in TeamKillTracker.

D99. Debug Settings:

'Debug level' - Indicates how much debug-output is printed to the plugin-console. 0 turns off debug messages (just shows important warnings/exceptions/success), 7 documents nearly every step. Don't edit unless you really want to be spammed with console logs, it will also slow down the plugin when turned up.
'Debug Soldier Name' - When this soldier issues commands in your server, the time for any command to complete is told in-game. Duration is from the time you entered the message, until all aspects of the command have been completed.
'Disable Automatic Updates' - Disables automatic updates for the plugin. Should only be disabled if you've modified the plugin code manually.
'Disable Version Tracking - Required For TEST Builds' - Tracks version numbers for stable and TEST builds. Used to see how many servers are currently running certain versions of AdKats.
'Command Entry' - Enter commands here just like in game, mainly for debug purposes. Don't let more than one person use this at any time.

Name		Name	Last commit message	Last commit date
Latest commit History 589 Commits
extensions		extensions
images		images
lib		lib
AdKats.cs		AdKats.cs
CHANGELOG.md		CHANGELOG.md
LINKS.md		LINKS.md
README.md		README.md
adkats.sql		adkats.sql
adkatsblweaponstats.json		adkatsblweaponstats.json
adkatsreputationstats.json		adkatsreputationstats.json
adkatsspecialgroups.json		adkatsspecialgroups.json
adkatsupdates.json		adkatsupdates.json
adkatsweaponnames.json		adkatsweaponnames.json
adkatsweaponstats.json		adkatsweaponstats.json

wizard45/AdKats

Folders and files

Latest commit

History

Repository files navigation