Vote Surrender - Person8880/Shine GitHub Wiki

Overview

The vote surrender plugin allows for customising the concede vote with extra options.

This plugin makes use of the built in concede vote, it does not create a separate vote. Therefore, anyone using the NS2 X menu to concede will have their vote go through this plugin instead.

Config

The default config file should look something like this:

{
    "AllowVoteWithMultipleBases": true,
    "LastCommandStructureMinHealthFraction": 0,
    "MinPlayers": 6,
    "FractionOfPlayersNeeded": 0.75,
    "FractionOfPlayersNeededInEarlyGame": 0,
    "SkipSequence": false,
    "VoteDelayInMinutes": 10,
    "VoteSettings": {
      "AFKTimeInSeconds": 60,
      "ConsiderAFKPlayersInVotes": true
    },
    "VoteTimeoutInSeconds": 120,
    "__Version": "1.6"
}

The file should be called “VoteSurrender.json” and should be placed in the directory defined as your plugin config directory (default is config://shine/plugins).

Option	Description
AllowVoteWithMultipleBases	If false, then a surrender vote can only be cast if the team has only 1 tech point.
LastCommandStructureMinHealthFraction	Sets the fraction of health (between 0 and 1, 1 = 100%) that the last command structure must be greater-equal to allow a vote.
MinPlayers	Determines how many players must be on a team in order for a player to start a surrender vote.
FractionOfPlayersNeeded	Determines the fraction of players on a team needing to vote to surrender for it to pass.
FractionOfPlayersNeededInEarlyGame	Determines the fraction of players on a team needing to vote to surrender for it to pass at the start of a round (up to VoteDelayInMinutes minutes after the round starts). A value of 0 disables voting during this time.
SkipSequence	Sets whether to skip the concede sequence when a vote passes.
VoteDelayInMinutes	Determines how long after a round start (in minutes) players must wait before being able to start a surrender vote.
VoteSettings	Allows for controlling whether AFK players are considered in votes. Set ConsiderAFKPlayersInVotes to false to prevent AFK players from counting towards the total votes. AFKTimeInSeconds controls how long a player should be AFK before they are no longer counted.
VoteTimeoutInSeconds	After this many seconds with no votes, the vote count is reset to 0 if it never passed.

Commands

Command	Chat Command	Arguments	Description
sh_votesurrender	!surrender or !votesurrender or !surrendervote	N/A	Votes to surrender the game.