📝 complementary informations on configuration file
This commit is contained in:
parent
bf9496c9f6
commit
711974bfbb
|
|
@ -20,6 +20,10 @@ A POC of a Discord bot using the dropdown capability
|
||||||
|
|
||||||
- Sync configuration with currently send picker. `/role-picker create [picker]`, `/role-picker sync [picker]` (if picker is omitted, resync all?)
|
- Sync configuration with currently send picker. `/role-picker create [picker]`, `/role-picker sync [picker]` (if picker is omitted, resync all?)
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
- Configuration file format is [TOML](https://toml.io/en/). It is a minimal configuration file format that's easy to read due to obvious semantics. TOML is designed to map unambiguously to a hash table. TOML should be easy to parse into data structures in a wide variety of languages. Read `src/config.ts` to see all possibilities.
|
||||||
|
|
||||||
## Contributions/License
|
## Contributions/License
|
||||||
|
|
||||||
This project has an AGPLv3 license. This project use the `Sheweny` framework with `discord.js` underlying and `BinaryMuse/toml-node` for configuration parsing.
|
This project has an AGPLv3 license. This project use the `Sheweny` framework with `discord.js` underlying and `BinaryMuse/toml-node` for configuration parsing.
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,20 @@
|
||||||
|
token = "DISCORD TOKEN"
|
||||||
|
|
||||||
|
[roles_picker.PICKER_NAME]
|
||||||
|
|
||||||
|
name = "PICKER NAME"
|
||||||
|
message = "MESSAGE"
|
||||||
|
placeholder = "PLACEHOLDER"
|
||||||
|
multi_select = true
|
||||||
|
|
||||||
|
[[roles_picker.PICKER_NAME.roles]]
|
||||||
|
name = "OPTION NAME"
|
||||||
|
description = "DESCRIPTIOM"
|
||||||
|
role = "ROLE ID"
|
||||||
|
emoji = "EMOJI"
|
||||||
|
|
||||||
|
[[roles_picker.PICKER_NAME.roles]]
|
||||||
|
name = "OPTION NAME"
|
||||||
|
description = "DESCRIPTIOM"
|
||||||
|
role = "ROLE ID"
|
||||||
|
emoji = "EMOJI"
|
||||||
Loading…
Reference in New Issue