Important
This is a work in progress!
Elsa-Mina is a Showdown Chat Bot used in the French Room and in several private rooms.
- Custom commands
- Badge system
- User profiles
- Games (Connect Four, Guessing Game)
- Repeats
- Room Dashboard
- Teams Sharing
The bot is written in C# and utilizes .NET 8. Docker is employed for deployment.
The project structure is as follows:
- ElsaMina.Core: Contains the primary bot logic, the WebSocket client, resource files, and multiple services utilized in commands.
- Dependencies: Autofac for Dependency Injection (DI), Newtonsoft for JSON serialization, Serilog for logging, RazorLight for Razor HTML templates, and Websocket.Client for the WebSocket connection.
- References: ElsaMina.DataAccess
- ElsaMina.DataAccess: Contains the classes used to connect to a PostgreSQL database.
- Dependencies: EF Core, PostgreSQL driver
- ElsaMina.Commands: Contains commands.
- Dependencies: CSharp.Scripting for scripting
- References: ElsaMina.Core
- ElsaMina.Console: Main entry point of the program, contains configuration files.
- References: ElsaMina.Core, ElsaMina.Commands
For htmlboxes and htmlpages, HTML is rendered via Razor Templates using Razor Light.
Templates are stored in the Commands project. They are copied to the Templates directory at build time and pre-compiled on startup.
The bot connects to a PostgreSQL database for data persistence. EF Core is used for the ORM. To modify the database, the following commands are utilized:
dotnet ef migrations add <Migration Name> # Creates a new migration
dotnet ef database update <Migration Name> # Applies a migration to an existing databaseDifferent environments can be configured using an environment variable named ELSA_MINA_ENV, which is set to either dev or prod.
To run the bot, create a dev.config.json and a prod.config.json file in the Config directory of the Console project and fill in the details.
Repeat the same process in the DataAccess project with a dev.dbconfig.json file and a prod.dbconfig.json file.