skytech6-CrimsonKey icon

CrimsonKey

Real-time Advanced Server Whitelist Manager

Last updated a week ago
Total downloads 21
Total rating 1 
Categories Server Mods Oakveil Update
Dependency string skytech6-CrimsonKey-1.0.1
Dependants 0 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack_V_Rising-1.733.2 icon
BepInEx-BepInExPack_V_Rising

BepInEx pack for V Rising. Preconfigured and includes Unity Base DLLs.

Preferred version: 1.733.2
deca-VampireCommandFramework-0.10.2 icon
deca-VampireCommandFramework

Command framework for developers to easily create universal commands for their plugins.

Preferred version: 0.10.2
skytech6-VAMP-1.1.0 icon
skytech6-VAMP

V Rising API Modding Platform

Preferred version: 1.1.0

README

CrimsonKey

CrimsonKey

An advanced real-time whitelist management system for V Rising servers that allows administrators to control player access through commands. Manage whitelisted players, lock/unlock the server, and control who can join using Steam IDs or player names.

Commands

.key Lock [kickNonlisted] Enables whitelist mode. Optional parameter to kick non-whitelisted players.
.key Lock true
.key Unlock Disables whitelist mode.
.key Unlock
.key Add [playerName] Adds a player to the whitelist by their name.
.key Add PlayerName
.key AddId [steamId] Adds a player to the whitelist by their Steam ID.
.key AddId 76561198012345678
.key AddAllOnline Adds all currently online players to the whitelist.
.key AddAllOnline
.key Remove [playerName] Removes a player from the whitelist by their name.
.key Remove PlayerName
.key RemoveId [steamId] Removes a player from the whitelist by their Steam ID.
.key RemoveId 76561198012345678
.key PurgeNonlisted Kicks all online players who are not on the whitelist.
.key PurgeNonlisted
.key Status Shows the current whitelist status and count of whitelisted/non-whitelisted players online.

This will contain the number of AdminAuth capable players as well in whitelisted count.

.key Status
.key Check [playerName] Checks if a player is whitelisted by their name.
.key Check PlayerName
.key CheckId [steamId] Checks if a player is whitelisted by their Steam ID.
.key CheckId 76561198012345678

Installation

  • Install BepInEx
  • Install VAMP
  • Extract CrimsonKey.dll_ into (VRising server folder)/BepInEx/plugins

Config

CrimsonKey.cfg

## Enable or disable the mod
# Setting type: Boolean
# Default value: true
ToggleMod = true

## If true, the whitelist will block non-listed players from joining.
# Setting type: Boolean
# Default value: true
Locked = false

Locked will automatically update when using .key Lock and .key Unlock.

CrimsonKey/whitelist.txt

76561198087654321
76561198098765432
76561198076543210

A list of whitelisted SteamIDs seperated on each line.

This will automatically update the system when edited without requiring server restarting.

Optional Mod Integrations

ModTalk Support

CrimsonKey.IsWhitelisted takes (ulong) steamid returns (bool) whitelist status
bool isWhiteListed = false;
bool handled = ModTalk.Invoke("CrimsonKey.IsWhitelisted", [userData.PlatformId], result => 
            {
                isWhiteListed = (bool)result;
            });

Tech Support

Join my Modding Discord for help with issues or anything modding related!

Support CrimsonMods

Want to support my V Rising Mod development?

Buy/play my games!

Train Your Minibot

Boring Movies FREE TO PLAY

git gud WISHLIST COMING SOON

Donations Accepted

ko-fi

This mod was a paid creation. If you are looking to hire someone to make a mod for any Unity game reach out to me on Discord! (skytech6)


Want to Experience the Best of Crimson?

Join The Cursed Collective V Rising servers to play their exclusive CrimsonMods such as Raid Guard, Shard Wars, and more!