Merge branch 'main' of https://github.com/M-archand/SharpTimer-Trails

Author: M-archand

README.md

@@ -1,61 +1,104 @@
-# SharpTimer-Trails
-**A plugin that allows the top players to have a custom trail.**
+<a name="readme-top"></a>
 
+<div align="center">
+<h1 align="center">SharpTimer-Trails</h1>
+A plugin that allows the top players (by points) to have a custom trail.
+</div>
 <br>
 
-<details>
-	<summary>Showcase</summary>
-	<img src="https://github.com/user-attachments/assets/1135a673-e19f-4a00-9edc-f4bfc760c45f" width="250"> <br>
-	<img src="https://github.com/user-attachments/assets/af7406b0-3911-489c-91e1-3dde79002790" width="300"> <br>
-	<img src="https://github.com/user-attachments/assets/7dddc6cc-a0aa-4946-9c49-c5bf6b48ceb1" width="200"> <br>
-</details>
+> [!IMPORTANT]
+> Credits for the base plugin go to [exkludera](https://github.com/exkludera)! All I did was integrate it with SharpTimer & fix the teleport issue.
+> 
+<br>
+
+## Showcase
+
+<img src="https://github.com/user-attachments/assets/1135a673-e19f-4a00-9edc-f4bfc760c45f" width="250">
+<img src="https://github.com/user-attachments/assets/af7406b0-3911-489c-91e1-3dde79002790" width="300">
+<img src="https://github.com/user-attachments/assets/7dddc6cc-a0aa-4946-9c49-c5bf6b48ceb1" width="200">
+
 
 <br>
 
 ## Information:
 
 ### Requirements
 - [CounterStrikeSharp](https://github.com/roflmuffin/CounterStrikeSharp)
-- [Cruze03/Clientprefs](https://github.com/Cruze03/Clientprefs)
+- [SharpTimer](https://github.com/Letaryat/poor-sharptimer)
+
+### Roadmap
+- [ ] Add configurable trail for replay bot
+- [ ] Fix sprites
+
+### Particle Trail Usage
+If you want to know which particles you can use for trails, download [Source 2 Viewer](https://github.com/ValveResourceFormat/ValveResourceFormat).
+This will allow you view the contents of `pak01_dir.vpk` which has all of the particle files. Not all of them will work, and some are extrememly resource heavy.
+![image](https://github.com/user-attachments/assets/adaa5452-dab6-4af0-97a6-832453db8e4b)
+
 
 <br>
 
 ## Example Config
 ```json
 {
-  "Host": "localhost",
-  "Database": "cs2_db",
-  "Username": "admin",
-  "Password": "pw",
-  "Port": 3306,
-  "Sslmode": "none",
-  "Table-Prefix": "",
-  "TopCount": 5,
-  "Permission": "@css/root",
-  "TicksForUpdate": 1,
+  "TopCount": 5,  // The top 5 players with the most points will get a trail.
+  "Permission": "@css/root",	// Any player with this perm will get the trail set in Trail 0.
+				If you don't want this, just leave it blank.
+  "TicksForUpdate": 1,	// How often the trail is updated. The higher the number the less smooth the trail will look.
+  "TeleportThreshold": 100,	// If a user is teleported beyond this many units in a tick the trail won't show.
+				This makes it so that there isn't a long straight line between teleports/respawns.
+  "DatabaseRefreshInterval": 300,	// How often the plugin fetches the list of top players from the database.
+  "DatabaseType": 1,	// 1 = MySQL, 2 = SQLite, 3 = PostgreSQL
+  "DatabaseSettings": {
+	"Host": "localhost",
+	"Database": "cs2_db",
+	"Username": "admin",
+	"Password": "pw",
+	"Port": 3306,
+	"Sslmode": "none",
+	"Table-Prefix": "",
+  }
   "Trails": {
+    "0": {
+      "Name": "Fire Trail",	// The "Name" field isn't really necessary, you can omit it if you like.
+				I left it in so you can easily identify that "Color: 255 165 0" is Orange for example.
+      "File": "particles/explosions_fx/molotov_child_flame02a.vpcf"
+      "Width": 1,
+      "Lifetime": 3
     "1": {
-      "Name": "Rainbow Trail",
-      "Color": "rainbow"
+      "Name": "Glowing Sparks Trail",
+      "File": "particles/ambient_fx/ambient_sparks_glow.vpcf"
+      "Width": 1,
+      "Lifetime": 3
     },
     "2": {
-      "Name": "Particle Trail",
-      "File": "particles/ambient_fx/ambient_sparks_glow.vpcf"
+      "Name": "Rainbow Trail",
+      "Color": "rainbow",
+      "Width": 1,
+      "Lifetime": 3
     },
     "3": {
       "Name": "Red Trail",
       "Color": "255 0 0",
-      "Width": 3,
-      "Lifetime": 2
+      "Width": 1,
+      "Lifetime": 3
     },
     "4": {
-      "Name": "Example Settings",
-      "File": "materials/sprites/laserbeam.vtex",
-      "Color": "255 255 255",
+      "Name": "Green Trail",
+      "Color": "0 255 0",
+      "Width": 1,
+      "Lifetime": 3
+    },
+    "5": {
+      "Name": "Blue Trail",
+      "Color": "0 0 255",
       "Width": 1,
-      "Lifetime": 1
+      "Lifetime": 3
     }
   },
+  "EnableDebug": false,	// Set this to true if you find you're having issues with the trail being created when teleporting.
+			It will give you insight into how you might want to adjust your TeleportThreshold value, as it shows teleport distances.
   "ConfigVersion": 1
 }
-```
+```
+<p align="right">(<a href="#readme-top">back to top</a>)</p>