Configuration Guide - a-h-i/progress-bot GitHub Wiki
Bot configuration is handled via the config command.
The default bot prefix is $. To list the config sub commands do $help config.
For an interactive mode guided config that covers the basics use the command $config by following the bot's instructions you would define the following
- Prefix
- Starting Level
- Starting Gold
- Retirement Level
- Character Creation Roles
- Reward Roles
- Config Roles
There are more variables that can be configured but the interactive mode covers the absolute basics required for basic functionality.
Listing the current configuration
Use $config --list
Simple Variables
| Name | Description | Default Value |
|---|---|---|
| Prefix | The bot's prefix. Only commands that start with this prefix will be read by the bot. | $ |
| Starting Level | A number between 1 and 20 inclusive. It is the default starting character level when using the register command | 1 |
| Starting gold | Default starting gold when using the reward command. | 0 |
| retirement level | Any character that is retired and is below this level is deleted | 20 |
Prefix sub command
Use $config --prefix to have the bot show the current prefix. To set the prefix to say s/ or any other string use $config --prefix s/
Starting Level sub command
use $config --starting-level to show the current starting level. To set it use $config --starting-level 10
Starting gold sub command
Use $config --starting-gold to show the current starting gold. To set it use $config --starting-gold 100.5
Retirement Level sub command
use $config --retirement-level to show the current retirement level. To set it use $config --retirement-level 15
Roles
There are three role groups defined.
- Character Creation
- Reward Roles
- Config Roles
The same role may appear in more than one group. It is also important to note that server admins and owner can run any command regardless of roles.
Character Creation
This role group covers the use of commands related to creating new characters. The roles that are allowed to approve new character sheets/ add new characters
Reward Roles
This role group usually covers the DM roles. These roles are able to reward characters with xp and gold. They also accumulate DM rewards and are able to consume their dm rewards by transferring them to their own characters.
Config Roles
This can be thought of as a bot admin role. This role is allowed to set and change configuration values, including which roles are in which role group.
Role management sub commands
The following sub commands are used to manage role groups
--character-creation-add-roles
--character-creation-list-roles
--character-creation-remove-roles
--reward-add-roles
--reward-list-roles
--reward-remove-roles
--config-add-roles
--config-list-roles
--config-remove-roles
They all function in the same way. List sub commands are used without any additional arguments. such as $config --config-list-roles
To add one or more roles you can use $config --reward-add-roles @Role1 @Role2. You must actually mention the roles
To remove a role use $config --character-creation-remove-roles @Role1 @Role5
Add and remove commands can be used with one or more roles.
Mentions throughout the bot commands of roles or users must be actual mentions.
Reward Formulas
The following sub commands are used.
--reward-formulas-list
--reward-formulas-add
--reward-formulas-remove
Refer to the separate guide here for a guide on using formulas.