Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tehgm/einherjibot
Personal administration bot for Discord
https://github.com/tehgm/einherjibot
bot discord discord-bot
Last synced: 15 days ago
JSON representation
Personal administration bot for Discord
- Host: GitHub
- URL: https://github.com/tehgm/einherjibot
- Owner: TehGM
- License: apache-2.0
- Created: 2019-05-05T13:12:59.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-03T23:33:30.000Z (almost 2 years ago)
- Last Synced: 2024-05-01T16:43:38.669Z (8 months ago)
- Topics: bot, discord, discord-bot
- Language: C#
- Homepage:
- Size: 1.35 MB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Einherji Bot
[](https://github.com/TehGM/EinherjiBot) [](LICENSE) [](https://github.com/TehGM/EinherjiBot/actions) [](https://github.com/TehGM/EinherjiBot/issues)
Einherji is my private Discord administration bot. It mainly contains features that are useful to me or my friends.
Einherji is built using .NET Core Hosting approach, making use of its Dependency Injection container, Logging abstractions and configuration loading.
Uses [Discord.Net](https://github.com/discord-net/Discord.Net) for connection and MongoDB (using [C# MongoDB Driver](https://docs.mongodb.com/drivers/csharp)) for storage.
The bot contains a custom Regex Commands System built on top of [Discord.Net](https://discord.foxbot.me/stable/guides/commands/intro.html)'s default command system. Its implementation can be found in [CommandsProcessing](https://github.com/TehGM/EinherjiBot/tree/master/EinherjiBot.Core/CommandsProcessing) directory.
The bot is split into 2 projects:
- EinherjiBot.General - contains bot's main features.
- EinherjiBot.Core - contains extensions and core abstractions.
## Running locally
> Note: requires [.NET 5 SDK](https://dotnet.microsoft.com/download/dotnet/5.0) since version 2.3.0.
1. Clone this repository to get all files.
2. Set up MongoDB database with following collections: `Miscellaneous`, `StellarisMods`, `PatchbotGames`, `EliteCommunityGoals` and `UsersData`.
3. Create `appsecrets.json` file. See [example file](appsecrets-example.json) for example structure.
This file will hold secrets, so it should not be included in source control repository. `.gitignore` file included with this repo will ignore `appsecrets.json` and `appsecrets.*.json` files.
4. Add bot token from Discord Developer Portal to secrets file.
5. Add MongoDB connection string for your DB to secrets file.
6. *(optional)* If using DataDog for logs, create a following section in `appsecrets.json`, replacying `` with your DataDog application API key:
```json
"Serilog": {
"DataDog": {
"ApiKey": ""
}
}
```
7. *(optional)* If you're registered with Inara API, create a following section in `appsecrets.json`, replacing all tags as needed. Note: not prividing these values will disable Elite Dangerous Community Goals checker feature.
```json
"EliteCommunityGoals": {
"InaraAppInDevelopment": true,
"InaraAppName": "",
"InaraApiKey": ""
}
```
8. Update [appsettings.json](EinherjiBot.General/appsettings.json). At very least, all channel, user and role IDs will need changing to match values in your Discord guild.
9. Build and run `EinherjiBot.General` project.
## Development
This bot is under continuous (if sometimes slow) development. Breaking changes might be introduced at any time.
If you spot a bug or want to suggest a feature or improvement, feel free to open a new [Issue](https://github.com/TehGM/EinherjiBot/issues).
## License
Copyright (c) 2020 TehGM
Licensed under [Apache License 2.0](LICENSE).