Skip to content

Commit

Permalink
Add toml type info for the config file (#145)
Browse files Browse the repository at this point in the history 
Co-authored-by: Nicolas Paul <[email protected]>
  • Loading branch information
@AiroPi @ncs-pl
AiroPi and ncs-pl authored Mar 23, 2024
1 parent f5b2eb5 commit 3559f2b
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions .github/CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -165,16 +165,16 @@ First, a `.env` file with the following values:


Then, create a `config.toml` ([TOML](https://toml.io/en/)) with the following values:
| Key | Description |
|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------|
| `support_guild_id` | The bot needs to be member and administrator of this guild |
| `bot_id` | Used for top.gg (if enabled) |
| `bot_name` | Used for the webhook logs |
| `owners_ids` | Grant permissions to these users (e.g. eval command, extensions reloading...) reload... |
| `translator_services` | A list of translations services to enable. Names will be imported from [`cogs.translate.adapters`](/src/cogs/translate/adapters/) |
| `extensions` | A list of extensions to enable. Names will be imported from [`cogs`](/src/cogs/) |

## Extra informations
| Key | Type | Description |
|-----------------------|------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
| `support_guild_id` | [Integer](https://toml.io/en/v1.0.0#integer) | The bot needs to be member and administrator of this guild |
| `bot_id` | [Integer](https://toml.io/en/v1.0.0#integer) | Used for top.gg (if enabled) |
| `bot_name` | [String](https://toml.io/en/v1.0.0#string) | Used for the webhook logs |
| `owners_ids` | [Array](https://toml.io/en/v1.0.0#array) of [Integer](https://toml.io/en/v1.0.0#integer) | Grant permissions to these users (e.g. eval command, extensions reloading...) |
| `translator_services` | [Array](https://toml.io/en/v1.0.0#array) of [String](https://toml.io/en/v1.0.0#string) | A list of translations services to enable. Names will be imported from [`cogs.translate.adapters`](/src/cogs/translate/adapters/) |
| `extensions` | [Array](https://toml.io/en/v1.0.0#array) of [String](https://toml.io/en/v1.0.0#string) | A list of extensions to enable. Names will be imported from [`cogs`](/src/cogs/) |

## Extra information

In the project structure, `main.py` serves as the entry point executed by Docker. It provides a compact CLI application with various options that can be used with pre-created shell files in the `bin/` directory.
`mybot.py` is the base of MyBot, containing the `MyBot` class, instantiated once at launch and available in many places in the code.
Expand Down

0 comments on commit 3559f2b

Please sign in to comment.