AsgardEternal/squad-js-map-vote
1
0
Fork 0
mirror of https://github.com/AsgardEternal/squad-js-map-vote.git synced 2024-09-28 09:34:26 -05: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>
<p>The <code>MapVote</code> plugin for squad js based on the original version https://github.com/maskedmonkyman/squad-js-map-vote</p>
<h3>Options</h3>
<ul><li><h4>minPlayersForVote</h4>
<h6>Description</h6>
<p>The number of players needed on the server for a vote to start.</p>
<h6>Default</h6>
<pre><code>30</code></pre></li>
<li><h4>voteWaitTimeFromMatchStart</h4>
<h6>Description</h6>
<p>The time in mins from the start of a round to the start of a new map vote.</p>
<h6>Default</h6>
<pre><code>10</code></pre></li>
<li><h4>voteBroadcastInterval</h4>
<h6>Description</h6>
<p>The broadcast interval for vote notification in mins.</p>
<h6>Default</h6>
<pre><code>7</code></pre></li>
<li><h4>automaticSeedingMode</h4>
<h6>Description</h6>
<p>The set a seeding layer if server has less than 20 players.</p>
<h6>Default</h6>
<pre><code>true</code></pre></li>
<li><h4>gamemodeWhitelist</h4>
<h6>Description</h6>
<p>The random layer list will be generated with only selected gamemodes.</p>
<h6>Default</h6>
<pre><code>[ "AAS", "RAAS", "INVASION" ]</code></pre></li>
<li><h4>layerLevelBlacklist</h4>
<h6>Description</h6>
<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>
<pre><code>[]</code></pre></li>
<h3>Example configuration</h3>
```json{
## MapVote
The `MapVote` plugin for squad js based on the original version https://github.com/maskedmonkyman/squad-js-map-vote
### Options
#### minPlayersForVote
###### Description
The number of players needed on the server for a vote to start.
###### Default
```
30
```
#### voteWaitTimeFromMatchStart
###### Description
The time in mins from the start of a round to the start of a new map vote.
###### Default
```
10
```
#### 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
```
#### 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
"plugin": "MapVote",
"enabled": true,
"minPlayersForVote": 30,
@ -43,4 +55,4 @@
"gamemodeWhitelist": [ "AAS", "RAAS", "Invasion" ],
"layerLevelBlacklist": [ "BlackCoast_Seed" ]
}
```
```