squad-js-map-vote/README.MD

100 lines
2.5 KiB
Plaintext
Raw Normal View History

2022-09-06 07:23:04 -05:00
## 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 restart` - Restarts voting with 6 random maps and modes
- `!vote broadcast` - Broadcasts current voting results - happens every 7m automatically
##### 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 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
2022-09-06 07:23:04 -05:00
### Options
#### commandPrefix
###### Description
The command name to use in chat.
###### Default
```
!vote
```
2022-09-06 07:23:04 -05:00
#### minPlayersForVote
###### Description
The number of players needed on the server for a vote to start.
###### Default
```
40
2022-09-06 07:23:04 -05:00
```
#### voteWaitTimeFromMatchStart
###### Description
The time in mins from the start of a round to the start of a new map vote.
###### Default
```
15
2022-09-06 07:23:04 -05:00
```
#### voteBroadcastInterval
###### Description
The broadcast interval for vote notification in mins.
###### Default
```
7
```
#### automaticSeedingMode
###### Description
Set a seeding layer if server has less than 20 players.
###### Default
```json
true
```
#### numberRecentMapsToExlude
###### Description
The random layer list will not include the X recent maps
###### Default
```
4
```
2022-09-06 07:23:04 -05:00
#### gamemodeWhitelist
###### Description
The random layer list will be generated with only selected gamemodes.
###### Default
```json
[ "AAS", "RAAS", "INVASION" ]
```
#### layerLevelBlacklist
###### Description
The random layer list will not include the blacklisted layers or levels. (acceptable formats: Gorodok/Gorodok_RAAS/Gorodok_AAS_v1).
###### Default
```
[]
```
### Example configuration
```json
2022-09-06 07:23:48 -05:00
{
2022-09-06 07:13:23 -05:00
"plugin": "MapVote",
"enabled": true,
"minPlayersForVote": 30,
"voteWaitTimeFromMatchStart": 10,
"voteBroadcastInterval": 7,
"numberRecentMapsToExlude": 4,
"automaticSeedingMode": true,
"gamemodeWhitelist": [ "AAS", "RAAS", "Invasion" ],
"layerLevelBlacklist": [ "BlackCoast_Seed" ]
}
2022-09-06 07:23:04 -05:00
```