Document self hosting and add command handling#119
Open
tomgelu wants to merge 4 commits intoDigitalPulseSoftware:masterfrom
Open
Document self hosting and add command handling#119tomgelu wants to merge 4 commits intoDigitalPulseSoftware:masterfrom
tomgelu wants to merge 4 commits intoDigitalPulseSoftware:masterfrom
Conversation
Document all modules, commands, configuration options and bot behavior. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Equinox4
suggested changes
Apr 6, 2026
Contributor
Equinox4
left a comment
Equinox4
left a comment
There was a problem hiding this comment.
premier jet, d'autres passages seront nécessaires
README.md
Outdated
| - `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` |
Contributor
There was a problem hiding this comment.
Suggested change
| - Required arguments: `arg` | |
| - Required arguments: `<arg>` |
README.md
Outdated
|
|
||
| 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. |
Contributor
There was a problem hiding this comment.
are silently ignored
not always true
README.md
Outdated
|
|
||
| **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. |
README.md
Outdated
|
|
||
| **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. |
Contributor
There was a problem hiding this comment.
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. |
README.md
Outdated
Comment on lines
+206
to
+217
| - Default: 10 joins in 5 seconds triggers a 10-minute lock. | ||
|
|
||
| **Spam score detection:** | ||
| - Each message receives a score based on content: | ||
| - Base: **+1** per message | ||
| - **+1** per spam keyword (`nitro`, `free`, `crypto`, `steam`, `discord`, etc.) | ||
| - **+1** if a spam hint is present (`gift`, `bitcoin`, `airdrop`, etc.) | ||
| - **+1** per unique user ping | ||
| - **×2** for `@everyone`, `@here`, or role pings | ||
| - **×2** for non-Discord external links | ||
| - **+1** for each channel switch | ||
| - Score compounds for repeated content |
Contributor
There was a problem hiding this comment.
no really needs for describing the algo and keywords in the readme, it is subject to change
Suggested change
| - Default: 10 joins in 5 seconds triggers a 10-minute lock. | |
| **Spam score detection:** | |
| - Each message receives a score based on content: | |
| - Base: **+1** per message | |
| - **+1** per spam keyword (`nitro`, `free`, `crypto`, `steam`, `discord`, etc.) | |
| - **+1** if a spam hint is present (`gift`, `bitcoin`, `airdrop`, etc.) | |
| - **+1** per unique user ping | |
| - **×2** for `@everyone`, `@here`, or role pings | |
| - **×2** for non-Discord external links | |
| - **+1** for each channel switch | |
| - Score compounds for repeated content |
README.md
Outdated
|
|
||
| | Command | Usage | Description | | ||
| |---|---|---| | ||
| | `newticket` | `newticket [member] [message]` | Opens a modmail ticket (optionally on behalf of a member). | |
Contributor
There was a problem hiding this comment.
(optionally on behalf of a member)
?
no
README.md
Outdated
| | 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). | |
README.md
Outdated
|
|
||
| | Command | Usage | Description | | ||
| |---|---|---| | ||
| | `prune` | `prune <count>` | Deletes the last N messages (max 100, no older than 14 days). | |
Contributor
There was a problem hiding this comment.
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). | |
README.md
Outdated
| | Command | Usage | Description | | ||
| |---|---|---| | ||
| | `pin` | `pin <messageId>` | Pins a message. Requires Manage Messages or channel ownership. | | ||
| | `unpin` | `unpin <messageId>` | Unpins a message. | |
Contributor
There was a problem hiding this comment.
requires same permission as pin
README.md
Outdated
|
|
||
| | Command | Usage | Description | | ||
| |---|---|---| | ||
| | `sendmessage` | `sendmessage [channel] [content]` | Sends a message (or opens an interactive editor) as the bot. | |
Contributor
There was a problem hiding this comment.
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. | |
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Equinox4
reviewed
Apr 7, 2026
README.md
Outdated
|
|
||
| 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` |
Contributor
There was a problem hiding this comment.
du coup on peut remettre ceci, my bad
- bot.lua: add messageContent privileged gateway intent so the bot can read message content (required since Discord API v10) - test_bot.lua: Lua test bot using Discordia to validate documented commands - test_bot.py: Python test bot (discord.py) used to run the command suite (requires TEST_BOT_TOKEN, TARGET_BOT_ID, TEST_GUILD_ID, TEST_CHANNEL_ID, TEST_USER_ID env vars or fill in the CONFIG section) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Document all modules, commands, configuration options and bot behavior.