VIPCore is a VIP management framework for SwiftlyS2 CS2 servers. It provides database-backed VIP groups, a shared API for feature modules, and a menu-driven experience so VIP players can enable/disable features that your server grants them.
- SwiftlyS2 for Counter-Strike 2
- A database supported by VIPCore migrations (VIPCore uses FluentMigrator + Dapper)
- The Cookies plugin (used to persist per-player feature preferences)
- Database-backed VIP management with FluentMigrator + Dapper
- Modular feature system - easily extend with custom VIP features
- Group-based permissions with per-feature configuration
- Cookie system for saving player preferences
- Interactive menu system for VIP players
- Hot-reload support for configuration changes
- Copy the published
VIPCoreplugin folder to your server:(swRoot)/plugins/VIPCore/ - Ensure the plugin has its
resources/folder alongsideVIPCore.dll. - Ensure
VIPCore.Contract.dllis present at:(swRoot)/plugins/VIPCore/resources/exports/ - Configure
vip_groups.jsoncandconfig.jsoncin your SwiftlyS2 configs folder. - Restart the server.
| Command | Permission | Description |
|---|---|---|
vip | Player | Opens the VIP menu for the current player. |
vip_manage | vipcore.manage | Opens the VIP management menu (in-game). |
vip_adduser <steamid> <group> <time> | vipcore.adduser | Adds a SteamID to a VIP group for a duration based on TimeMode. Use 0 for permanent. |
vip_deleteuser <steamid> | vipcore.deleteuser | Removes VIP status for a SteamID. |
Console usage: SwiftlyS2 console commands are typically exposed with the sw_ prefix (for example sw_vip, sw_vip_adduser, etc.).
VIPCore uses two configuration files located in your SwiftlyS2 configs folder.
Controls how VIPCore operates on your server.
Settings explained:
| Setting | What it does | Recommended |
|---|---|---|
Delay | How many seconds to wait after spawn before giving VIP features | 1.0 to 5.0 |
DatabaseConnection | Which database to use for storing VIP data (must exist in SwiftlyS2 config) | "default" |
TimeMode | Time format when adding VIPs via commands | 3 (days) |
VipLogging | Show detailed logs for debugging VIP system issues | true for testing, false for production |
Defines VIP groups and what features each group receives.
Simple example (on/off features only):
{
"vip_groups": {
"Groups": {
"VIP": {
"Weight": 10, // Priority (higher number = more important)"Values": {
"vip.zeus": 1, // 1 = enabled, 0 = disabled"vip.bhop": 1,
"vip.antiflash": 1
}
}
}
}
}Advanced example (features with custom settings):
{
"vip_groups": {
"Groups": {
"VIP": {
"Weight": 10,
"Values": {
"vip.armor": {
"Armor": 100// Give 100 armor points on spawn
},
"vip.health": {
"Health": 120// Give 120 HP on spawn
},
"vip.bhop": {
"Timer": 5.0, // Activate bhop 5 seconds after round start"MaxSpeed": 300.0// Maximum bhop speed
}
}
},
"PREMIUM": {
"Weight": 20, // Higher weight = overrides "VIP" if player has both"Values": {
"vip.armor": {
"Armor": 150
},
"vip.health": {
"Health": 150
},
"vip.bhop": {
"Timer": 3.0,
"MaxSpeed": 350.0
}
}
}
}
}
}How it works:
- Group names (
"VIP","PREMIUM", etc.) can be anything — use them when adding VIPs via commands - Weight = priority level. If a player has multiple VIP groups, the highest weight wins
- Values = features granted to this group
- Feature keys (
"vip.armor","vip.bhop", etc.) must match installed module names
Feature value types:
| Type | Example | Use when |
|---|---|---|
| Simple toggle | "vip.zeus": 1 | Feature has no extra settings (just on/off) |
| With settings | "vip.armor": { "Armor": 100 } | Feature needs customization (amounts, timers, etc.) |
Tip
Module-specific configuration: Each module has its own configuration options and setup instructions. See the Modules directory for detailed documentation on each module's settings.
This repository ships several optional VIP modules (each one is a standalone SwiftlyS2 plugin that registers features into VIPCore):
| Module | Description |
|---|---|
VIP_AntiFlash | Gives flashbang immunity to VIP players |
VIP_Armor | Gives armor and helmet on spawn |
VIP_Bhop | Enables bunnyhop (auto-jump) for players |
VIP_ChatColor | Colored chat names for VIP players |
VIP_DoubleJump | Allows players to jump twice in mid-air |
VIP_FastDefuse | Reduces bomb defuse time |
VIP_FastPlant | Reduces bomb plant time |
VIP_FastReload | Gives instant weapon reloads |
VIP_Fov | Allows customizable field of view |
VIP_GoldMember | Auto-grants VIP to players with specific name tags |
VIP_Health | Gives increased health on spawn |
VIP_Items | Gives configured weapons/items on spawn |
VIP_KillScreen | Applies screen effect on kills |
VIP_Money | Gives money to VIP players |
VIP_NightVip | Grants VIP access during specific hours |
VIP_NoFallDamage | Prevents fall damage |
VIP_RainbowModel | Cycles player model render color (rainbow effect) |
VIP_SmokeColor | Custom smoke grenade colors |
VIP_Speed | Modifies player movement speed |
VIP_Tag | Custom clan tags for players |
VIP_Test | Provides players with a timed trial VIP |
VIP_Vampirism | Heals player by percentage of damage dealt |
VIP_Zeus | Gives Zeus x27 taser on spawn |
VIP modules are standalone SwiftlyS2 plugins that extend VIPCore with custom features (e.g., anti-flash, bhop, FOV, armor, etc.).
The API contract is distributed as a NuGet package: SwiftlyS2.VIPCore.Contract (use Version="*" for latest).
- SwiftlyS2.CS2 NuGet package
- SwiftlyS2.VIPCore.Contract NuGet package
Required dependency: The Cookies plugin must be installed on the server. VIPCore uses it to persist player feature preferences (enable/disable states) across sessions.
VIP_YourFeature/
├── src/
│ └── VIP_YourFeature.cs
├── resources/
│ ├── templates/
│ │ └── template.jsonc (optional — default config for your feature)
│ └── translations/
│ └── en.jsonc (module-specific translations)
├── VIP_YourFeature.csproj
Create VIP_YourFeature.csproj and add the SwiftlyS2.VIPCore.Contract NuGet package:
<ItemGroup>
<PackageReferenceInclude="SwiftlyS2.VIPCore.Contract"Version="*"ExcludeAssets="runtime"PrivateAssets="all" />
</ItemGroup>Note: Use
ExcludeAssets="runtime" PrivateAssets="all"because VIPCore is already loaded on the server at runtime — you only need the contract at compile time.
Create src/VIP_YourFeature.cs:
usingSwiftlyS2.Shared;usingSwiftlyS2.Shared.Players;usingSwiftlyS2.Shared.Plugins;usingSwiftlyS2.Shared.Misc;usingVIPCore.Contract;usingMicrosoft.Extensions.Logging;namespaceVIP_YourFeature;[PluginMetadata(Id="VIP_YourFeature",Version="1.0.0",Name="[VIP] YourFeature",Author="YourName")]publicclassVIP_YourFeature:BasePlugin{privateconststringFeatureKey="vip.yourfeature";privateIVipCoreApiV1?_vipApi;privatebool_isFeatureRegistered;publicVIP_YourFeature(ISwiftlyCorecore):base(core){}// ── 1. Retrieve the VIPCore shared interface ──────────────────────publicoverridevoidUseSharedInterface(IInterfaceManagerinterfaceManager){_vipApi=null;_isFeatureRegistered=false;try{if(interfaceManager.HasSharedInterface("VIPCore.Api.v1"))_vipApi=interfaceManager.GetSharedInterface<IVipCoreApiV1>("VIPCore.Api.v1");RegisterWhenReady();}catch(Exceptionex){Core.Logger.LogWarning("[VIP_YourFeature] Failed to get VIPCore API: {Message}",ex.Message);}}// ── 2. Plugin Load ────────────────────────────────────────────────publicoverridevoidLoad(boolhotReload){// Hook game events, register listeners, etc.RegisterWhenReady();}// ── 3. Register feature (respects VIPCore readiness) ──────────────privatevoidRegisterWhenReady(){if(_vipApi==null)return;if(_vipApi.IsCoreReady())RegisterVipFeatures();else_vipApi.OnCoreReady+=RegisterVipFeatures;}privatevoidRegisterVipFeatures(){if(_vipApi==null||_isFeatureRegistered)return;_vipApi.RegisterFeature(FeatureKey,FeatureType.Toggle,(player,state)=>{Core.Scheduler.NextTick(()=>{player.SendMessage(MessageType.Chat,$"YourFeature: {state}");});},displayNameResolver: p =>Core.Translation.GetPlayerLocalizer(p)["vip.yourfeature"]);_isFeatureRegistered=true;// Subscribe to VIPCore events_vipApi.OnPlayerSpawn+=OnVipPlayerSpawn;_vipApi.PlayerLoaded+=OnVipPlayerLoaded;}// ── 4. Feature logic ──────────────────────────────────────────────privatevoidOnVipPlayerSpawn(IPlayerplayer){if(_vipApi==null||!player.IsValid||player.IsFakeClient)return;if(_vipApi.GetPlayerFeatureState(player,FeatureKey)!=FeatureState.Enabled)return;// Apply your feature effect here}privatevoidOnVipPlayerLoaded(IPlayerplayer,stringgroup){// Called when a VIP player's data is loaded from the database}// ── 5. Cleanup ────────────────────────────────────────────────────publicoverridevoidUnload(){if(_vipApi!=null){_vipApi.OnCoreReady-=RegisterVipFeatures;_vipApi.OnPlayerSpawn-=OnVipPlayerSpawn;_vipApi.PlayerLoaded-=OnVipPlayerLoaded;if(_isFeatureRegistered)_vipApi.UnregisterFeature(FeatureKey);}}}Each module manages its own translations independently. VIPCore's translation file only contains core keys (menu title, VIP status messages, etc.) — module-specific display names and messages must live in the module's own translation file.
Create resources/translations/en.jsonc:
{
"vip.yourfeature": "Your Feature",
"yourfeature.activated": "Your feature has been activated!",
"yourfeature.deactivated": "Your feature has been deactivated."
}The key "vip.yourfeature" is what gets displayed in the VIP menu as the feature name. It is resolved per-player via the displayNameResolver callback you pass during registration:
displayNameResolver: p =>Core.Translation.GetPlayerLocalizer(p)["vip.yourfeature"]This uses SwiftlyS2's built-in translation system — GetPlayerLocalizer(player) automatically resolves the correct language file based on the player's language preference, and it reads from your module'sresources/translations/ folder (not VIPCore's).
To support additional languages, add more translation files:
resources/translations/
├── en.jsonc (English — required)
├── de.jsonc (German)
├── fr.jsonc (French)
└── ru.jsonc (Russian)
Add your feature key to vip_groups.jsonc on the server:
{
"vip_groups": {
"Groups": {
"VIP": {
"Values": {
"vip.yourfeature": 1// 1 = enabled by default, 0 = disabled
}
}
}
}
}For features with extra settings, nest an object instead of a simple value:
{
"vip_groups": {
"Groups": {
"VIP": {
"Values": {
"vip.bhop": {
"Timer": 5.0,
"MaxSpeed": 300.0
}
}
}
}
}
}Then read it in your module with a config class:
publicclassYourFeatureConfig{publicfloatTimer{get;set;}=5.0f;publicfloatMaxSpeed{get;set;}=300.0f;}// In your feature logic:varconfig=_vipApi.GetFeatureValue<YourFeatureConfig>(player,FeatureKey);dotnet build -c ReleaseCopy the build output to your server:
(swRoot)/plugins/VIP_YourFeature/
├── VIP_YourFeature.dll
└── resources/
└── ...
Important:
VIPCore.Contract.dllmust already be present in(swRoot)/plugins/VIPCore/resources/exports/. It ships with VIPCore — you do not need to include it in your module's output.
Restart the server (or hot-reload if supported).
varapi=interfaceManager.GetSharedInterface<IVipCoreApiV1>("VIPCore.Api.v1");- Must be done in the
UseSharedInterface()override - Always check
HasSharedInterface()first to avoid exceptions if VIPCore is not loaded
if(_vipApi.IsCoreReady())RegisterVipFeatures();else_vipApi.OnCoreReady+=RegisterVipFeatures;VIPCore loads its database and config asynchronously. Always check IsCoreReady() before registering, and subscribe to OnCoreReady as a fallback.
- Format:
"vip.featurename"(lowercase, dot-separated) - Must match the key used in
vip_groups.jsonc
| Type | Description |
|---|---|
FeatureType.Toggle | On/off toggle (most common) |
FeatureType.Selectable | Cycles through options when selected in menu |
FeatureType.Hide | Active feature with no menu entry |
Game API calls must run on the main thread. Always wrap them in NextTick:
Core.Scheduler.NextTick(()=>{player.SendMessage(MessageType.Chat,"Hello!");});Persist per-player preferences across sessions:
_vipApi.SetPlayerCookie(player,"vip.yourfeature.value",120);intsaved=_vipApi.GetPlayerCookie<int>(player,"vip.yourfeature.value");// Feature ManagementvoidRegisterFeature(stringfeatureKey,FeatureTypetype,Action<IPlayer,FeatureState>?onSelectItem,Func<IPlayer,string>?displayNameResolver=null);voidUnregisterFeature(stringfeatureKey);IEnumerable<string>GetAllRegisteredFeatures();// Player StateboolIsClientVip(IPlayerplayer);boolPlayerHasFeature(IPlayerplayer,stringfeatureKey);FeatureStateGetPlayerFeatureState(IPlayerplayer,stringfeatureKey);voidSetPlayerFeatureState(IPlayerplayer,stringfeatureKey,FeatureStatenewState);stringGetClientVipGroup(IPlayerplayer);string[]GetVipGroups();// Feature Config (reads from group config JSON and binds to your class)T?GetFeatureValue<T>(IPlayerplayer,stringfeatureKey)whereT:class,new();// Player CookiesTGetPlayerCookie<T>(IPlayerplayer,stringkey);voidSetPlayerCookie<T>(IPlayerplayer,stringkey,Tvalue);// Global TogglevoidDisableAllFeatures();voidEnableAllFeatures();// Core StateboolIsCoreReady();// EventseventAction? OnCoreReady;eventAction<IPlayer,string>?PlayerLoaded;eventAction<IPlayer,string>?PlayerRemoved;eventAction<IPlayer>? OnPlayerSpawn;event Func<IPlayer,string,FeatureState,FeatureType,bool?>?OnPlayerUseFeature;publicenumFeatureState{Enabled=0,// Feature is activeDisabled=1,// Feature is inactive (player toggled off)NoAccess=2// Player doesn't have access to this feature}MIT License
{ "vip": { "Delay": 2.0, // Wait time in seconds before applying VIP features"DatabaseConnection": "default", // Database connection name (from SwiftlyS2 database config)"TimeMode": 3, // Time unit for VIP duration: 0=seconds, 1=minutes, 2=hours, 3=days"VipLogging": true// Enable detailed logs (useful for troubleshooting) } }