Kurumi

KO | EN

gitlite — search

#hacktoberfest #typescript #go #android #machine-learning #deep-learning #java #nodejs #kubernetes #security #openai #ios #mcp #open-source

(★ 10)

Discord bot for browsing and downloading doujinshi

Kurumi Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<!--
 Copyright (c) 2018-2019 chiya.dev

This software is released under the MIT License.
 https://opensource.org/licenses/MIT
-->

# Kurumi ![Build status](https://ci.appveyor.com/api/projects/status/vtdjarua2c9i0k5t?svg=true)

**Version 3.4 (Heresta)** — Discord bot for searching and downloading doujinshi.

![Kurumi](https://raw.githubusercontent.com/Kadantte/Kurumi/master/Kurumi-sama.png)

## Commands

All commands use Discord slash commands. Type `/` in Discord to see available commands.

### Doujinshi

- `/doujin get source id` — Displays doujin information from a source by its ID.
- `/doujin get-url url` — Displays doujin information from a URL.
- `/doujin browse source` — Browse all doujins from a source.
- `/doujin search query` — Searches for doujins by tags and title.
- `/doujin download source id` — Sends a download link for a doujin.
- `/doujin read source id` — Read a doujin in Discord.

### Collection management

- `/collection list` — Lists all collections belonging to you.
- `/collection view name` — Displays doujins belonging to a collection.
- `/collection add name source id` — Adds a doujin to a collection.
- `/collection remove name source id` — Removes a doujin from a collection.
- `/collection sort name sort` — Sorts doujins in a collection.
- `/collection delete name` — Deletes a collection.

### Feed channels (Admin)

- `/feed add-tag tag` — Adds a tag to the feed channel whitelist.
- `/feed remove-tag tag` — Removes a tag from the feed channel whitelist.
- `/feed mode mode` — Sets the feed channel matching mode.

### Settings (Admin)

- `/settings language language` — Sets the bot language for the server.

### Help

- `/help` — Shows help information.
- `/debug` — Shows debug and diagnostic information.

### Sources

- nhentai — `https://nhentai.net/`
- hitomi — `https://hitomi.la/`

## Running Kurumi

### Requirements

- [.NET 8 SDK](https://dotnet.microsoft.com/download/dotnet/8.0) or higher.
- For development: a C# IDE with intellisense and syntax highlighting, such as [Visual Studio Code](https://code.visualstudio.com/) or [JetBrains Rider](https://www.jetbrains.com/rider/).

### Building

Create a file named `appsettings.Development.json` alongside `appsettings.json`. Then paste the following code, replacing the token string with your own:

```json
{
  "Discord": {
    "Token": "YOUR_BOT_TOKEN_HERE",
    "TestGuildId": 123456789012345678
  },
  "ConnectionStrings": {
    "nhitomi": "Server=localhost;Database=nhitomi;User=root;Password=password;"
  }
}
```

Then run the following commands:

1. `dotnet restore` — resolves NuGet dependencies.
2. `dotnet build` — builds the bot.
3. `dotnet run --project nhitomi` — runs the bot.

### Docker

```bash
docker build -t nhitomi .
docker run -e Discord__Token=YOUR_TOKEN nhitomi
```

## Project Structure

```text
Kurumi/
├── nhitomi/                    # Main Discord bot application
│   ├── Discord/                # Discord client, event handlers, services
│   ├── Modules/                # Slash command modules (DoujinModule, CollectionModule, etc.)
│   ├── Interactivity/          # Interactive message system
│   ├── Globalization/          # Localization resources
│   ├── Startup.cs              # Dependency injection configuration
│   └── Program.cs              # Application entry point
├── nhitomi.Core/               # Core library (models, clients, database)
│   ├── Clients/                # Source site clients (nhentai, hitomi)
│   └── *.cs                    # Models, database context, utilities
├── nhitomi.Core.UnitTests/     # Unit tests
├── AI/                         # Claude Code analysis and task files
├── Dockerfile                  # Docker build configuration
└── nhitomi.sln                 # Visual Studio solution file
```

### Build Outputs

Build artifacts are generated in `bin/` and `obj/` directories within each project folder. These are excluded from version control via `.gitignore`.

## Architecture

The bot follows a layered architecture:

1. **Discord Layer** (`nhitomi/Discord/`): Handles Discord events, message/reaction handlers
2. **Command Layer** (`nhitomi/Modules/`): Slash command modules using Discord.Net Interactions
3. **Interactive Layer** (`nhitomi/Interactivity/`): Manages interactive embed messages with reactions
4. **Core Layer** (`nhitomi.Core/`): Business logic, source clients, data models
5. **Data Layer** (`nhitomi.Core/`): Entity Framework Core with MySQL/SQLite

## License

This project is licensed under the [MIT license](https://opensource.org/licenses/MIT). Please see the [LICENSE](LICENSE) file for more information.

Kurumi

Kurumi Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Kurumi

Kurumi Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README