Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
274 lines (272 sloc) 15 KB

AdKatsLRT - On-Spawn Loadout Enforcer

Overview

All infantry and vehicle loadouts/equipment in Battlefield 4 can be denied on-spawn using this plugin, with customizable messages for each item. Vehicle loadouts and equipment can be enforced on spawn for everyone, or on kill with specific vehicles. Settings allow for enforcement of problem players only, or all players, with per-item gradation of that severity.

Basic

  • Enforce every infantry item (any primary, secondary, attachments for either, gadgets, knifes, and grenades) in the game on-spawn.
  • Enforce every vehicle item (primaries, secondaries, countermeasures, optics, and gunner options) in the game, on-spawn.
  • Map/Mode specific enforcement options for mixed-mode servers are available.
  • Any update made to the game's weapons are automatically imported and made available, so if DICE changes or adds weapons, they are immediately enforceable.
  • Players notified and thanked when they fix their loadouts after being killed.
  • Customizable kill messages for each denied item, with combined messages and details if more than one is spawned in the same loadout.
  • Statistics on enforcement, including percent of players enforced, percent killed for enforcement, percent who fixed their loadouts after kill, and percent who quit the server without fixing their loadouts after kill.

With AdKats

  • Two levels of enforcement, allowing multiple levels of severity for each item.
  • In-game commands to call more strict loadout enforcement on specific players.
  • Using the reputation system, reputable players are optionally not forced to change their loadouts, as we know they are not going to use them.
  • Admins are optionally whitelisted from spawn enforcement, but still fall under trigger enforcement if marked or punished.
  • Other plugins can call loadout checks and enforcement, so it can enhance your current autoadmin.

Development by Daniel J. Gradinjan (ColColonCleaner)

If you find any bugs, please inform me about them on the MyRCON forums and they will be fixed ASAP.




AdKats User Manual

AdKats User Manual

  • Procon, and optionally AdKats. Basic functions only require Procon, however, for advanced functions, it requires AdKats 6.9.0.0 or later to be installed and running.
  • Separated Layer IPs. This is a battlelog intensive plugin, do not run it on more than one battlefield server from the same Procon layer IP address. If you have multiple servers to enforce, you must run the plugin from different Procon layer IP addresses. If you do not heed this warning, your layers run the risk of being temporarily IP banned from battlelog.

AdKats User Manual

  1. Optionally Install AdKats. AdKatsLRT can run independently from the AdKats base plugin, but certain advanced functions cannot be used as a result. To install the latest version of AdKats, view the AdKats Install Instructions. After install make sure you are running version 6.9.0.0 or later.
  2. Download and install AdKatsLRT. Download the plugin from here: https://github.com/AdKats/AdKats-LRT/archive/master.zip. The plugin is installed like any other procon plugin.
  3. Enable AdKatsLRT. AdKatsLRT will start and fetch required information, then wait for the first player list response from either AdKats or the server. Once that comes through, it will complete startup and loadout enforcement will be online. Enjoy your new admin tool!

If you have any problems installing AdKatsLRT please let me know on the MyRCON forums and I'll respond promptly. All instances of AdKatsLRT are tracked once installed.


AdKats User Manual

Item Library

Every infantry/Vehicle item in the game (about 3500 items), can be enforced here. The settings are split into several sections; Weapons, Weapon Accessories, Gadgets, and Vehicle Weapons/Unlocks, in that order.

Loadout Processing

Deciding Enforcement Type

The gist of it for infantry: Deny on trigger denies that weapon/accessory for problem players and players you've manually marked, deny on spawn denies that weapon for everyone except admins and reputable players.

The gist of it for vehicles: By default, enforcement is on kill with specific vehicles. This is important because not everyone uses vehicles, so only those players using restricted vehicles should have their loadouts enforced for those vehicles. Optionally you can enforce on spawn for vehicle loadouts, regardless, which is not advised but is available as an option.

Details for infantry: Loadouts have several reasons for being checked; A player spawns, gets reported, gets punished, gets marked, or has more than X (configurable) infraction points. Any of these instances will call a loadout check, and the reason for checking them changes the way the enforcement works.

When running loadout enforcement for a specific player, the reason, and action if invalid, is first decided. The following are results for specific reasons, in order of priority:

  • If a player was marked they are set under trigger enforcement and will be slain for invalid loadout of any kind.
  • If a player is punished they are set under trigger enforcement and will be slain for invalid loadout of any kind.
  • If a player was reported and their reputation is non-positive they are set under trigger enforcement and will be slain for invalid loadout of any kind. If they are slain due to a report that report is automatically accepted.
  • If a player has more than X (configurable) infraction points they are set under trigger enforcement and will be slain for invalid loadout of any kind.
  • If none of the above checks are hit, are not reputable, and are not an admin, they are set under spawn enforcement. Secondary checks are customizable.

Informing and Acting

If a player is about to be slain for loadout enforcement, regardless of enforcement type, they are shown two messages. The first is a generic message containing all denied weapons they have in their loadout "playername please remove [denied weapons] from your loadout". This messages is sent using private SAY. After that, the specific messages written by the admin for each denied item is displayed. These customizable messages are found in setting sections 8A and 8B, once denied items are selected. These messages are sent using private TELL.

Immediately after informing the player of denied items in their loadout, they are admin killed. If they are under manual trigger enforcement, admins are notified of their demise, all other messages are private.

Thank you messages are given to players who fix their loadouts. If a player is under trigger enforcement, admins are notified that they fixed their loadout.

Debug Messages

Setting your debug level to at least 2 will display statistics in the console when stats change. The stats available are percent under loadout enforcement (should be nearly 100%), percent killed for loadout enforcement, percent who fixed their loadouts after kill, and percent who quit the server without fixing after being killed.


AdKats User Manual

Certain commands in AdKats are modified by this plugin. The changes to those commands are listed below.

Command Default Text Changes
Punish Player punish Punish works as normal, but also initiates trigger level enforcement on the target player for the duration the plugin is online.
Mark Player mark Instead of marking a player for leave notification only, it also initiates trigger level enforcement on the target player for the duration the plugin is online.
Report Player report Reports initiate trigger level enforcement on targeted players with non-positive reputation. If the reported player has invalid items in their loadout, the report is automatically accepted, and admins notified of such.
Call Admin admin Same changes as Report Player.

AdKats User Manual

0. Instance Settings:

  • 'Integrate with AdKats' - Whether to integrate functions with AdKats. When enabled this unlocks more setting options.
  • 'Spawn Enforce Admins' - Viewable when integrating with AdKats. Adds admins to spawn enforcement.
  • 'Spawn Enforce Reputable Players' - Viewable when integrating with AdKats. Adds reputable players (> 15 rep) to spawn enforcement.
  • 'Trigger Enforce Minimum Infraction Points' - Viewable when integrating with AdKats. Sets the minimum infraction point count to automatically add problem players to trigger level enforcement.

1. Display Settings:

  • 'Display Preset Settings' - When enabled, the 'Preset Settings' section will be displayed.
  • 'Display Map/Mode Settings' - When enabled, the 'Map/Mode Settings' section will be displayed.
  • 'Display Weapon Settings' - When enabled, the 'Weapons' section will be displayed.
  • 'Display Weapon Accessory Settings' - When enabled, the 'Weapon Accessories' section will be displayed.
  • 'Display Gadget Settings' - When enabled, the 'Gadgets' section will be displayed.
  • 'Display Vehicle Settings' - When enabled, the 'Vehicle Weapons/Unlocks' section will be displayed.

2. Preset Settings:

  • 'Coming Soon' - This setting block will soon contain settings for presets, like 'No Frag Rounds', or 'No Explosives'.

3. Map/Mode Settings:

  • 'Enforce on Specific Maps/Modes Only' - When enabled, the Map/Mode selection settings are displayed. Loadout enforcement will only be enabled on the selected maps.
  • '*MapModeIdentifier Enforce?' - When enabled, the selected Map/Mode will be included in loadout enforcement.

4. Weapons:

  • '*WeaponIdentifier Allow on trigger?' - Viewable when integrating with AdKats. Whether this item should be allowed/denied when a player is under trigger level enforcement.
  • '*WeaponIdentifier Allow on spawn?' - Appears when a weapon is denied under trigger enforcement, or not using AdKats integration. Whether this item should be allowed/denied when a player is under spawn level enforcement.

5. Weapon Accessories:

  • '*AccessoryIdentifier Allow on trigger?' - Viewable when integrating with AdKats. Whether this item should be allowed/denied when a player is under trigger level enforcement.
  • '*AccessoryIdentifier Allow on spawn?' - Appears when a weapon is denied under trigger enforcement, or not using AdKats integration. Whether this item should be allowed/denied when a player is under spawn level enforcement.

6. Gadgets:

  • '*GadgetIdentifier Allow on trigger?' - Viewable when integrating with AdKats. Whether this item should be allowed/denied when a player is under trigger level enforcement.
  • '*GadgetIdentifier Allow on spawn?' - Appears when a weapon is denied under trigger enforcement, or not using AdKats integration. Whether this item should be allowed/denied when a player is under spawn level enforcement.

7. Vehicle Weapons/Unlocks:

  • 'Spawn Enforce all Vehicles' - When enabled, if any player spawns with a vehicle loadout that is invalid it will slay them. When disabled, it will wait for them to use the vehicle before slaying them.
  • '*VehicleIdentifier Allow on kill?' - Whether this item should be allowed/denied when a player kills with the specified vehicle.
  • '*VehicleIdentifier Allow on spawn?' - Appears when the 'Spawn Enforce all Vehicles' setting is enabled. Whether this item should be allowed/denied when a player spawns, regardless of where they are.

8A. Denied Item Kill Messages:

  • '*ItemIdentifier Kill Message' - The specific message sent to players when they are slain for having this item in their loadout.

8B. Denied Item Accessory Kill Messages:

  • '*AccessoryIdentifier Kill Message' - The specific message sent to players when they are slain for having this accessory in their current loadout.

8C. Denied Vehicle Item Kill Messages:

  • '*VehicleItemIdentifier Kill Message' - The specific message sent to players when they are slain for having this item in their vehicle loadout.

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), 1 includes kill notifications, 2 includes stats, 3 includes queue information, 4 includes each player's full loadout, and 5 is overly detailed.