https://github.com/nanoframework/nfbot
🛠Discord bot for nanoFramework Discord server
https://github.com/nanoframework/nfbot
Last synced: about 1 year ago
JSON representation
🛠Discord bot for nanoFramework Discord server
- Host: GitHub
- URL: https://github.com/nanoframework/nfbot
- Owner: nanoframework
- License: mit
- Created: 2020-08-17T20:05:48.000Z (almost 6 years ago)
- Default Branch: develop
- Last Pushed: 2022-12-08T11:17:43.000Z (over 3 years ago)
- Last Synced: 2025-04-10T17:39:35.399Z (over 1 year ago)
- Language: C#
- Homepage: https://www.nanoframework.net
- Size: 120 KB
- Stars: 3
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
### Welcome to the **nanoFramework** nFBot repository!
nFBot is the **nanoFramework** Discord bot used for various operations including FAQ tagging.
## Configuration
nFBot is configured by the `config.json` which is included with default values. You may also refer to the `config.example.json` file in the case that you need to see the original values of elements.
- `prefix` - This property defines the prefix users must use to call commands on the bot. Mentioning the bot is also considered a valid prefix.
- `debug_token` - This does not have to be configured in production environments. When the bot built in Debug mode, this value will be used to connect the bot to Discord. In Release builds, this value will be pulled from the Azure environment as `token`.
- `status_text` - This is the text to display as "Playing" on Discord.
- `welcome_message` - This is the text sent via DM to the user when they join the server.
- `admin_role_id` - This is the Discord Snowflake ID representing the role assigned to users who have access to administrative operations on the bot, such as shutting it down.
- `storage_mode` - This sets what mode to use for storing data. The `debug_storage_connection_string` property in Debug builds and `storage_connection_string` environment variable in Release builds will be used to connect to the specified storage mode, and therefore this value must be defined properly. Valid values for this configuration option are as follows: `mysql`, `mssql`
- `debug_storage_connection_string` - This does not have to be configured in production environments. When the bot built in Debug mode, this value will be used as the connection string for the `storage_mode`. In Release builds, this value will be pulled from the Azure environment as `storage_connection_string`.
## Deployment
The nFBot is designed to be deployed on Azure as a continuous WebJob.
## License
The **nanoFramework** nFBot is licensed under the [MIT license](LICENSE.md).
## Code of Conduct
This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community.
For more information see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).
### .NET Foundation
This project is supported by the [.NET Foundation](https://dotnetfoundation.org).