Merge pull request #54 from daffyyyy/update-readme-1

Update README.md

.github/workflows/build.yml

@@ -28,6 +28,22 @@ 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 \

Config.cs

@@ -3,92 +3,95 @@ using System.Text.Json.Serialization;
 
 namespace WeaponPaints
 {
-    public class Messages
-    {
-        [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("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.";
-    }
+	public class Messages
+	{
+		[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("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.";
+	}
 
-    public class Additional
-    {
-        [JsonPropertyName("SkinVisibilityFix")]
-        public bool SkinVisibilityFix { get; set; } = true;
+	public class Additional
+	{
+		[JsonPropertyName("SkinVisibilityFix")]
+		public bool SkinVisibilityFix { get; set; } = true;
 
-        [JsonPropertyName("KnifeEnabled")]
-        public bool KnifeEnabled { get; set; } = true;
+		[JsonPropertyName("KnifeEnabled")]
+		public bool KnifeEnabled { get; set; } = true;
 
-        [JsonPropertyName("SkinEnabled")]
-        public bool SkinEnabled { get; set; } = true;
+		[JsonPropertyName("SkinEnabled")]
+		public bool SkinEnabled { get; set; } = true;
 
-        [JsonPropertyName("CommandWpEnabled")]
-        public bool CommandWpEnabled { get; set; } = true;
+		[JsonPropertyName("CommandWpEnabled")]
+		public bool CommandWpEnabled { get; set; } = true;
 
-        [JsonPropertyName("CommandKillEnabled")]
-        public bool CommandKillEnabled { get; set; } = true;
-        
-        [JsonPropertyName("CommandKnife")]
-        public string CommandKnife { get; set; } = "knife";
+		[JsonPropertyName("CommandKillEnabled")]
+		public bool CommandKillEnabled { get; set; } = true;
 
-        [JsonPropertyName("CommandSkin")]
-        public string CommandSkin { get; set; } = "ws";
+		[JsonPropertyName("CommandKnife")]
+		public string CommandKnife { get; set; } = "knife";
 
-        [JsonPropertyName("CommandRefresh")]
-        public string CommandRefresh { get; set; } = "wp";
+		[JsonPropertyName("CommandSkin")]
+		public string CommandSkin { get; set; } = "ws";
 
-        [JsonPropertyName("CommandKill")]
-        public string CommandKill { get; set; } = "kill";
+		[JsonPropertyName("CommandRefresh")]
+		public string CommandRefresh { get; set; } = "wp";
 
-        [JsonPropertyName("GiveRandomKnife")]
-        public bool GiveRandomKnife { get; set; } = false;
-    }
+		[JsonPropertyName("CommandKill")]
+		public string CommandKill { get; set; } = "kill";
 
-    public class WeaponPaintsConfig : BasePluginConfig
-    {
-        public override int Version { get; set; } = 4;
+		[JsonPropertyName("GiveRandomKnife")]
+		public bool GiveRandomKnife { get; set; } = false;
+	}
 
-        [JsonPropertyName("DatabaseHost")]
-        public string DatabaseHost { get; set; } = "";
+	public class WeaponPaintsConfig : BasePluginConfig
+	{
+		public override int Version { get; set; } = 4;
 
-        [JsonPropertyName("DatabasePort")]
-        public int DatabasePort { get; set; } = 3306;
+		[JsonPropertyName("DatabaseHost")]
+		public string DatabaseHost { get; set; } = "";
 
-        [JsonPropertyName("DatabaseUser")]
-        public string DatabaseUser { get; set; } = "";
+		[JsonPropertyName("DatabasePort")]
+		public int DatabasePort { get; set; } = 3306;
 
-        [JsonPropertyName("DatabasePassword")]
-        public string DatabasePassword { get; set; } = "";
+		[JsonPropertyName("DatabaseUser")]
+		public string DatabaseUser { get; set; } = "";
 
-        [JsonPropertyName("DatabaseName")]
-        public string DatabaseName { get; set; } = "";
+		[JsonPropertyName("DatabasePassword")]
+		public string DatabasePassword { get; set; } = "";
 
-        [JsonPropertyName("CmdRefreshCooldownSeconds")]
-        public int CmdRefreshCooldownSeconds { get; set; } = 60;
+		[JsonPropertyName("DatabaseName")]
+		public string DatabaseName { get; set; } = "";
 
-        [JsonPropertyName("Prefix")]
-        public string Prefix { get; set; } = "[WeaponPaints]";
+		[JsonPropertyName("GlobalShare")]
+		public bool GlobalShare { get; set; } = false;
 
-        [JsonPropertyName("Website")]
-        public string Website { get; set; } = "example.com/skins";
+		[JsonPropertyName("CmdRefreshCooldownSeconds")]
+		public int CmdRefreshCooldownSeconds { get; set; } = 60;
 
-        [JsonPropertyName("Messages")]
-        public Messages Messages { get; set; } = new Messages();
+		[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("Additional")]
-        public Additional Additional { get; set; } = new Additional();
-    }
-    
 }

README.md

@@ -11,7 +11,7 @@ There will be a lot of frequent changes which may break functionality or compati
 
 ### Features
 - changes only paint, seed and wear on weapons and knives
-- mysql based
+- 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
@@ -20,10 +20,53 @@ There will be a lot of frequent changes which may break functionality or compati
 
 ### 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
+- 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:
+- not needed if config `GlobalShare = true`
 - requires PHP min v7.3 (tested on php ver `8.2.3` and nginx webserver)
 - copy website to web server (img folder not needed)
 - import `database.sql` to mysql
@@ -31,6 +74,9 @@ There will be a lot of frequent changes which may break functionality or compati
 - 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/)
 
 ### Preview

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/database.sql

@@ -1,46 +0,0 @@
--- phpMyAdmin SQL Dump
--- version 5.2.1
--- https://www.phpmyadmin.net/
---
--- Host: localhost
--- Generation Time: Nov 02, 2023 at 11:12 AM
--- Server version: 10.11.2-MariaDB
--- PHP Version: 8.2.3
-
-SET SQL_MODE = "NO_AUTO_VALUE_ON_ZERO";
-START TRANSACTION;
-SET time_zone = "+00:00";
-
-
-/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
-/*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;
-/*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;
-/*!40101 SET NAMES utf8mb4 */;
-
---
--- Database: `cs2server`
---
-
--- --------------------------------------------------------
-
---
--- Table structure for table `wp_player_skins`
---
-
-CREATE TABLE `wp_player_skins` (
-  `steamid` varchar(64) NOT NULL,
-  `weapon_defindex` int(6) NOT NULL,
-  `weapon_paint_id` int(6) NOT NULL,
-  `weapon_wear` float NOT NULL DEFAULT 0.0001,
-  `weapon_seed` int(16) NOT NULL DEFAULT 0
-) ENGINE=InnoDB DEFAULT CHARSET=utf8mb3 COLLATE=utf8mb3_unicode_ci;
-
---
--- Table structure for table `wp_player_knife`
---
-
-CREATE TABLE `wp_player_knife` (
-  `steamid` varchar(64) NOT NULL,
-  `knife` varchar(64) NOT NULL,
-  UNIQUE (`steamid`)
-) ENGINE = InnoDB;

website/index.php

@@ -7,9 +7,7 @@ require_once 'class/utils.php';
 
 $db = new DataBase();
 if (isset($_SESSION['steamid'])) {
-
-	include('steamauth/userInfo.php');
-	$steamid = $steamprofile['steamid'];
+	$steamid = $_SESSION['steamid'];
 
 	$weapons = UtilsClass::getWeaponsFromArray();
 	$skins = UtilsClass::skinsFromJson();