Price/squad-js-map-vote
1
0
Fork 0
mirror of https://github.com/AsgardEternal/squad-js-map-vote.git synced 2025-01-23 20:43:52 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update README.MD

Browse Source
This commit is contained in:
Davide Fantino 2022-09-06 14:23:04 +02:00 committed by GitHub
parent 72697007a1
commit b391ded800
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 48 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

84
README.MD
View File

@ -1,38 +1,50 @@
<h2>MapVote</h2> ## MapVote
<p>The <code>MapVote</code> plugin for squad js based on the original version https://github.com/maskedmonkyman/squad-js-map-vote</p> The `MapVote` plugin for squad js based on the original version https://github.com/maskedmonkyman/squad-js-map-vote
<h3>Options</h3> ### Options
<ul><li><h4>minPlayersForVote</h4> #### minPlayersForVote
<h6>Description</h6> ###### Description
<p>The number of players needed on the server for a vote to start.</p> The number of players needed on the server for a vote to start.
<h6>Default</h6> ###### Default
<pre><code>30</code></pre></li> ```
<li><h4>voteWaitTimeFromMatchStart</h4> 30
<h6>Description</h6> ```
<p>The time in mins from the start of a round to the start of a new map vote.</p> #### voteWaitTimeFromMatchStart
<h6>Default</h6> ###### Description
<pre><code>10</code></pre></li> The time in mins from the start of a round to the start of a new map vote.
<li><h4>voteBroadcastInterval</h4> ###### Default
<h6>Description</h6> ```
<p>The broadcast interval for vote notification in mins.</p> 10
<h6>Default</h6> ```
<pre><code>7</code></pre></li> #### voteBroadcastInterval
<li><h4>automaticSeedingMode</h4> ###### Description
<h6>Description</h6> The broadcast interval for vote notification in mins.
<p>The set a seeding layer if server has less than 20 players.</p> ###### Default
<h6>Default</h6> ```
<pre><code>true</code></pre></li> 7
<li><h4>gamemodeWhitelist</h4> ```
<h6>Description</h6> #### automaticSeedingMode
<p>The random layer list will be generated with only selected gamemodes.</p> ###### Description
<h6>Default</h6> Set a seeding layer if server has less than 20 players.
<pre><code>[ "AAS", "RAAS", "INVASION" ]</code></pre></li> ###### Default
<li><h4>layerLevelBlacklist</h4> ```json
<h6>Description</h6> true
<p>The random layer list will not include the blacklisted layers or levels. (acceptable formats: Gorodok/Gorodok_RAAS/Gorodok_AAS_v1).</p> ```
<h6>Default</h6> #### gamemodeWhitelist
<pre><code>[]</code></pre></li> ###### Description
<h3>Example configuration</h3> The random layer list will be generated with only selected gamemodes.
```json{ ###### 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
"plugin": "MapVote", "plugin": "MapVote",
"enabled": true, "enabled": true,
"minPlayersForVote": 30, "minPlayersForVote": 30,
@ -43,4 +55,4 @@
"gamemodeWhitelist": [ "AAS", "RAAS", "Invasion" ], "gamemodeWhitelist": [ "AAS", "RAAS", "Invasion" ],
"layerLevelBlacklist": [ "BlackCoast_Seed" ] "layerLevelBlacklist": [ "BlackCoast_Seed" ]
} }
``` ```