ClientPrefs-GoldKingZ.Shared 1.0.4

🚀 Quick Start

1. Define your data class

public sealed class ClientPrefs
{
    public bool   ChatMuted  { get; set; } = false;
    public int    Volume     { get; set; } = 50;
    public float  XAxis      { get; set; } = 0f;
    public string FavPack    { get; set; } = "";
    public int    Mode       { get; set; } = 0;
}

Supported types: bool, int, long, ulong, float, double, string, DateTime

Reserved names (do NOT use): PlayerName, PlayerSteamID, DateAndTime — injected automatically by ClientPrefs

2. Register in your plugin

using ClientPrefs_GoldKingZ.Shared;

private IPrefsStore<ClientPrefs>? _prefs;

public override void OnAllPluginsLoaded(bool hotReload)
{
    var api = ClientPrefsApi.Get();
    if (api == null)
    {
        Logger.LogError("[MyPlugin] Missing cs2-ClientPrefs-GoldKingZ API !");
        return;
    }

    _prefs = api.CreatePrefs<ClientPrefs>(this, new ClientPrefsOptions
    {
        PrefsAPI_CookiesEnable = PrefsAPI_SaveMode.OnPlayerDisconnect,
    });

    if (hotReload)
    {
        _prefs?.Refresh();
    }

}

public override void Unload(bool hotReload)
{
    _prefs?.Unload();
}

3. Use it

if (_prefs?.TryGetValue(player.Slot, out var data) != true) return;

data.ChatMuted = !data.ChatMuted;
data.Volume = 75;

That's it. Changes are tracked automatically and saved on disconnect or map end.

Note: TryGetValue returns false while a player's data is still loading. The player automatically gets a chat message to wait, and another when everything is loaded. Just handle the false return and let the player retry.

🧩 Multiple Isolated Stores

One plugin can register more than one store — call CreatePrefs<T>() once per data class. Each store gets its own table and never shares rows or columns with the others.

private IPrefsStore<ClientPrefs>?    _prefs;
private IPrefsStore<ClientPrefsHud>? _hud;
 
public override void OnAllPluginsLoaded(bool hotReload)
{
    var api = ClientPrefsApi.Get();
    if (api == null) return;
 
    _prefs = api.CreatePrefs<ClientPrefs>(this, new ClientPrefsOptions { /* ... */ });
 
    _hud = api.CreatePrefs<ClientPrefsHud>(this, new ClientPrefsOptions
    {
        PrefsAPI_TableName = "test_hud",   // exact table name on SQLite AND MySQL
    });
}
 
public override void Unload(bool hotReload)
{
    _prefs?.Unload();
    _hud?.Unload();
}

Without PrefsAPI_TableName, each store auto-names its table <FolderName>_<ClassName> — so multiple stores never collide.

⚙️ Configuration Options

📖 API Methods

Read / Write Data (in-memory, instant)

Player Loaded Event

Call it anywhere (a connect event, etc). It fires once per call for the player you pass — it is not a registration. Call it twice = fires twice, you control it. Runs on the game thread.

DataBase (works for OFFLINE players)

Reads cookies + MySQL per this store's config — newest data wins. In <TResult> results, result.Plugin and result.Table tell you which plugin / table each row came from.

Force Save

Drop Player (wipe memory + cookies.db + MySQL)

DropPlayer by steamId works even if the player is offline (deletes from storage). Wipes only the backends this store has enabled.

Lifecycle

🔄 Auto-Migration

You can freely edit your data class at any time. ClientPrefs automatically updates your cookies.db and MySQL table to match — no need to delete the database.

No data loss when adding or removing fields. Changing a field's type or renaming it (drop old + add new) resets that one column to its default — other columns are unaffected. Just edit your data class, rebuild your plugin, and reload.

📂 Folder Structure

After installation:

csgo/
└── addons/counterstrikesharp/
    ├── plugins/
    │   └── ClientPrefs-GoldKingZ/                       ← Core plugin
    │       ├── ClientPrefs-GoldKingZ.dll
    │       ├── ClientPrefs-GoldKingZ.Shared.dll
    │       ├── Microsoft.Data.Sqlite.dll
    │       ├── MySqlConnector.dll
    │       ├── SQLitePCLRaw.batteries_v2.dll
    │       ├── SQLitePCLRaw.core.dll
    │       ├── SQLitePCLRaw.provider.e_sqlite3.dll
    │       ├── e_sqlite3.dll                            ← Native SQLite (Windows)
    │       ├── libe_sqlite3.so                          ← Native SQLite (Linux)
    │       └── lang/
    │           └── en.json                              ← Chat messages
    └── shared/
        └── ClientPrefs-GoldKingZ.Shared/
            └── ClientPrefs-GoldKingZ.Shared.dll         ← API reference for developers

Each consumer plugin gets its own isolated storage inside the core folder:

plugins/
└── ClientPrefs-GoldKingZ/
    ├── YourPlugin/
    │   └── cookies.db                                   ← Created automatically
    └── AnotherPlugin/
        └── cookies.db