Merge pull request #69 from daffyyyy/fix-knife-3

TEMP FIX FOR KNIVES

.github/workflows/build.yml

@@ -3,8 +3,16 @@ name: Build
 on:
   push:
     branches: [ "main" ]
+    paths-ignore:
+      - '**/README.md'
+      - '**/.gitignore'
+      - '**/LICENSE'
   pull_request:
     branches: [ "main" ]
+    paths-ignore:
+      - '**/README.md'
+      - '**/.gitignore'
+      - '**/LICENSE'
 
 env:
   BUILD_NUMBER: ${{ github.run_number }}
@@ -12,7 +20,6 @@ env:
   PROJECT_NAME: "WeaponPaints"
   OUTPUT_PATH: "./WeaponPaints"
 
-
 jobs:
   build:
     permissions: write-all
@@ -28,19 +35,40 @@ jobs:
       run: dotnet restore
     - name: Build
       run: dotnet build ${{ env.PROJECT_PATH }} -c WeaponPaints -o ${{ env.OUTPUT_PATH }}
+
+  publish:
+    if: github.event_name == 'push'
+    permissions: write-all
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+    - uses: actions/checkout@v3
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v3
+      with:
+        dotnet-version: 7.0.x
+    - name: Restore
+      run: dotnet restore
+    - name: Build
+      run: dotnet build ${{ env.PROJECT_PATH }} -c WeaponPaints -o ${{ env.OUTPUT_PATH }}
     - name: Clean files
       run: |
         rm -f \
           ${{ env.OUTPUT_PATH }}/CounterStrikeSharp.API.dll \
           ${{ env.OUTPUT_PATH }}/McMaster.NETCore.Plugins.dll \
           ${{ env.OUTPUT_PATH }}/Microsoft.DotNet.PlatformAbstractions.dll \
-          ${{ env.OUTPUT_PATH }}/Microsoft.Extensions.DependencyModel.dll 
+          ${{ env.OUTPUT_PATH }}/Microsoft.Extensions.DependencyModel.dll \
+    - name: Copy skins.json
+      run: cp website/data/skins.json ${{ env.OUTPUT_PATH }}/skins.json
     - name: Zip
       uses: thedoctor0/zip-release@0.7.5
       with:
         type: 'zip'
         filename: '${{ env.PROJECT_NAME }}.zip'
         path: ${{ env.OUTPUT_PATH }}
+    - name: Clean files Website
+      run: |
+        rm -rf website/img/
     - name: Zip
       uses: thedoctor0/zip-release@0.7.5
       with:
@@ -54,4 +82,4 @@ jobs:
         name: "Build ${{ env.BUILD_NUMBER }}"
         tag: "build-${{ env.BUILD_NUMBER }}"
         body: |
-          Place the plugin in game/csgo/addons/counterstrikesharp/plugins/WeaponPaints
+          Place the plugin in game/csgo/addons/counterstrikesharp/plugins/WeaponPaints

Config.cs

@@ -1,32 +1,109 @@
-using CounterStrikeSharp.API.Core;
+using CounterStrikeSharp.API.Core;
 using System.Text.Json.Serialization;
 
 namespace WeaponPaints
 {
-    public class WeaponPaintsConfig : BasePluginConfig
+	public class Messages
-    {
+	{
-        public override int Version { get; set; } = 1;
+		[JsonPropertyName("WebsiteMessageCommand")]
+		public string WebsiteMessageCommand { get; set; } = "Visit {WEBSITE} where you can change skins.";
+		[JsonPropertyName("SynchronizeMessageCommand")]
+		public string SynchronizeMessageCommand { get; set; } = "Type !wp to synchronize chosen skins.";
+		[JsonPropertyName("KnifeMessageCommand")]
+		public string KnifeMessageCommand { get; set; } = "Type !knife to open knife menu.";
+		[JsonPropertyName("CooldownRefreshCommand")]
+		public string CooldownRefreshCommand { get; set; } = "You can't refresh weapon paints right now.";
+		[JsonPropertyName("SuccessRefreshCommand")]
+		public string SuccessRefreshCommand { get; set; } = "Refreshing weapon paints.";
+		[JsonPropertyName("ChosenKnifeMenu")]
+		public string ChosenKnifeMenu { get; set; } = "You have chosen {KNIFE} as your knife.";
+		[JsonPropertyName("ChosenSkinMenu")]
+		public string ChosenSkinMenu { get; set; } = "You have chosen {SKIN} as your skin.";
+		[JsonPropertyName("ChosenKnifeMenuKill")]
+		public string ChosenKnifeMenuKill { get; set; } = "To correctly apply skin for knife, you need to type !kill.";
+		[JsonPropertyName("KnifeMenuTitle")]
+		public string KnifeMenuTitle { get; set; } = "Knife Menu.";
+		[JsonPropertyName("WeaponMenuTitle")]
+		public string WeaponMenuTitle { get; set; } = "Weapon Menu.";
+		[JsonPropertyName("SkinMenuTitle")]
+		public string SkinMenuTitle { get; set; } = "Select skin for {WEAPON}";
+	}
 
-        [JsonPropertyName("DatabaseHost")]
+	public class Additional
-        public string DatabaseHost { get; set; } = "localhost";
+	{
+		[JsonPropertyName("SkinVisibilityFix")]
+		public bool SkinVisibilityFix { get; set; } = true;
 
-        [JsonPropertyName("DatabasePort")]
+		[JsonPropertyName("KnifeEnabled")]
-        public int DatabasePort { get; set; } = 3306;
+		public bool KnifeEnabled { get; set; } = true;
 
-        [JsonPropertyName("DatabaseUser")]
+		[JsonPropertyName("SkinEnabled")]
-        public string DatabaseUser { get; set; } = "dbuser";
+		public bool SkinEnabled { get; set; } = true;
 
-        [JsonPropertyName("DatabasePassword")]
+		[JsonPropertyName("CommandWpEnabled")]
-        public string DatabasePassword { get; set; } = "dbuserpw";
+		public bool CommandWpEnabled { get; set; } = true;
 
-        [JsonPropertyName("DatabaseName")]
+		[JsonPropertyName("CommandKillEnabled")]
-        public string DatabaseName { get; set; } = "dbname";
+		public bool CommandKillEnabled { get; set; } = true;
 
-        [JsonPropertyName("CmdRefreshCooldownSeconds")]
+		[JsonPropertyName("CommandKnife")]
-        public int CmdRefreshCooldownSeconds { get; set; } = 60;
+		public string CommandKnife { get; set; } = "knife";
+
+		[JsonPropertyName("CommandSkin")]
+		public string CommandSkin { get; set; } = "ws";
+
+		[JsonPropertyName("CommandSkinSelection")]
+		public string CommandSkinSelection { get; set; } = "skins";
+
+		[JsonPropertyName("CommandRefresh")]
+		public string CommandRefresh { get; set; } = "wp";
+
+		[JsonPropertyName("CommandKill")]
+		public string CommandKill { get; set; } = "kill";
+
+		[JsonPropertyName("GiveRandomKnife")]
+		public bool GiveRandomKnife { get; set; } = false;
+
+		[JsonPropertyName("GiveRandomSkin")]
+		public bool GiveRandomSkin { get; set; } = false;
+	}
+
+	public class WeaponPaintsConfig : BasePluginConfig
+	{
+		public override int Version { get; set; } = 4;
+
+		[JsonPropertyName("DatabaseHost")]
+		public string DatabaseHost { get; set; } = "";
+
+		[JsonPropertyName("DatabasePort")]
+		public int DatabasePort { get; set; } = 3306;
+
+		[JsonPropertyName("DatabaseUser")]
+		public string DatabaseUser { get; set; } = "";
+
+		[JsonPropertyName("DatabasePassword")]
+		public string DatabasePassword { get; set; } = "";
+
+		[JsonPropertyName("DatabaseName")]
+		public string DatabaseName { get; set; } = "";
+
+		[JsonPropertyName("GlobalShare")]
+		public bool GlobalShare { get; set; } = false;
+
+		[JsonPropertyName("CmdRefreshCooldownSeconds")]
+		public int CmdRefreshCooldownSeconds { get; set; } = 60;
+
+		[JsonPropertyName("Prefix")]
+		public string Prefix { get; set; } = "[WeaponPaints]";
+
+		[JsonPropertyName("Website")]
+		public string Website { get; set; } = "example.com/skins";
+
+		[JsonPropertyName("Messages")]
+		public Messages Messages { get; set; } = new Messages();
+
+		[JsonPropertyName("Additional")]
+		public Additional Additional { get; set; } = new Additional();
+	}
 
-        [JsonPropertyName("WebSite")]
-        public string WebSite { get; set; } = "http://wp.example.com";
-        
-    }
 }

README.md

@@ -1,33 +1,80 @@
-# cs2-WeaponPaints
+# CS2 Weapon Paints
 
-[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/E1E2G0P2O) or [Donate on Steam](https://steamcommunity.com/tradeoffer/new/?partner=41515647&token=gW2W-nXE)
+## Description
+Unfinished, unoptimized and not fully functional ugly demo weapon paints plugin for **[CSSharp](https://docs.cssharp.dev/)**.
+
+## Created [Discord server](https://discord.gg/d9CvaYPSFe) where you can discus about plugin.
+
+### Consider to donate instead of buying from unknown sources.
+[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/E1E2G0P2O) or [![Donate on Steam](https://github.com/Nereziel/cs2-WeaponPaints/assets/32937653/a0d53822-4ca7-4caf-83b4-e1a9b5f8c94e)](https://steamcommunity.com/tradeoffer/new/?partner=41515647&token=gW2W-nXE)
+
+## Features
+- Changes only paint, seed and wear on weapons and knives;
+- MySQL based or global website at [weaponpaints.fun](https://weaponpaints.fun/), so you dont need MySQL/Website;
+- Data sync on player connect;
+- Added command **`!wp`** to refresh skins; ***(with cooldown in second can be configured)***
+- Added command **`!ws`** to show website;
+- Added command **`!knife`** to show menu with knives;
+- Knife change is now limited to have these cvars empty **`mp_t_default_melee ""`** and **`mp_ct_default_melee ""`**;
+
+## CS2 Server
+- Compile and copy plugin to plugins, [more info here](https://docs.cssharp.dev/guides/hello-world-plugin/);
+- Setup **`addons/counterstrikesharp/configs/plugins/WeaponPaints/WeaponPaints.json`** set **`GlobalShare`** to **`true`** for global, or include database credentials;
+- in **`addons/counterstrikesharp/configs/core.json`** set **FollowCS2ServerGuidelines** to **`false`**;
+
+## Plugin Configuration
+<details>
+  <summary>Spoiler warning</summary>
+<code><pre>{
+	"Version": 4, // Don't touch
+	"DatabaseHost": "", // MySQL host (required if GlobalShare = false)
+	"DatabasePort": 3306, // MySQL port (required if GlobalShare = false)
+	"DatabaseUser": "", // MySQL username (required if GlobalShare = false)
+	"DatabasePassword": "", // MySQL user password (required if GlobalShare = false)
+	"DatabaseName": "", // MySQL database name (required if GlobalShare = false)
+	"GlobalShare": false, // Enable or disable GlobalShare, plugin can work without mysql credentials but with shared website at weaponpaints.fun
+	"CmdRefreshCooldownSeconds": 60, // Cooldown time in refreshing skins (!wp command)
+	"Prefix": "[WeaponPaints]", // Prefix every chat message
+	"Website": "example.com/skins", // Website used in WebsiteMessageCommand (!ws command)
+"Messages": {
+	"WebsiteMessageCommand": "Visit {WEBSITE} where you can change skins.", // Information about website where player can change skins (!ws command) Set to empty to disable
+	"SynchronizeMessageCommand": "Type !wp to synchronize chosen skins.", // Information about skins refreshing (!ws command) Set to empty to disable
+	"KnifeMessageCommand": "Type !knife to open knife menu.", // Information about knife menu (!ws command) Set to empty to disable
+	"CooldownRefreshCommand": "You can\u0027t refresh weapon paints right now.", // Cooldown information (!wp command) Set to empty to disable
+	"SuccessRefreshCommand": "Refreshing weapon paints.", // Information about refreshing skins (!wp command) Set to empty to disable
+	"ChosenKnifeMenu": "You have chosen {KNIFE} as your knife.", // Information about choosen knife (!knife command) Set to empty to disable
+	"ChosenKnifeMenuKill": "To correctly apply skin for knife, you need to type !kill.", // Information about suicide after knife selection (!knife command) Set to empty to disable
+	"KnifeMenuTitle": "Knife Menu."  // Menu title (!knife menu)
+},
+"Additional": {
+	"SkinVisibilityFix": true, // Enable or disable fix for skin visibility
+	"KnifeEnabled": true, // Enable or disable knife feature
+	"SkinEnabled": true, // Enable or disable skin feature
+	"CommandWpEnabled": true, // Enable or disable refreshing command
+	"CommandKillEnabled": true, // Enable or disable kill command
+	"CommandKnife": "knife", // Name of knife menu command, u can change to for e.g, knives
+	"CommandSkin": "ws", // Name of skin information command, u can change to for e.g, skins
+	"CommandRefresh": "wp", // Name of skin refreshing command, u can change to for e.g, refreshskins
+	"CommandKill": "kill", // Name of kill command, u can change to for e.g, suicide
+	"GiveRandomKnife": false  // Give random knife to players if they didn't choose
+},
+
+"ConfigVersion": 4  // Don't touch
+}</pre></code>
+</details>
+    
+## Web install
+Disregard if the config is **`GlobalShare = true`**;
+- Requires PHP >= 7.4; ***(Tested on php ver **`8.2.3`** and nginx webserver)***
+- Copy website to web server; ***(Folder `img` not needed)***
+- Get [Steam API Key](https://steamcommunity.com/dev/apikey);
+- Fill in database credentials and api key in `class/config.php`;
+- Visit website and login via steam;
+
+## Known issues
+- Issue on Windows servers, no knives are given.
 
 ### Use this plugin at your own risk! Using this may lead to GSLT ban or something else Valve come with. [Valve Server guidelines](https://blog.counter-strike.net/index.php/server_guidelines/)
 
-### Description
+## Preview
-Unfinished, unoptimized and not fully functional ugly demo weapon paints plugin for [CSSharp](https://docs.cssharp.dev/).
-
-### Features
-- changes only paint, seed and wear on weapons and knives
-- mysql based
-- data sync on player connect
-- Added command `!wp` to refresh skins (with cooldown in second can be configured)
-- Added command `!ws` to show website
-- Added command `!knife` to show menu with knives
-- Knife change is now limited to have these cvars empty `mp_t_default_melee ""` and `mp_ct_default_melee ""`
-
-### CS2 server:
-- compile and copy plugin to plugins. Info here [https://docs.cssharp.dev/guides/hello-world-plugin/](https://docs.cssharp.dev/guides/hello-world-plugin/)
-- setup `addons/counterstrikesharp/configs/plugins/WeaponPaints/WeaponPaints.json` with database credentials
-- in `addons/counterstrikesharp/configs/core.json` set **FollowCS2ServerGuidelines** to **false**
-
-### Web install:
-- requires PHP (tested on php ver `8.2.3` and nginx webserver)
-- copy website to web server
-- import `database.sql` to mysql
-- get steam api key [https://steamcommunity.com/dev/apikey](https://steamcommunity.com/dev/apikey)
-- fill in database credentials and api key in `class/config.php`
-- visit website and login via steam
-
-### Preview
 ![preview](https://github.com/Nereziel/cs2-WeaponPaints/blob/main/website/preview.png?raw=true)

Utility.cs

@@ -0,0 +1,62 @@
+using CounterStrikeSharp.API.Core;
+using CounterStrikeSharp.API.Modules.Entities;
+using CounterStrikeSharp.API.Modules.Utils;
+using System.Reflection;
+
+namespace WeaponPaints
+{
+	public static class Utility
+	{
+		public static WeaponPaintsConfig? Config { get; set; }
+
+		public static bool IsPlayerValid(CCSPlayerController? player)
+		{
+			return (player != null && player.IsValid && !player.IsBot && !player.IsHLTV);
+		}
+
+		public static string ReplaceTags(string message)
+		{
+			if (message.Contains('{'))
+			{
+				string modifiedValue = message;
+				if (Config != null)
+				{
+					modifiedValue = modifiedValue.Replace("{WEBSITE}", Config.Website);
+				}
+				foreach (FieldInfo field in typeof(ChatColors).GetFields())
+				{
+					string pattern = $"{{{field.Name}}}";
+					if (message.Contains(pattern, StringComparison.OrdinalIgnoreCase))
+					{
+						modifiedValue = modifiedValue.Replace(pattern, field.GetValue(null)!.ToString(), StringComparison.OrdinalIgnoreCase);
+					}
+				}
+				return modifiedValue;
+			}
+
+			return message;
+		}
+
+		public static void Log(string message)
+		{
+			Console.BackgroundColor = ConsoleColor.DarkGray;
+			Console.ForegroundColor = ConsoleColor.Cyan;
+			Console.WriteLine("[WeaponPaints] " + message);
+			Console.ResetColor();
+		}
+		public static void ShowAd(string moduleVersion)
+		{
+			Console.WriteLine(" ");
+			Console.WriteLine(" _     _  _______  _______  _______  _______  __    _  _______  _______  ___   __    _  _______  _______ ");
+			Console.WriteLine("| | _ | ||       ||   _   ||       ||       ||  |  | ||       ||   _   ||   | |  |  | ||       ||       |");
+			Console.WriteLine("| || || ||    ___||  |_|  ||    _  ||   _   ||   |_| ||    _  ||  |_|  ||   | |   |_| ||_     _||  _____|");
+			Console.WriteLine("|       ||   |___ |       ||   |_| ||  | |  ||       ||   |_| ||       ||   | |       |  |   |  | |_____ ");
+			Console.WriteLine("|       ||    ___||       ||    ___||  |_|  ||  _    ||    ___||       ||   | |  _    |  |   |  |_____  |");
+			Console.WriteLine("|   _   ||   |___ |   _   ||   |    |       || | |   ||   |    |   _   ||   | | | |   |  |   |   _____| |");
+			Console.WriteLine("|__| |__||_______||__| |__||___|    |_______||_|  |__||___|    |__| |__||___| |_|  |__|  |___|  |_______|");
+			Console.WriteLine("						>> Version: " + moduleVersion);
+			Console.WriteLine("			>> GitHub: https://github.com/Nereziel/cs2-WeaponPaints");
+			Console.WriteLine(" ");
+		}
+	}
+}

WeaponPaints.csproj

@@ -9,7 +9,9 @@
 
   <ItemGroup>
     <PackageReference Include="CounterStrikeSharp.API" Version="*" />
-    <PackageReference Include="Nexd.MySQL" Version="1.0.1" />
+    <PackageReference Include="Dapper" Version="2.1.21" />
+    <PackageReference Include="MySqlConnector" Version="2.3.1" />
+    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
   </ItemGroup>
 
   <ItemGroup>

website/class/utils.php

@@ -0,0 +1,96 @@
+<?php
+class UtilsClass
+{
+    public static function skinsFromJson(): array
+    {
+        $skins = [];
+        $json = json_decode(file_get_contents(__DIR__ . "/../data/skins.json"), true);
+
+        foreach ($json as $skin) {
+            $skins[(int) $skin['weapon_defindex']][(int) $skin['paint']] = [
+                'weapon_name' => $skin['weapon_name'],
+                'paint_name' => $skin['paint_name'],
+                'image_url' => $skin['image'],
+            ];
+        }
+
+        return $skins;
+    }
+
+    public static function getWeaponsFromArray()
+    {
+        $weapons = [];
+        $temp = self::skinsFromJson();
+
+        foreach ($temp as $key => $value) {
+            if (key_exists($key, $weapons))
+                continue;
+
+            $weapons[$key] = [
+                'weapon_name' => $value[0]['weapon_name'],
+                'paint_name' => $value[0]['paint_name'],
+                'image_url' => $value[0]['image_url'],
+            ];
+        }
+
+        return $weapons;
+    }
+
+    public static function getKnifeTypes()
+    {
+        $knifes = [];
+        $temp = self::getWeaponsFromArray();
+
+        foreach ($temp as $key => $weapon) {
+            if (
+                !in_array($key, [
+                    500,
+                    503,
+                    505,
+                    506,
+                    507,
+                    508,
+                    509,
+                    512,
+                    514,
+                    515,
+                    516,
+                    517,
+                    518,
+                    519,
+                    520,
+                    521,
+                    522,
+                    523,
+                    525
+                ])
+            )
+                continue;
+
+            $knifes[$key] = [
+                'weapon_name' => $weapon['weapon_name'],
+                'paint_name' => rtrim(explode("|", $weapon['paint_name'])[0]),
+                'image_url' => $weapon['image_url'],
+            ];
+            $knifes[0] = [
+                'weapon_name' => "weapon_knife",
+                'paint_name' => "Default knife",
+                'image_url' => "https://raw.githubusercontent.com/Nereziel/cs2-WeaponPaints/main/website/img/skins/weapon_knife.png",
+            ];
+        }
+
+        ksort($knifes);
+        return $knifes;
+    }
+
+    public static function getSelectedSkins(array $temp)
+    {
+        $selected = [];
+
+        foreach ($temp as $weapon) {
+            $selected[$weapon['weapon_defindex']] = $weapon['weapon_paint_id'];
+        }
+
+        return $selected;
+    }
+}