MapVote

The MapVote plugin for squad js based on the original version https://github.com/maskedmonkyman/squad-js-map-vote

Commands

User Commands

• !vote help - sends possbile commands to a player in the from of a warning
• !vote choices - sends choices to player in the from of a warning
• !vote results - sends player the results in a warning

Admin Commands

• !vote start - Starts a vote with 6 layers, random modes
• !vote cancel - Cancels current round of voting
• !vote cancelauto - Cancel scheduled automatic start of vote
• !vote end - Gently ends the current vote and announces the winner layer
• !vote restart - Restarts voting with 6 random maps and modes
• !vote broadcast - Broadcasts current voting results - happens every 7m automatically
• !vote endmatch - Ends the current match

Vote by modes

• !vote start *_raas - Starts a vote with 6 layers, all RAAS
• !vote start *_aas - Starts a vote with 6 layers, all AAS
• !vote start *_inv - Starts a vote with 6 layers, all INV

Vote by faction

• !vote start f:rus - Starts a vote with 6 layers, all with RUS faction
• !vote start f:aus - Starts a vote with 6 layers, all with AUS faction
• !vote start f:mea f:caf f:usa - Starts a vote with 3 layers, 1 with MEA faction, 1 with CAF faction and 1 with USA faction

Vote by map

• !vote start yeh gor lash gor albas - Starts a vote with X maps, random modes

Vote by map + mode, mixed

• !vote start yeh_raas gor_raas lash_inv gor albas_inv - Starts a vote with X maps, X modes

Options

commandPrefix

Description

The command name to use in chat.

Default

!vote

entryFormat

Description

The format of an entry in the voting list.

Default

"{map_name} {gamemode} {map_version} {factions} {main_assets}"

entriesAmount

Description

Amount of entries generated for automatic votes.

Default

6

automaticVoteStart

Description

A map vote will automatically start after a new match if set to true.

Default

true

votingDuration

Description

How long the voting will be active (in minutes). Set to 0 for unlimited time.

Default

0

minPlayersForVote

Description

The number of players needed on the server for a vote to start.

Default

40

voteWaitTimeFromMatchStart

Description

The time in mins from the start of a round to the start of a new map vote.

Default

15

voteBroadcastInterval

Description

The broadcast interval for vote notification in mins.

Default

7

automaticSeedingMode

Description

Instantly change to a seeding layer if server has less than 5 players and set next layer to a seeding layer if server has less than 20 players.

Default

true

numberRecentMapsToExlude

Description

The random layer list will not include the X recent maps

Default

4

gamemodeWhitelist

Description

The random layer list will be generated with only selected gamemodes.

Default

[ "AAS", "RAAS", "INVASION" ]

layerFilteringMode

Description

Select Whitelist mode or Blacklist mode.

Default

"blacklist"

layerLevelWhitelist

Description

The random layer list will include ONLY the whitelisted layers or levels. (acceptable formats: Gorodok/Gorodok_RAAS/Gorodok_AAS_v1).

Default

[]

layerLevelBlacklist

Description

The random layer list will NOT include the blacklisted layers or levels. (acceptable formats: Gorodok/Gorodok_RAAS/Gorodok_AAS_v1).

Default

[]

applyBlacklistToWhitelist

Description

If set to true the blacklisted layers will be filtered out also in whitelist mode.

Default

true

factionsBlacklist

Description

factions to exclude in map vote. ( ex: ['CAF'] )

Default

[]

minGamemodeEntries

Description

Minimum amount layers in the vote list per gamemode.

Default

{
    "raas": 2,
    "aas": 2,
    "invasion": 0
}

hideVotesCount

Description

Hides the number of votes a layer received in broadcast message.

Default

false

showRerollOption

Description

vote option to restart the vote with random entries.

Default

false

showRerollOptionInCustomVotes

Description

Enables/disables the reroll option only in custom votes. showRerollOption must be set to true.

Default

false

voteBroadcastMessage

Description

Message that is sent as broadcast to announce a vote.

Default

"✯ MAPVOTE ✯\nVote for the next map by writing in chat the corresponding number!"

voteWinnerBroadcastMessage

Description

Message that is sent as broadcast to announce the winning layer.

Default

"✯ MAPVOTE ✯\nThe winning layer is\n\n"

showWinnerBroadcastMessage

Description

Enables the broadcast at the end of the voting.

Default

true

allowedSameMapEntries

Description

Allowed max NUMBER of times a map could appear in the vote list.

Default

1

logToDiscord

Description

Enables/disables vote logging to Discord.

Default

false

channelID

Description

The ID of the channel to log votes to.

Default

"112233445566778899"

persistentDataFile

Description

Path to file in which to store important data that should be restored after a restart.

Important

Make sure the persistent data file is not inside the plugin folder.

Default

""

timezone

Description

Timezone relative to UTC time. 0 for UTC, 2 for CEST (UTC+2), -1 (UTC-1)

Default

0

timeFrames

Description

Array of timeframes that allows to override options based on local time. See example configuration

Default

[]

minimumVotesToAcceptResult

Description

Minimum votes per map to accept result.

Can be used to prevent situation when insignificant number of players decide what map should be next, but most still wants to play map according to rotation.

Default

1

seedingGameMode

Description

Gamemode used in seeding mode.

Default

"Seed"

instantSeedingModePlayerCount

Description

Required player count to trigger an instant layer change to a seeding layer.

Default

5

nextLayerSeedingModePlayerCount

Description

Required player count to change the next layer to a seeding layer.

Default

20

Timeframe format

{
    name: "friendly name", // a friendly name visible in the logs
    start: "12:00", // timeframe start time <hour>:<minutes>
    end: "18:00", // timeframe end time <hour>:<minutes>
    overrides: { // options to override
        automaticVoteStart: false,
        layerLevelBlacklist: [ "Anvil", "Chora" ]
    }
}

Example configuration

{
    "plugin": "MapVote",
    "enabled": true,
    "discordClient": "discord",
    "entriesAmount": 6,
    "entryFormat": "{map_name} {gamemode} {map_version} {factions} {main_assets}",
    "automaticVoteStart": true,
    "votingDuration": 0,
    "minPlayersForVote": 30,
    "voteWaitTimeFromMatchStart": 10,
    "voteBroadcastInterval": 7,
    "numberRecentMapsToExlude": 4,
    "automaticSeedingMode": true,
    "gamemodeWhitelist": [ "AAS", "RAAS", "Invasion" ],
    "layerLevelBlacklist": [ "BlackCoast_Seed" ],
    "layerLevelWhitelist": [ "Yeho", "Gorodok", "Mutaha", "Narva", "Tallil" ],
    "applyBlacklistToWhitelist": true,
    "factionsBlacklist": [ "CAF", "INS" ],
    "hideVotesCount": false,
    "showRerollOption": true,
    "showRerollOptionInCustomVotes": false,
    "voteBroadcastMessage": "✯ MAPVOTE ✯\nVote for the next map by writing in chat the corresponding number!",
    "voteWinnerBroadcastMessage": "✯ MAPVOTE ✯\nThe winning layer is\n\n",
    "showWinnerBroadcastMessage": true,
    "allowedSameMapEntries": 1,
    "logToDiscord": true,
    "channelID": "112233445566778899",
    "persistentDataFile": "",
    "timezone": 2,
    "minimumVotesToAcceptResult": 1,
    "instantSeedingModePlayerCount": 5,
    "nextLayerSeedingModePlayerCount": 20,
    "seedingGameMode": "Seed",
    "minGamemodeEntries": {
        "raas": 2,
        "aas": 2,
        "invasion": 0
    },
    "timeFrames": [
        {
            "name": "follow layer rotation list",
            "start": "12:00",
            "end": "18:00",
            "overrides": {
                "automaticVoteStart": false
            }
        },
        {
            "start": "22:00",
            "end": "02:00",
            "overrides": {
                "voteBroadcastMessage": "Late night games? Vote your favourite map!"
            }
        }
    ]
}