📝 complementary informations on configuration file

This commit is contained in:
Aymeric GUERACAGUE 2022-07-01 00:44:00 +02:00
parent bf9496c9f6
commit 711974bfbb
Signed by: Superkooka
GPG Key ID: F78F2B172E894865
2 changed files with 24 additions and 0 deletions

View File

@ -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.

View File

@ -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"