# Faceit Details

CS2 plugin that displays real Faceit levels with scoreboard icons, chat prefix, clan tag, and a menu.

## Features

- **Scoreboard Icons** - Shows custom Faceit level pins in the scoreboard (requires workshop addon + MultiAddonManager)
- **`!faceit` Menu** - Lists all online players with their Faceit levels via MenuManager
- **Chat Prefix** - `[6] PlayerName` before every chat message (configurable format)
- **Clan Tag** - `[6]` shows in scoreboard next to the player name
- **Automatic Refresh** - Fetches from Faceit API periodically
- **Rate Limited** - Max 3 concurrent API requests

## Requirements

- [CounterStrikeSharp](https://github.com/roflmuffin/CounterStrikeSharp/releases) with CS2
- [MenuManager](https://github.com/NickFox/nf-core-MenuManager) (for `!faceit` menu)
- [MultiAddonManager](https://github.com/Source2ZE/MultiAddonManager) + [Faceit Workshop Addon](https://steamcommunity.com/sharedfiles/filedetails/?id=3724637448) (for scoreboard icons)
- [Faceit API Key](https://developers.faceit.com/) - Server API Key

## Installation

1. Copy `FaceitDetails.dll` to `addons/counterstrikesharp/plugins/`
2. Ensure `MenuManager` is also installed
3. Restart server or run `css_plugins load FaceitDetails`
4. Config auto-generates at `configs/plugins/FaceitDetails/FaceitDetails.json`
5. Add your Faceit API key and reload

### Scoreboard Icons Setup

To show Faceit level icons in the scoreboard, add this to `game/csgo/cfg/multiaddonmanager/multiaddonmanager.cfg`:

```
mm_extra_addons "3724637448"
```

## Configuration

```json
{
"FaceitApiKey": "your-api-key-here",
"PrefixEnabled": true,
"PrefixFormat": "[{LEVEL}]",
"ClanTagEnabled": true,
"ScoreboardIcons": true,
"RefreshMinutes": 5,
"ConfigVersion": 8
}
```

| Option | Default | Description |
|--------|---------|-------------|
| `FaceitApiKey` | `""` | Your Faceit Server API Key |
| `PrefixEnabled` | `true` | Add `[LVL]` before player name in chat |
| `PrefixFormat` | `"[{LEVEL}]"` | Chat prefix format. `{LEVEL}` = Faceit level |
| `ClanTagEnabled` | `true` | Show Faceit level as clan tag in scoreboard |
| `ScoreboardIcons` | `true` | Show Faceit level icon/pin in scoreboard |
| `RefreshMinutes` | `5` | How often to re-fetch levels (minutes) |

### PrefixFormat Examples

| Format | Result |
|--------|--------|
| `[{LEVEL}]` | `[6] PlayerName: message` |
| `「{LEVEL}」` | `「6」 PlayerName: message` |
| `LVL {LEVEL} \|` | `LVL 6 \| PlayerName: message` |

## Commands

| Command | Description |
|---------|-------------|
| `!faceit` | Menu with all online players and their Faceit levels |

## How It Works

1. On player connect, fetches Faceit level from Faceit API via SteamID64
2. Level is cached and refreshed every `RefreshMinutes`
3. Scoreboard pin is set via `InventoryServices.Rank[5]` using MedalRank pins from the workshop addon
4. Chat messages get a `[LVL]` prefix before the player name
5. Clan tag updates every 3 seconds with the current Faceit level
6. `!faceit` opens a menu listing all online players

## Performance

- API calls rate-limited to 3 concurrent requests
- Duplicate requests automatically rejected
- Stale data cleaned every 5 minutes
- Scoreboard pins updated in real-time via OnTick

## Author

**illusion @ CodeStrike**

## License

All rights reserved.