CrimsonClans

Server side only extension mod for the Clan system.

Features:

Limit Clans to X number of Castle Hearts
Limit Users to X number of Castle Hearts
Limit ability to do clan operations (join, create, leave, kick, edit, invite, etc) during raid window
Limit ability to do clan operations prior and after the raid window (raid buffers)
Add a cooldown to joining clans after leaving one

Installation

Install BepInEx
Install VAMP
Install VCF
Extract CrimsonClans.dll into (VRising server folder)/BepInEx/plugins
Start server to generate the config file, modify it, and restart server

Config

[General]

## If true, the mod will manage the hearts per clan system. Please set the server setting to a higher value than HeartsPerClan or have server limit by user.
# Setting type: Boolean
# Default value: false
ToggleHeartsPerClan = true

## The amount of castle hearts a clan can have.
# Setting type: Int32
# Default value: 1
HeartsPerClan = 2

## If true, the mod will manage the hearts per user system. Please set the server setting to a higher value than HeartsPerUser or have server limit by clan.
# Setting type: Boolean
# Default value: false
ToggleHeartsPerUser = false

## The amount of castle hearts a user can have.
# Setting type: Int32
# Default value: 1
HeartsPerUser = 1


[Raid Time - Buffers]

## The number of minutes prior to the raid window to lock clan operation.
# Setting type: Int32
# Default value: 30
PreRaidBufferMins = 30

## The number of minutes past the raid window to lock clan operation.
# Setting type: Int32
# Default value: 0
PostRaidBufferMins = 0


[Raid Time - Ability Locks]

## If this is set to true, clans will be unable to invite players to their clan during raid time.
# Setting type: Boolean
# Default value: true
Invite = true

## If this is set to true, clans will be unable to be created during raid time.
# Setting type: Boolean
# Default value: true
Create = false

## If this is set to true, clans will be unable to change their details during raid time.
# Setting type: Boolean
# Default value: true
Edit = false

## If this is set to true, clans will be unable to kick players from the clan during raid time.
# Setting type: Boolean
# Default value: false
Kick = false

## If this is set to true, players will be unable to leave clans during raid time.
# Setting type: Boolean
# Default value: false
Leave = false


[Cooldowns]

## The number of minutes that a player must wait to join a clan after leaving a prior clan.
# Setting type: Int32
# Default value: 0
JoinCooldown = 0

## If this is set to true, being kicked from a clan will apply a join cooldown to a player as if they left the clan on their own.
# Setting type: Boolean
# Default value: false
KickCooldown = false

ModTalk Support

Each of these ModTalk functions take no input and return a bool based on if that functionality is currently locked.

CrimsonClans.IsInviteLocked CrimsonClans.IsCreateLocked CrimsonClans.IsLeaveLocked CrimsonClans.IsKickLocked CrimsonClans.IsEditLocked

Usage Example

bool isInviteLocked = false;
bool handled = ModTalk.Invoke("CrimsonClans.IsInviteLocked", null, result => 
            {
                isInviteLocked = (bool)result;
            });