Skip to content

Document self hosting and add command handling#119

Open
tomgelu wants to merge 1 commit intoDigitalPulseSoftware:masterfrom
tomgelu:docs/readme
Open

Document self hosting and add command handling#119
tomgelu wants to merge 1 commit intoDigitalPulseSoftware:masterfrom
tomgelu:docs/readme

Conversation

@tomgelu
Copy link
Copy Markdown

@tomgelu tomgelu commented Apr 6, 2026

Document all modules, commands, configuration options and bot behavior.

Document all modules, commands, configuration options and bot behavior.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copy link
Copy Markdown
Contributor

@Equinox4 Equinox4 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

premier jet, d'autres passages seront nécessaires


Commands are triggered by:
- A prefix (configurable per server, default `!`), e.g. `!ban @user`
- Or a direct mention of the bot, e.g. `@NotaBot ban @user`
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Or a direct mention of the bot, e.g. `@NotaBot ban @user`

- `help` — lists all commands you have access to. Use `help <command>` for details on a specific command. Results are paginated with Previous/Next buttons.

**Argument syntax:**
- Required arguments: `arg`
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Required arguments: `arg`
- Required arguments: `<arg>`


Most moderation commands are **silent** — they delete your invoking message after running.

**Permission checks** are per-command. Users without the required role or Discord permission are silently ignored.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are silently ignored
not always true


**Notes:**
- Bans are tracked with expiration times. The bot automatically unbans when the duration expires.
- You cannot ban someone with a higher or equal role than yours.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nor an admin


**Notes:**
- The bot automatically sets the mute role permissions on all text and voice channels (denies send messages, add reactions, speak).
- If a muted user leaves and rejoins, the mute role is reapplied.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- If a muted user leaves and rejoins, the mute role is reapplied.
- If a muted user leaves and rejoins the guild, the mute role is reapplied.


| Command | Usage | Description |
|---|---|---|
| `newticket` | `newticket [member] [message]` | Opens a modmail ticket (optionally on behalf of a member). |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(optionally on behalf of a member)

?
no

| Command | Usage | Description |
|---|---|---|
| `newticket` | `newticket [member] [message]` | Opens a modmail ticket (optionally on behalf of a member). |
| `modticket` | `modticket <member> [message]` | Opens a ticket for a member (staff only). |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

incorrect


| Command | Usage | Description |
|---|---|---|
| `prune` | `prune <count>` | Deletes the last N messages (max 100, no older than 14 days). |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `prune` | `prune <count>` | Deletes the last N messages (max 100, no older than 14 days). |
| `prune` | `prune <count>` | Deletes the last N messages (no older than 14 days). |

| Command | Usage | Description |
|---|---|---|
| `pin` | `pin <messageId>` | Pins a message. Requires Manage Messages or channel ownership. |
| `unpin` | `unpin <messageId>` | Unpins a message. |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

requires same permission as pin


| Command | Usage | Description |
|---|---|---|
| `sendmessage` | `sendmessage [channel] [content]` | Sends a message (or opens an interactive editor) as the bot. |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `sendmessage` | `sendmessage [channel] [content]` | Sends a message (or opens an interactive editor) as the bot. |
| `sendmessage` | `sendmessage [channel] [content]` | Sends a message as the bot. |

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants