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

https://github.com/pardeike/brrainzbot

Friendly Discord onboarding and spam defense bot on .NET 10
https://github.com/pardeike/brrainzbot

Last synced: 3 months ago
JSON representation

Friendly Discord onboarding and spam defense bot on .NET 10

Awesome Lists containing this project

README

          

# BrrainzBot

BrrainzBot robot

BrrainzBot is a self-hosted Discord bot with one core job and one optional one:

- let real people in without public welcome clutter
- clean up common spam before it spreads

It is built for admins who want plain setup, plain docs, and calm day-to-day behavior.

## Quick Start

1. Read the [Discord setup guide](docs/discord-setup.md).
2. Run `brrainzbot setup`.
3. If you left `MEMBER` blank, run `brrainzbot create-member `.
4. Run `brrainzbot doctor`.
5. Turn one server on with `brrainzbot enable `.
6. Run `brrainzbot run`.

If you add another server later, run `brrainzbot add`.

If you only manage one server, `brrainzbot enable` and `brrainzbot disable` also work without an ID.

If you want the exact Discord invite link without using the portal generator:

```bash
brrainzbot invite-url
```

## What It Does

### Onboarding

- this is the core feature
- keeps the welcome flow inside `#welcome`
- uses one persistent welcome post, a button, and short prompts
- replies privately instead of cluttering public chat
- promotes approved users into normal server access

### Spam cleanup

- optional per server
- watches a honeypot channel
- catches near-duplicate spam bursts
- deletes spam around the trigger window

## Core Commands

```bash
brrainzbot setup
brrainzbot add
brrainzbot doctor
brrainzbot status
brrainzbot enable
brrainzbot disable
brrainzbot invite-url []
brrainzbot create-member
brrainzbot set-members
brrainzbot run
brrainzbot print-config
brrainzbot self-update
```

## Docs

- [Home](https://bot.brrai.nz/)
- [Installation](docs/installation.md)
- [Discord setup](docs/discord-setup.md)
- [Configuration](docs/configuration.md)
- [OpenAI-compatible endpoints](docs/openai-compatible.md)
- [Operations](docs/operations.md)

## Development

```bash
dotnet build
dotnet test
```

The docs site uses MkDocs Material:

```bash
pip install -r docs/requirements.txt
mkdocs serve
```

## License

MIT