CS2-CustomVotes is a plugin for Counter-Strike 2 that allows you to easily create preference votes for your server. Create votes with any number of options and let your players decide on the settings of your server.
Every vote options can trigger multiple commands at once allowing for a wide range of possibilities.
- Custom votes with any number of options
- Execute multiple commands per vote option
- Customizable duration for each vote
- Cooldown between votes
- Localized chat messages
- CS2-CustomVotes.Shared API for other plugins to register votes
Metamod:Source (2.x)
CounterStrikeSharp(v191)
- Install Metamod:Source and CounterStrikeSharp
- Place the
addonsfolder in your serversgame/csgo/directory
- Add your custom votes to the config file
3.1. Located at
addons/counterstrikesharp/configs/plugins/CS2-CustomVotes/CS2-CustomVotes.json - Restart your server
{
"CustomVotesEnabled": true, // global enable/disable for custom votes
"VoteCooldown": 60, // cooldown between votes in seconds
"ChatPrefix": "[{DarkBlue}CustomVotes{Default}]", // chat prefix for plugin messages, supports all ChatColors
"ForceStyle": "none", // "none", "center" or "chat" - none will use the style from the vote settings
"CustomVotes": [ // list of custom votes
{
"Command": "cheats", // command to trigger the vote
"CommandAliases": [ // aliases for the command
"sv_cheats"
],
"Description": "Vote to enable sv_cheats", // description of the vote, will be displayed in the vote menu
"TimeToVote": 30, // time in seconds players have to vote
"Options": { // vote options
"Enable": { // name of the option
"Text": "{Green}Enable", // text to display in the vote menu (supports ChatColors when using the "chat" style)
"Commands": [ // commands to execute when the option is selected
"sv_cheats 1"
]
},
"Disable": {
"Text": "{Red}Disable",
"Commands": [
"sv_cheats 0"
]
}
},
"DefaultOption": "Disable", // default option (must be a key from the "Options" object)
"Style": "chat", // Menu style - "center" or "chat" (will be overridden by the global ForceStyle if not "none")
"MinVotePercentage": -1, // minimum percentage of votes required to pass the vote (-1 behaves like 50%)
"Permission": {
"RequiresAll": false, // if true, all permissions must be present to vote
"Permissions": [] // list of permissions required to start this vote (empty list allows everyone to start the vote)
}
}
],
"ConfigVersion": 2
}CS2-CustomVotes provides a shared API for other plugins to register custom votes.
Add a reference to CS2-CustomVotes.Shared to your project in one of the following ways:
- Download the source code and build it yourself
- Download the latest release from the releases page.
- Install the package using the .NET CLI, run:
dotnet add package CS2-CustomVotes.Shared
After adding the reference to your project, you can create custom votes like this:
public interface ICustomVoteApi
{
public void AddCustomVote(string name, string description, string defaultOption, float timeToVote, Dictionary<string, VoteOption> options, string style);
public void AddCustomVote(string name, List<string> aliases, string description, string defaultOption, float timeToVote, Dictionary<string, VoteOption> options, string style);
public void AddCustomVote(string name, string description, string defaultOption, float timeToVote, Dictionary<string, VoteOption> options, string style, int minVotePercentage);
public void AddCustomVote(string name, List<string> aliases, string description, string defaultOption, float timeToVote, Dictionary<string, VoteOption> options, string style, int minVotePercentage);
public void StartCustomVote(CCSPlayerController? player, string name);
public void EndCustomVote(string name);
public void RemoveCustomVote(string name);
}
customVotesApi.AddCustomVote(
"cheats", // command to trigger the vote
new List<string>(), // aliases for the command (optional)
"Vote to enable sv_cheats", // description of the vote, will be displayed in the vote menu
"Disable", // default option (must be a key from the "Options" object)
30, // time in seconds players have to vote
new Dictionary<string, VoteOption> // vote options
{
{ "Enable", new VoteOption("{Green}Enable", new List<string> { "sv_cheats 1" })},
{ "Disable", new VoteOption("{Red}Disable", new List<string> { "sv_cheats 0" })},
},
"chat", // Menu style - "center" or "chat"
-1); // minimum percentage of votes required to pass the vote (-1 behaves like 50%)
customVotesApi.RemoveCustomVote("cheats");