YappersHQ.HexTags.Shared 1.0.1

.NET 10.0

dotnet add package YappersHQ.HexTags.Shared --version 1.0.1

NuGet\Install-Package YappersHQ.HexTags.Shared -Version 1.0.1

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="YappersHQ.HexTags.Shared" Version="1.0.1" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="YappersHQ.HexTags.Shared" Version="1.0.1" />
                    

                            Directory.Packages.props

<PackageReference Include="YappersHQ.HexTags.Shared" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add YappersHQ.HexTags.Shared --version 1.0.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: YappersHQ.HexTags.Shared, 1.0.1"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package YappersHQ.HexTags.Shared@1.0.1

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=YappersHQ.HexTags.Shared&version=1.0.1
                    

                            Install as a Cake Addin

#tool nuget:?package=YappersHQ.HexTags.Shared&version=1.0.1
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

<div align="center"> <h1><strong>HexTags</strong></h1> <p>Priority-based chat & scoreboard tags for CS2 ModSharp servers — driven by SteamID, admin flags, or VIP, with optional shared-MySQL rule sync.</p> </div>

HexTags assigns each player a colored chat prefix, name/chat color, an optional name suffix, and a short scoreboard clan-tag based on a list of priority-ranked rules. Rules match on SteamID, admin permission flag, or VIP status. Rules can be loaded from the local config file or sourced from a shared MySQL database (with the config rules kept as the offline fallback and the initial DB seed), so multiple servers can stay in sync.

🚀 Install

Copy the build output into your ModSharp install (<sharp> = your sharp directory):

From	To
`.build/modules/HexTags.Core/`	`<sharp>/modules/HexTags/`
`.build/shared/HexTags.Shared/HexTags.Shared.dll`	`<sharp>/shared/HexTags.Shared.dll`
`.build/configs.example/cs2-hextags.json`	`<sharp>/configs/cs2-hextags.json`

Restart the server (or change map) to load. On first run, if <sharp>/configs/cs2-hextags.json is missing the plugin writes a default config there automatically — copying the example is only needed if you want the sample rule set.

Optional integrations are resolved if present: AdminManager (for AdminFlag matches), a VIP module (for Vip/VipFlag matches), and ClientPreferences (to persist the !hidetag toggle). The shared-MySQL sync uses the bundled MySqlConnector.

⌨️ Commands

Command	Description
`!hidetag`	Toggle your own tag on/off. The preference is saved via ClientPreferences and reapplied on rejoin.

⚙️ Configuration

configs/cs2-hextags.json (auto-written on first run):

Setting	Default	Meaning
`Enabled`	`true`	Master on/off switch.
`UseDatabase`	`true`	When true and `Database.Host` is set, rules are sourced from the shared MySQL DB. The `Rules` list is still used as offline fallback and initial DB seed.
`ServerTag`	`""`	Identifies this server in the DB — rows with `server='all'` or `server=<ServerTag>` apply. Empty = only `all` rows.
`PollSeconds`	`60`	How often (seconds, min 15) to poll the DB version marker for rule changes.
`Database`	`{}`	MySQL connection — `Host`, `Port` (3306), `User`, `Password`, `Name`. Fill on the deployed server only; do not commit real credentials.
`Rules`	sample set	Ordered list of tag rules (see below).

Rule fields

Field	Meaning
`Name`	Human label for the rule.
`Match`	`{ "Type": ..., "Value": ... }` — see match types below.
`Tag`	Chat prefix shown before the name (color tokens like `{red}` allowed).
`Suffix`	Optional text appended after the name.
`NameColor`	Color applied to the player name (`{teamcolor}` supported).
`ChatColor`	Color applied to the player's chat message text.
`ScoreboardTag`	Short clan-tag shown on the scoreboard.
`Priority`	Higher wins. Rules are sorted by priority descending at load; matching rules stack, with higher-priority rules filling fields first.

Match types

`Type`	`Value`	Matches when
`SteamId`	a SteamID64	the player's SteamID equals `Value`.
`AdminFlag`	an admin permission (e.g. `admin:ban`, `*`)	the player's admin has that permission.
`Vip`	`""`	the player is VIP.
`VipFlag`	a VIP flag	the player has that VIP flag.
`Default`	`""`	always (fallback rule).

🔧 How it works

Tags are resolved per-SteamID and cached; the cache is invalidated on connect, admin-check, and disconnect. Each player's matching rules are merged by priority into a final tag, applied to chat via a SayText2 hook and to the scoreboard via the player controller's clan-tag. When UseDatabase is on, a background timer polls a DB version marker every PollSeconds and only reloads rules when it changes; an empty DB is seeded from the config Rules on first connect.

🧩 Public API

Other plugins can hide/show a player's HexTag at runtime via the shipped IHexTagsShared interface (resolve in OnAllModulesLoaded):

var api = sharpModuleManager
    .GetOptionalSharpModuleInterface<IHexTagsShared>(IHexTagsShared.Identity)?.Instance;

api?.SetHidden(slot, true);   // transient external hide (not saved)
bool hidden = api?.IsHidden(slot) ?? false;

📦 Build

dotnet build -c Release

Outputs the module to .build/modules/HexTags.Core/HexTags.dll (with its dependencies), the public API to .build/shared/HexTags.Shared/HexTags.Shared.dll, and the example config to .build/configs.example/cs2-hextags.json.

<div align="center"> <p>Made with ❤️ by <a href="https://gitlab.com/cs2-server-plugins">cs2-server-plugins</a></p> <p>⭐ Star this repo if you find it useful!</p> </div>

Product	Compatible and additional computed target framework versions.
.NET	net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net10.0
- No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last Updated
1.0.1	101	8/10/2026
1.0.0	113	8/1/2026