Skip to content

Commit f952eb2

Browse files
authored
Update README.md
1 parent d24d3d4 commit f952eb2

1 file changed

Lines changed: 13 additions & 6 deletions

File tree

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
<a name="readme-top"></a>
2+
[![UpdateManager Compatible](https://img.shields.io/badge/CS2-UpdateManager-darkgreen)](https://github.com/Kandru/cs2-update-manager/)
23

34
<div align="center">
45
<h1 align="center">SharpTimer-Trails</h1>
5-
A plugin that allows the top players (by points) to have a custom trail.
6+
A plugin that allows the top players (by points) to have a custom trail. Supports <a href="https://github.com/Kandru/cs2-update-manager">automatic updates</a> (optional).
67
</div>
78
<br>
89

910
> [!IMPORTANT]
10-
> Credits for the base plugin go to [exkludera](https://github.com/exkludera)! All I did was integrate it with SharpTimer & fix the teleport issue.
11+
> Credits for the base plugin go to [exkludera](https://github.com/exkludera)! All I did was integrate it with SharpTimer, fixed the teleport issue, and added some new config options.
1112
>
1213
<br>
1314
@@ -32,7 +33,8 @@ A plugin that allows the top players (by points) to have a custom trail.
3233

3334
### Particle Trail Usage
3435
If you want to know which particles you can use for trails, download [Source 2 Viewer](https://github.com/ValveResourceFormat/ValveResourceFormat).
35-
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.
36+
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 they are extrememly resource heavy, negiatively effecting client fps. Personally I would advise against using particles trails at this time. Hopefully I can improve this funcitonality in the future.
37+
3638
![image](https://github.com/user-attachments/assets/adaa5452-dab6-4af0-97a6-832453db8e4b)
3739

3840

@@ -45,9 +47,13 @@ This will allow you view the contents of `pak01_dir.vpk` which has all of the pa
4547
```json
4648
{
4749
"TopCount": 5, // The top 5 players with the most points will get a trail.
48-
"Permission": "@css/root", // Any player with this perm will get the trail set in Trail 0.
49-
If you don't want this, just leave it blank.
5050
"TicksForUpdate": 1, // How often the trail is updated. The higher the number the less smooth the trail will look.
51+
"TrailPermission": "@css/vip", // Any player with this perm will get the trail set in Trail 0.
52+
If you don't want this, just leave it blank.
53+
"ReloadConfigCommand": "reloadtrailscfg", The command in game to reload your config, useful for testing
54+
"UpdateConfigCommand": "updatetrailscfg", The command in game to update your config
55+
56+
"CommandPermission": "@css/root", // Any player with this permission will be able to use the reload/update commands.
5157
"TeleportThreshold": 100, // If a user is teleported beyond this many units in a tick the trail won't show.
5258
This makes it so that there isn't a long straight line between teleports/respawns.
5359
"DatabaseRefreshInterval": 300, // How often the plugin fetches the list of top players from the database.
@@ -101,7 +107,8 @@ This will allow you view the contents of `pak01_dir.vpk` which has all of the pa
101107
},
102108
"EnableDebug": false, // Set this to true if you find you're having issues with the trail being created when teleporting.
103109
It will give you insight into how you might want to adjust your TeleportThreshold value, as it shows teleport distances.
104-
"ConfigVersion": 1
110+
"AutoUpdateConfig": false, // If True, this will automatically update your config when you have installed a version of the plugin (if config values have changed)
111+
"ConfigVersion": 2
105112
}
106113
```
107114
<p align="right">(<a href="#readme-top">back to top</a>)</p>

0 commit comments

Comments
 (0)