Add Automatic Bans feature (disabled by default)

Author: RestoreMonarchy

PlayerStats/Components/PlayerStatsComponent.AutomaticBans.cs

@@ -0,0 +1,32 @@
+using RestoreMonarchy.PlayerStats.Models;
+using SDG.NetTransport;
+using SDG.Unturned;
+using Steamworks;
+using System.Collections.Generic;
+
+namespace RestoreMonarchy.PlayerStats.Components
+{
+    public partial class PlayerStatsComponent
+    {
+        internal void CheckAutomaticBan()
+        {
+            if (!configuration.EnableAutomaticBans)
+            {
+                return;
+            }
+
+            foreach (AutomaticBan ban in configuration.AutomaticBans)
+            {
+                if (ban.CheckConditions(PlayerData))
+                {
+                    ITransportConnection transportConnection = Player.channel.owner.transportConnection;
+                    uint ipAddress = 0;
+                    transportConnection?.TryGetIPv4Address(out ipAddress);
+
+                    IEnumerable<byte[]> hwids = Player.channel.owner.playerID.GetHwids();
+                    Provider.requestBanPlayer(CSteamID.Nil, SteamID, ipAddress, hwids, ban.Reason, uint.MaxValue);
+                }
+            }
+        }
+    }
+}

PlayerStats/Components/PlayerStatsComponent.cs

@@ -5,6 +5,7 @@
 using Rocket.Core;
 using Rocket.Unturned.Player;
 using SDG.Unturned;
+using Steamworks;
 using System;
 using System.Collections.Generic;
 using System.Linq;
@@ -20,6 +21,7 @@ public partial class PlayerStatsComponent : MonoBehaviour
 
         public Player Player { get; private set; }
         public string Name => Player.channel.owner.playerID.characterName;
+        public CSteamID SteamID => Player.channel.owner.playerID.steamID;
         public ulong SteamId => Player.channel.owner.playerID.steamID.m_SteamID;
         public PlayerStatsData PlayerData { get; private set; }
         public PlayerStatsData SessionPlayerData { get; private set; }
@@ -202,6 +204,8 @@ internal void OnPlayerDeath(Player killer, ELimb limb, EDeathCause cause)
                     }
                     killerComponent.UpdateUIEffect();
                     killerComponent.CheckGiveReward();
+
+                    killerComponent.CheckAutomaticBan();
                 }
                 UpdateUIEffect();
             } else
@@ -213,6 +217,8 @@ internal void OnPlayerDeath(Player killer, ELimb limb, EDeathCause cause)
                     UpdateUIEffect();
                 }
             }
+
+            CheckAutomaticBan();
         }
 
         internal void CheckGiveReward()

PlayerStats/Models/AutomaticBan.cs

@@ -0,0 +1,41 @@
+using System.Xml.Serialization;
+
+namespace RestoreMonarchy.PlayerStats.Models
+{
+    public class AutomaticBan
+    {
+        [XmlAttribute]
+        public string Reason { get; set; }
+        [XmlArrayItem("Condition")]
+        public AutomaticBanCondition[] Conditions { get; set; }
+
+        public bool CheckConditions(PlayerStatsData data)
+        {
+            if (Conditions == null || Conditions.Length == 0)
+            {
+                return false;
+            }
+
+            foreach (AutomaticBanCondition condition in Conditions)
+            {
+                long statValue = data.GetStatValue(condition.Stat);
+                switch (condition.Comparer.ToLower())
+                {
+                    case "greater":
+                        if (statValue <= condition.Value) return false;
+                        break;
+                    case "less":
+                        if (statValue >= condition.Value) return false;
+                        break;
+                    case "equal":
+                        if (statValue != condition.Value) return false;
+                        break;
+                    default:
+                        return false;
+                }
+            }
+
+            return true;
+        }
+    }
+}

PlayerStats/Models/AutomaticBanCondition.cs

@@ -0,0 +1,14 @@
+using System.Xml.Serialization;
+
+namespace RestoreMonarchy.PlayerStats.Models
+{
+    public class AutomaticBanCondition
+    {
+        [XmlAttribute]
+        public string Comparer { get; set; }
+        [XmlAttribute] 
+        public string Stat { get; set; }
+        [XmlAttribute]
+        public long Value { get; set; }
+    }
+}

PlayerStats/Models/PlayerStatsData.cs

@@ -1,4 +1,5 @@
 using Newtonsoft.Json;
+using Rocket.Core.Logging;
 using System;
 
 namespace RestoreMonarchy.PlayerStats.Models
@@ -38,5 +39,44 @@ public int Deaths
                 }
             }
         }
+
+        public long GetStatValue(string name)
+        {
+            switch (name?.ToLower())
+            {
+                case "kills":
+                    return Kills;
+                case "headshots":
+                    return Headshots;
+                case "pvpdeaths":
+                    return PVPDeaths;
+                case "pvedeaths":
+                    return PVEDeaths;
+                case "zombies":
+                    return Zombies;
+                case "megazombies":
+                    return MegaZombies;
+                case "animals":
+                    return Animals;
+                case "resources":
+                    return Resources;
+                case "harvests":
+                    return Harvests;
+                case "fish":
+                    return Fish;
+                case "structures":
+                    return Structures;
+                case "barricades":
+                    return Barricades;
+                case "playtime":
+                    return (long)Playtime; // Assuming Playtime is in seconds
+                case "accuracy":
+                    return Kills > 0 ? (long)((Headshots / (double)Kills) * 100) : 0; // Calculate accuracy as percentage of headshots to kills
+                case "deaths":
+                    return Deaths; // Returns combined deaths if configured
+                default:
+                    return 0;
+            }
+        }
     }
 }

PlayerStats/PlayerStats.csproj

@@ -4,7 +4,7 @@
     <TargetFramework>net48</TargetFramework>
 	  <LangVersion>latest</LangVersion>
 	  <RootNamespace>RestoreMonarchy.PlayerStats</RootNamespace>
-    <Version>1.1.3</Version>
+    <Version>1.2.0</Version>
   </PropertyGroup>
 
   <ItemGroup>

PlayerStats/PlayerStatsConfiguration.cs

@@ -39,6 +39,35 @@ public class PlayerStatsConfiguration : IRocketPluginConfiguration
         public int MinimumRankingTreshold { get; set; }
         public bool EnableRewards { get; set; }
         public Reward[] Rewards { get; set; }
+        public bool EnableAutomaticBans { get; set; } = false;
+        public AutomaticBan[] AutomaticBans { get; set; } = 
+        [
+            new AutomaticBan
+            {
+                Reason = "Cheating (AB)",
+                Conditions =
+                [
+                    new AutomaticBanCondition
+                    {
+                        Comparer = "greater",
+                        Stat = nameof(PlayerStatsData.Kills),
+                        Value = 30
+                    },
+                    new AutomaticBanCondition
+                    {
+                        Comparer = "greater",
+                        Stat = "Accuracy",
+                        Value = 80
+                    },
+                    new AutomaticBanCondition
+                    {
+                        Comparer = "less",
+                        Stat = nameof(PlayerStatsData.Playtime),
+                        Value = 3600
+                    }
+                ]
+            },
+        ];
 
         // Only hide legacy properties when using new StatsMode
         public bool ShouldSerializeEnablePVPStats() => StatsMode == null;

README.md

@@ -16,6 +16,15 @@ Player Stats is a plugin that tracks various player statistics and provides rank
 | 🔄 Migration | Automatic migration from Arechi PlayerStats plugin |
 | 🖥️ User Interface | Optional UI for viewing PVP/PVE stats |
 
+## Workshop (Optional)
+The UI is optional and provides a visual display for PVP stats. 
+
+- **Workshop Item**: [Player Stats UI](https://steamcommunity.com/sharedfiles/filedetails/?id=3352126593)
+- **ID**: `3352126593`
+
+> 💡 **PRO TIP**  
+> Remember to set `<EnableUIEffect>true</EnableUIEffect>` in the configuration file to activate the UI.
+
 ## Tracked Statistics
 
 ### PVP Stats
@@ -25,12 +34,12 @@ Player Stats is a plugin that tracks various player statistics and provides rank
 - HS% (Headshot Percentage)
 
 ### PVE Stats
-- Zombies
-- Mega Zombies
-- Animals
-- Resources
-- Harvests
-- Fish
+- Zombies (zombies killed)
+- Mega Zombies (mega zombies killed)
+- Animals (animals killed)
+- Resources (resources gathered)
+- Harvests (plant harvests)
+- Fish (fish caught)
 
 ---
 
@@ -44,6 +53,45 @@ Player Stats is a plugin that tracks various player statistics and provides rank
 | `PVP` | The `/stats` command displays only PVP stats, and ranking, rewards and UI are based on PVP stats |
 | `PVE` | The `/stats` command displays only PVE stats, and ranking, rewards and UI are based on PVE stats |
 
+### Automatic Bans
+
+The Automatic Bans feature allows server owners to automatically ban players who meet suspicious statistical patterns, helping detect potential cheaters or rule violators. Bans are triggered when players die or eliminate other players, checking their overall statistics against configured thresholds.
+
+**How it works:**
+- Conditions are checked whenever a player kills someone or dies
+- Multiple conditions can be combined - ALL conditions must be met to trigger a ban
+- Supports custom ban reasons that will be displayed to the banned player
+- Uses the player's total statistics (not session stats) for evaluation
+
+**Available Statistics:**
+- `Kills` - Total player kills
+- `Deaths` - Total deaths (PVP and/or PVE based on ShowCombinedDeaths setting)
+- `PVPDeaths` - Deaths caused by other players only
+- `Headshots` - Total headshot kills
+- `Accuracy` - Headshot percentage (0-100)
+- `Playtime` - Total time played on the server (in seconds)
+
+**Supported Comparers:**
+- `greater` - Greater than the specified value
+- `less` - Less than the specified value  
+- `equal` - Equal to the specified value
+
+**Example Configuration:**
+The default configuration automatically bans players who achieve more than 30 kills with over 80% headshot accuracy within their first hour of playtime - a pattern typically indicating cheating:
+
+```xml
+<AutomaticBan Reason="Cheating (AB)">
+  <Conditions>
+    <Condition Comparer="greater" Stat="Kills" Value="30" />
+    <Condition Comparer="greater" Stat="Accuracy" Value="80" />
+    <Condition Comparer="less" Stat="Playtime" Value="3600" />
+  </Conditions>
+</AutomaticBan>
+```
+
+> ⚠️ **Warning**  
+> Use this feature carefully and test your conditions thoroughly. Consider your server's gameplay style and player skill levels when setting thresholds to avoid false positives.
+
 ### Other Options
 
 The plugin offers several additional options to customize functionality:
@@ -61,15 +109,6 @@ The plugin offers several additional options to customize functionality:
 
 ---
 
-## Workshop (Optional)
-The UI is optional and provides a visual display for PVP stats. 
-
-- **Workshop Item**: [Player Stats UI](https://steamcommunity.com/sharedfiles/filedetails/?id=3352126593)
-- **ID**: `3352126593`
-
-> 💡 **PRO TIP**  
-> Remember to set `<EnableUIEffect>true</EnableUIEffect>` in the configuration file to activate the UI.
-
 ---
 
 ## Commands
@@ -123,6 +162,16 @@ The UI is optional and provides a visual display for PVP stats.
     <Reward Name="VIP Rank" Treshold="50" PermissionGroup="vip" />
     <Reward Name="MVP Rank" Treshold="125" PermissionGroup="mvp" />
   </Rewards>
+  <EnableAutomaticBans>false</EnableAutomaticBans>
+  <AutomaticBans>
+    <AutomaticBan Reason="Cheating (AB)">
+      <Conditions>
+        <Condition Comparer="greater" Stat="Kills" Value="30" />
+        <Condition Comparer="greater" Stat="Accuracy" Value="80" />
+        <Condition Comparer="less" Stat="Playtime" Value="3600" />
+      </Conditions>
+    </AutomaticBan>
+  </AutomaticBans>
 </PlayerStatsConfiguration>
 ```
 
@@ -145,7 +194,7 @@ UI made by **💪 Soer (Unbeaten)**. He also sponsored the creation of this plug
    Edit the `<Rewards>` section in the configuration file with your desired thresholds and permission groups.
 
 4. **How can I create a custom UI?**  
-   You can download the `statsui.unitypackage` from the [All versions](versions) page and import it into your Unity project. Then, customize the UI as needed and reupload it to the workshop.
+   You can download the `statsui.unitypackage` from the **All versions** page and import it into your Unity project. Then, customize the UI as needed and reupload it to the workshop. Remember in Unity do not rename any of the objects in the hierarchy, as the plugin uses the object names to find them. When reuploading, make sure to use a unique GUID and ID.
 
 ---