Skip to content

Installation

shmitzas edited this page Nov 10, 2026 · 1 revision

Installation

Requirements

  • SwiftlyS2
  • A database connection in SwiftlyS2's configs/database.jsonc — MySQL, MariaDB, PostgreSQL or SQLite
  • Cookies — saves each player's choices in the VIP menu. Without it they reset at every join

Steps

  1. Unzip VIPCore-v<version>.zip from the release into addons/swiftlys2/plugins/.
  2. Make sure configs/database.jsonc has the connection VIPCore should use. VIPCore uses the one named in DatabaseConnection, default default.
  3. Restart the server. The first start creates the tables and an empty vip_groups.jsonc.
  4. Add a group to vip_groups.jsonc — see VIP Groups.
  5. Grant yourself VIP from the server console: vip_adduser <your SteamID64> <group> 0.

An unknown DatabaseConnection uses SwiftlyS2's default connection instead.


Where things are

What Path
Plugin addons/swiftlys2/plugins/VIPCore/
Contract addons/swiftlys2/plugins/VIPCore/resources/exports/VIPCore.Contract.dll — every module binds to it. Keep it
Config addons/swiftlys2/configs/plugins/VIPCore/ — config.jsonc, vip_groups.jsonc, created on first start
Translations addons/swiftlys2/plugins/VIPCore/resources/translations/
Server GUID addons/swiftlys2/data/VIPCore/server_id.txt — keep it when you reinstall: Database
Tables vip_users, vip_servers, __vipcore_version_info, created on first start

Verify

Check Expect
Console at start [VIPCore] Plugin loaded successfully.
Join as a VIP Hello, <name>! You are a <group> player. in chat
!vip as a VIP The VIP menu, on Perks

Modules

Modules-v<version>.zip holds every module, each in its own folder under Modules/. Copy the ones you want into addons/swiftlys2/plugins/, add their features to a group and restart. See Modules.

Clone this wiki locally