Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/oolunar/tomoe

Tomoe aims to be a helpful quality of life Discord bot.
https://github.com/oolunar/tomoe

bot discord discord-api discord-bot discord-moderation dsharpplus tomoe

Last synced: 8 days ago
JSON representation

Tomoe aims to be a helpful quality of life Discord bot.

Awesome Lists containing this project

README

        

![Code Size](https://img.shields.io/github/languages/code-size/OoLunar/Tomoe?style=for-the-badge&logo=appveyor&color=blueviolet&logo=none)![Lines of Code](https://img.shields.io/tokei/lines/github/OoLunar/Tomoe?style=for-the-badge&logo=appveyor&color=blueviolet&label=Total%20Lines%20of%20Code&logo=none)[![Discord](https://img.shields.io/discord/832354798153236510?style=for-the-badge&color=blueviolet&label=Chat%20On%20Discord&logo=discord)](https://discord.gg/5gm3pUt8Fg)

## Prerequisites

Tomoe uses dotnet 8.0. You can get it from [Microsoft](https://dotnet.microsoft.com/download/dotnet/8.0). Tomoe should work on all OS' that .NET is supported on. Mono is not supported due to DSharpPlus intentionally choosing not to support it.

## Setup
Edit your `res/config.json` file. If you're planning on contributing to the bot, copy the `res/config.json` file to `config.debug.json` and edit that instead.

``` bash
git clone https://github.com/OoLunar/Tomoe.git
cd Tomoe
dotnet build
```

Be sure to edit your config file.

``` bash
dotnet run
```

### Docker

``` bash
docker run ghcr.io/oolunar/tomoe --mount ./res,/src/res
```

### Docker-Compose

Make sure to review the `volumes` section of the `docker-compose.yml` file.

``` bash
docker-compose up -d
```

# Tomoe, The Discord Moderation Bot

## What features does Tomoe have?

As mentioned previously, Tomoe aims to be the #1 bot choice for Discord Moderation. This means that any and all moderation commands that Vortex, Mee6 and Carl can do, Tomoe will try to supplement. Here's the current road map of commands:

| Command | Implemented |
|------------------------ |--------------|
| **Moderation Commands** | - |
| Ban | ❌ |
| Config | ❌ |
| Doctor | ❌ |
| Kick | ❌ |
| Logging | ❌ |
| Modlog | ❌ |
| Mute | ❌ |
| Report | ❌ |
| Strike | ❌ |
| Tempban | ❌ |
| Tempmute | ❌ |
| Tempvoiceban | ❌ |
| Unban | ❌ |
| Unmute | ❌ |
| Unvoiceban | ❌ |
| Voiceban | ❌ |
| **Public commands** | - |
| Bot Info | ✅ |
| Choose | ✅ |
| Echo | ✅ |
| Epoch | ✅ |
| Flip | ✅ |
| GuildIcon | ✅ |
| Hex | ✅ |
| Invite | ✅ |
| Member Count | ✅ |
| Ping | ✅ |
| Profile Picture | ✅ |
| Quote | ✅ |
| Raw | ✅ |
| Reminders | ❌ |
| Repository | ✅ |
| Role Info | ✅ |
| Server Info | ✅ |
| Support | ✅ |
| Tag | ✅ |
| Time Of | ✅ |
| Timestamp | ✅ |

## Why did you chose "Tomoe" as the bots name?

[Kamisama Kiss](https://www.funimation.com/shows/kamisama-kiss/).