This repository was archived by the owner on Feb 27, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6
Config.yml
Devin Fritz edited this page Sep 26, 2020
·
11 revisions
Config.yml
This is the page for my config.yml. Its a key value system. If you don't know what the types mean, here is a rough explanation.
- Boolean: True/False
- String: Any kind of text. Starts with " and ends with "
- Number: A number
- Enum: A number of options you can select
Storing
| Key | Type | Value |
|---|---|---|
| UseSQL | Boolean | Whether the Plugin should use a Database for storing data or a file |
| SQL_USER | String | The username for the database |
| SQL_PASSWORD | String | The password for the database |
| SQL_DATABASE | String | The database where the tables will be created |
| SQL_HOST | String | The host for the database |
| SQL_PORT | String/Number | The port for the database |
| USE_DISCORDSRV | Boolean | Whether the plugin should also register the user in the discordsrv database, this requires the bukkit version on the srv server |
| Global Settings | ||
| Key | Type | Value |
| :--- | :---: | ---: |
| Prefix | String | The prefix the plugin should use for ingame messages |
| Bot-Token | String | The token which is needed for the bot |
| discordBotActivityType | Enum | Here can be used: listening/playing/streaming/watching this inits what should be displayed in the bots info |
| streamingLink | String | This is needed if you decide for the activitytype streaming |
| verifycommand | String | Here you can set what command is needed ingame to manage the plugin |
| Bot-Token | String | The token which is needed for the bot |
| syncNickName | Boolean | Here you can set if the bots should sync the ingamenames with the discord username |
| useTokens | Boolean | Here you can set if the plugin should use tokens or names for the discord roles (leave false if you don't know what it means) |
| verifyRole | String/Number | Here you can set the role a user will get when he verifies himself |
| channelID | String/Number | Here you can set the channel the bot should watch for commands |
| commandPrefix | String | Whatever should be the prefix of a discord command. |
| deleteMessages | Number | How many seconds the bot will wait until it deletes a command (-1 for nor delete). |
| cancelJoinEvent | Boolean | If the plugin should cancel the database process when another plugin cancels the join event. |
| autoUpdateOnJoin | Boolean | If the bot should update a discordusers roles when he joins the mc server |
| permissedRole | String | The role which should have access to the discord admin commands. |