https://github.com/medvemarci/statssystem
A SCP: Secret Laboratory LabApi plugin and API to manage different statistics for the players.
https://github.com/medvemarci/statssystem
api labapi plugin scpsl stats
Last synced: 3 months ago
JSON representation
A SCP: Secret Laboratory LabApi plugin and API to manage different statistics for the players.
- Host: GitHub
- URL: https://github.com/medvemarci/statssystem
- Owner: MedveMarci
- Created: 2025-08-12T13:01:50.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-12-15T20:11:58.000Z (6 months ago)
- Last Synced: 2025-12-19T03:48:51.119Z (6 months ago)
- Topics: api, labapi, plugin, scpsl, stats
- Language: C#
- Homepage:
- Size: 64.5 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# StatsSystem
> **SCP: Secret Laboratory LabAPI plugin** for comprehensive, modular player statistics tracking.
## Support
---
## Features
- **Modular stat tracking** — kills, deaths, playtime, SCP kills, MicroHID kills, Class D kills and more, all toggleable individually
- **Daily / historical stats** — configurable time windows (e.g. last 7, 30, 90 days) for every tracked stat
- **Two storage backends** — human-readable JSON or compact Binary format, swappable
- **Leaderboards** — in-game leaderboard for any stat, including historical period views
- **Public API** — full C# API for other plugins to read and write custom statistics
- **Admin tools** — save, reload, reset and inspect stats via Remote Admin
- **Auto-save** — configurable auto-save interval with file writes (no data corruption)
---
## Installation
1. Download the latest `StatsSystem.dll` from [GitHub Releases](https://github.com/MedveMarci/StatsSystem/releases).
2. Place the DLL in your server's folder.
- Linux: `~/.config/SCP Secret Laboratory/LabAPI/plugins/global/`
- Windows: `%appdata%/SCP Secret Laboratory/LabAPI/plugins/global/`
3. Start the server — a default `config.yml` is generated automatically.
4. Adjust the config to your needs and reload.
---
## Configuration
Configuration is located at:
- Linux: `~/.config/SCP Secret Laboratory/LabAPI/configs/port/`
- Windows: `%appdata%/SCP Secret Laboratory/LabAPI/configs/port/`
| Key | Default | Description |
|-----|---------|-------------|
| `PlaytimeTracking` | `true` | Track total playtime per player |
| `KillsTracking` | `true` | Track total kills |
| `DeathsTracking` | `true` | Track total deaths |
| `KillsAsClassDTracking` | `true` | Track kills made while playing as Class D |
| `ClassDKillsTracking` | `true` | Track kills where the victim is Class D |
| `ScpKillsTracking` | `true` | Track kills where the victim is an SCP |
| `MicroHidKillsTracking` | `true` | Track kills made with MicroHID |
| `LastDays` | `[7, 30, 90]` | Day ranges for historical stat display |
| `StatsDataFolder` | `StatsSystem` | Folder name for stat storage files |
| `AutoSaveIntervalSeconds` | `60` | How often stats are saved (minimum: 10) |
| `StorageProvider` | `Json` | Storage format: `Json` or `Binary` |
| `Debug` | `false` | Enable verbose debug logging |
---
## Commands
### Player Commands (Client / Remote Admin)
| Command | Aliases | Description |
|---------|---------|-------------|
| `.getstat` | `.gs` | View your own stats |
| `.getstat ` | `.gs ` | View another player's stats by name or user ID |
| `.getleaderboard ` | `.gl ` | Top 10 players for a given stat |
| `.gl ` | | Top N players for a stat |
| `.gl last ` | | Top players for the last N days |
| `.gl last ` | | Top N players for the last N days |
**Leaderboard examples:**
```
.gl Kills 20
.gl TotalPlayTime last 7
.gl ScpKills last 30 15
```
### Admin Commands (Remote Admin / Game Console)
> Requires the `stat.manage` permission.
| Command | Aliases | Description |
|---------|---------|-------------|
| `ss save` | `ss s` | Immediately save all stats to disk |
| `ss reload` | `ss r` | Reload stats from disk |
| `ss resetplayer ` | `ss rp`, `ss reset` | Delete all stats for a player |
| `ss migrate` | `ss m` | Repair legacy v1 counter inconsistencies |
| `ss info` | `ss i` | Show system status (player count, keys, auto-save interval) |
#### Stat Modification (Remote Admin)
> Requires the `stat.manage` permission.
| Command | Description |
|---------|-------------|
| `addstat ` | Add to a stat value |
| `removestat ` | Subtract from a stat value |
| `setstat ` | Set a stat to an exact value |
| `deletestat ` | Remove a stat key entirely |
---
## Storage
Stats are saved to:
- Linux: `~/.config/SCP Secret Laboratory/LabAPI/configs/StatsSystem`
- Windows: `%appdata%/SCP Secret Laboratory/LabAPI/configs/StatsSystem`
(or `player_stats.bin` when using Binary storage)
### JSON vs Binary
| | JSON | Binary |
|--|------|--------|
| Human-readable | Yes | No |
| File size | Larger | ~70% smaller |
| Speed | Slower | Faster |
| Editability | Easy | Requires tool |
You can switch between formats at runtime — the plugin will automatically save in the old format and reload in the new one.
---
## Default Stat Keys
| Key | Type | Description |
|-----|------|-------------|
| `Kills` | Counter | Total kills |
| `Deaths` | Counter | Total deaths |
| `KillsAsClassD` | Counter | Kills made while Class D |
| `ClassDKills` | Counter | Kills where victim was Class D |
| `ScpKills` | Counter | Kills where victim was an SCP |
| `MicroHidKills` | Counter | Kills with MicroHID |
| `TotalPlayTime` | Duration | Total time spent on server |
## Credits
- Plugin developed by **MedveMarci**