> For the complete documentation index, see [llms.txt](https://dreamliner.gitbook.io/dreamliner-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dreamliner.gitbook.io/dreamliner-docs/readme.md).
# Dreamliner
**A Discord moderation & server-management bot.** YAML config, slash commands, no dashboard required.
Inspired by [Zeppelin](https://github.com/ZeppelinBot/Zeppelin). Configure your server by downloading a template, editing it, and uploading it back.
***
## π Invite
[**β Add Dreamliner to your server**](https://discord.com/oauth2/authorize?client_id=1524053555114151946\&permissions=1099932494934\&scope=bot%20applications.commands)
> Recommended permissions are pre-selected. See [Permissions setup](/dreamliner-docs/docs/permissions.md) for what each one is for. Dreamliner does **not** need Administrator.
***
## β‘ Quick start
1. **Invite** Dreamliner with the link above
2. Run **`/config template`** (needs **Manage Server**)
3. Edit the YAML: set channels and plugins (levels can also be set later with `/permissions`)
4. Run **`/config upload`** with your file
5. Youβre live. Use **`/permissions`** to grant commands / set levels without re-uploading, and **`/help`** anytime
Full walkthrough: [Getting started](/dreamliner-docs/docs/getting-started.md)
***
## β¨ Features
### π§° Core
| Plugin | What it does |
| --------------- | ----------------------------------------------------------------------------------- |
| **Utility** | Search, user/server/channel info, clean, voice tools, avatar, jumbo, help, and more |
| **Infractions** | Warn, note, mute, kick, ban, softban, case management, DMs, expirations |
### π‘οΈ Moderation
| Plugin | What it does |
| ------------ | ---------------------------------------------------- |
| **Automod** | Duplicate messages, rate limits, raid detection |
| **Censor** | Word/phrase filters with configurable actions |
| **Admin** | Channel lockdown & unlock |
| **Persist** | Sticky messages that stay at the bottom of a channel |
| **Slowmode** | Per-channel slowmode control |
### π Roles
| Plugin | What it does |
| ------------------------ | ---------------------------------- |
| **Roles** | Give / remove / list roles |
| **Reaction roles** | React to a message to claim a role |
| **Role buttons** | Button-based role assignment |
| **Self grantable roles** | Self-serve role panels |
| **Pingable roles** | Temporarily make roles mentionable |
| **Role manager** | Role templates for quick creation |
| **Autorole** | Auto-assign roles on join |
### π€ Automation
| Plugin | What it does |
| ---------------------- | ---------------------------------------- |
| **Welcome message** | Custom join messages |
| **Tags** | Reusable text snippets |
| **Scheduled posts** | Timed / recurring channel posts |
| **Autodelete** | Auto-clear messages after a delay |
| **Autoreactions** | React automatically to matching messages |
| **Reminders** | Personal reminders |
| **Counters** | Live member / message / custom counters |
| **Companion channels** | Personal voice channels from a hub |
### π Tracking
| Plugin | What it does |
| ------------------ | ------------------------------------ |
| **Name history** | Track nickname / username changes |
| **Username saver** | Persist username history |
| **Locate user** | Find where a member is (voice, etc.) |
| **Stats** | Server, user, and channel stats |
### π¨ Customization & extras
| Plugin | What it does |
| ------------------- | --------------------------------- |
| **Custom events** | Hook actions to Discord events |
| **Command aliases** | Shortcuts and message triggers |
| **Starboard** | Highlight highly reacted messages |
| **Logs** | Server & moderation event logging |
Plus **per-server emoji prefixes** (success, error, neutral, warning, unchecked) and **level-based permissions** with `can_*` overrides.
***
## π Documentation
| Guide | Description |
| ---------------------------------------------------------------- | ------------------------------------ |
| [π Docs home](broken://pages/ScBf0pRjbQl3XDFHSAMa) | Full documentation index |
| [π¦ Getting started](/dreamliner-docs/docs/getting-started.md) | Invite β template β upload |
| [βοΈ Configuration](/dreamliner-docs/docs/configuration.md) | YAML format, emojis, logs, plugins |
| [π Permissions](/dreamliner-docs/docs/permissions.md) | Bot perms, levels, and `can_*` flags |
| [π Terms of Service](/dreamliner-docs/docs/terms-of-service.md) | Rules for using Dreamliner |
| [π Privacy Policy](/dreamliner-docs/docs/privacy-policy.md) | What data we process and why |
| [π Deploy on PebbleHost](broken://pages/35OV3jidArtV9N2lZzKa) | Easiest hosting on PebbleHost panel |
| [π₯οΈ Deploy to Hetzner](broken://pages/Fe4xJ4XK98WTUFL8umoV) | VPS with auto-deploy on push |
### Plugin docs
Core
* [Utility](/dreamliner-docs/docs/plugins/utility.md)
* [Infractions](/dreamliner-docs/docs/plugins/infraction.md)
Moderation
* [Automod](/dreamliner-docs/docs/plugins/automod.md)
* [Censor](/dreamliner-docs/docs/plugins/censor.md)
* [Admin](/dreamliner-docs/docs/plugins/admin.md)
* [Persist](/dreamliner-docs/docs/plugins/persist.md)
* [Slowmode](/dreamliner-docs/docs/plugins/slowmode.md)
Roles
* [Roles](/dreamliner-docs/docs/plugins/roles.md)
* [Reaction roles](/dreamliner-docs/docs/plugins/reaction_roles.md)
* [Role buttons](/dreamliner-docs/docs/plugins/role_buttons.md)
* [Self grantable roles](/dreamliner-docs/docs/plugins/self_grantable_roles.md)
* [Pingable roles](/dreamliner-docs/docs/plugins/pingable_roles.md)
* [Role manager](/dreamliner-docs/docs/plugins/role_manager.md)
* [Autorole](/dreamliner-docs/docs/plugins/autorole.md)
Automation
* [Welcome message](/dreamliner-docs/docs/plugins/welcome_message.md)
* [Tags](/dreamliner-docs/docs/plugins/tags.md)
* [Scheduled posts](/dreamliner-docs/docs/plugins/post.md)
* [Autodelete](/dreamliner-docs/docs/plugins/autodelete.md)
* [Autoreactions](/dreamliner-docs/docs/plugins/autoreactions.md)
* [Reminders](/dreamliner-docs/docs/plugins/reminders.md)
* [Counters](/dreamliner-docs/docs/plugins/counters.md)
* [Companion channels](/dreamliner-docs/docs/plugins/companion_channels.md)
Tracking & customization
* [Name history](/dreamliner-docs/docs/plugins/name_history.md)
* [Username saver](/dreamliner-docs/docs/plugins/username_saver.md)
* [Locate user](/dreamliner-docs/docs/plugins/locate_user.md)
* [Stats](/dreamliner-docs/docs/plugins/stats.md)
* [Custom events](/dreamliner-docs/docs/plugins/custom_events.md)
* [Command aliases](/dreamliner-docs/docs/plugins/command_aliases.md)
* [Dreamcode commands](https://github.com/Clawb1t/Dreamliner/tree/main/docs/plugins/dream_commands.md) β custom slash commands ([language docs](https://github.com/Clawb1t/Dreamliner/tree/main/docs/dreamcode/README.md))
* [Starboard](/dreamliner-docs/docs/plugins/starboard.md)
* [Logs](/dreamliner-docs/docs/plugins/logs.md)
***
## π‘ Why Dreamliner?
* π **File-based config:** download, edit, upload; your YAML is the source of truth
* π **Fine-grained access:** levels + per-command `can_*` flags
* βοΈ **Slash-first UX:** management and Dreamcode custom commands are slash-only
* 𧩠**Plugin architecture:** enable only what your server needs
***
## βοΈ Legal
* [Terms of Service](/dreamliner-docs/docs/terms-of-service.md)
* [Privacy Policy](/dreamliner-docs/docs/privacy-policy.md)
***
## π License
MIT
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://dreamliner.gitbook.io/dreamliner-docs/readme.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.