updated documentation

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

View File

@ -101,8 +101,22 @@ false
###### Description
Message that is sent as broadcast to announce a vote.
###### 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
```json
@ -118,6 +132,8 @@ Message that is sent as broadcast to announce a vote.
"layerLevelBlacklist": [ "BlackCoast_Seed" ],
"hideVotesCount": 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"
}
```

View File

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