Skip to content

Hobby project to create a Discord bot in C#.NET to introduce functionality related to cooking recipes.

License

Notifications You must be signed in to change notification settings

SH-Tang/RecipeBot

Repository files navigation

Quality Gate Status Coverage GitHub last commit .NET

RecipeBot

Alt text

The RecipeBot is intended to provide the following functionality in Discord as a bot:

  • Formatting recipes according to a standardised format
  • Persistence of recipes to allow retrieval based on tags or the type of dish
  • Formatting annotated web recipes according to a standardised format

Realised features

At the moment of writing the bot is capable of:

  • Formatting user recipes according to a standard format
  • Adding tags and category for a recipe
  • Persisting and retrieving recipes

For more information about the commands within the bot, see the Wiki.

Deployment

In order to run the RecipeBot, a config.json file must be created next to the executable with the following content. The minimum content is listed below:

{
    "Token": "{Your Discord token for the Bot}",
    "ConnectionStrings":
    {
        "DefaultConnection": "Data Source={File path to the SQLite database}"
    }
}

Token (mandatory)

This is the Discord token as provided by the Discord Developer portal.

ConnectionString (mandatory)

Key Description
DefaultConnection Set this to the path of the SQLite database to store and retrieve the data from. In case the database does not exist, the database is created by the application.

License

This project was released under the GPLv3 license. A copy of this license can be found here.

About

Hobby project to create a Discord bot in C#.NET to introduce functionality related to cooking recipes.

Topics

Resources

License

Stars

Watchers

Forks

Languages