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

updated documentation

Browse Source
This commit is contained in:
Davide Fantino 2022-09-16 23:36:48 +02:00
parent be0463988c
commit 0e0d6a5ae8
2 changed files with 21 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.MD
View File

@ -101,8 +101,22 @@ false
###### Description ###### Description
Message that is sent as broadcast to announce a vote. Message that is sent as broadcast to announce a vote.
###### Default ###### Default
```json
"✯ MAPVOTE ✯ Vote for the next map by writing in chat the corresponding number!"
``` ```
✯ MAPVOTE ✯ Vote for the next map by writing in chat the corresponding number! #### logToDiscord
###### Description
Enables/disables vote logging to Discord.
###### Default
```json
false
```
#### channelID
###### Description
The ID of the channel to log votes to..
###### Default
```json
"112233445566778899"
``` ```
### Example configuration ### Example configuration
```json ```json
@ -118,6 +132,8 @@ Message that is sent as broadcast to announce a vote.
"layerLevelBlacklist": [ "BlackCoast_Seed" ], "layerLevelBlacklist": [ "BlackCoast_Seed" ],
"hideVotesCount": false, "hideVotesCount": false,
"showRerollOption": false, "showRerollOption": false,
"voteBroadcastMessage": "✯ MAPVOTE ✯ Vote for the next map by writing in chat the corresponding number!" "voteBroadcastMessage": "✯ MAPVOTE ✯ Vote for the next map by writing in chat the corresponding number!",
"logToDiscord": false,
"channelID": "112233445566778899"
} }
``` ```

6
mapvote.js
View File

@ -98,7 +98,7 @@ export default class MapVote extends BasePlugin {
}, },
logToDiscord: { logToDiscord: {
required: false, required: false,
description: 'Log votes to Discord', description: 'Enables/disables vote logging to Discord',
default: false default: false
}, },
...DiscordBasePlugin.optionsSpecification, ...DiscordBasePlugin.optionsSpecification,
@ -106,7 +106,7 @@ export default class MapVote extends BasePlugin {
required: false, required: false,
description: 'The ID of the channel to log votes to.', description: 'The ID of the channel to log votes to.',
default: '', default: '',
example: '667741905228136459' example: '112233445566778899'
} }
}; };
} }
@ -605,7 +605,7 @@ export default class MapVote extends BasePlugin {
await this.broadcast(nominationStrings.join("\n")); await this.broadcast(nominationStrings.join("\n"));
if (this.firstBroadcast) if (this.firstBroadcast)
await this.logVoteToDiscord(nominationStrings.join("\n")) this.logVoteToDiscord(nominationStrings.join("\n"))
this.firstBroadcast = false; this.firstBroadcast = false;
} }
//const winners = this.currentWinners; //const winners = this.currentWinners;