Document self hosting and add command handling by tomgelu · Pull Request #119 · DigitalPulseSoftware/NotaBot

tomgelu · 2026-04-06T21:43:58Z

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>

Equinox4

premier jet, d'autres passages seront nécessaires

Equinox4 · 2026-04-06T23:24:20Z

+- `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`


Suggested change

- Required arguments: `arg`

- Required arguments: `<arg>`

Equinox4 · 2026-04-06T23:25:20Z

+
+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.


are silently ignored
not always true

Equinox4 · 2026-04-06T23:27:52Z

+
+**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.


nor an admin

Equinox4 · 2026-04-06T23:30:08Z

+
+**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.


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.

Equinox4 · 2026-04-06T23:34:07Z

+- 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


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

Equinox4 · 2026-04-06T23:38:56Z

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


(optionally on behalf of a member)

?
no

Equinox4 · 2026-04-06T23:39:30Z

+| 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). |


Equinox4 · 2026-04-06T23:44:33Z

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


Equinox4 · 2026-04-06T23:45:29Z

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


requires same permission as pin

Equinox4 · 2026-04-06T23:46:52Z

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


Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Equinox4 · 2026-04-07T17:05:31Z


 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`


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>

Equinox4 · 2026-04-26T17:24:01Z

why have you created a python file?

Equinox4 · 2026-04-26T17:27:18Z

+
+-- ── Configuration ────────────────────────────────────────────────────────────
+
+local TOKEN        = os.getenv("TEST_BOT_TOKEN")    or ""  -- token of your test bot app


Suggested change

local TOKEN = os.getenv("TEST_BOT_TOKEN") or "" -- token of your test bot app

local TOKEN = os.getenv("TEST_BOT_TOKEN") -- token of your test bot app

Equinox4 · 2026-04-26T17:27:35Z

+local TARGET_USER  = os.getenv("TEST_USER_ID")      or ""  -- a member ID to use as moderation target
+local PREFIX       = os.getenv("BOT_PREFIX")        or "!"
+
+assert(TOKEN ~= "", "TEST_BOT_TOKEN is required — set the env var or paste it above")


Suggested change

assert(TOKEN ~= "", "TEST_BOT_TOKEN is required — set the env var or paste it above")

assert(TOKEN ~= nil, "TEST_BOT_TOKEN is required — set the env var")

Equinox4 · 2026-04-26T17:29:23Z

+
+local TOKEN        = os.getenv("TEST_BOT_TOKEN")    or ""  -- token of your test bot app
+local TARGET_BOT   = os.getenv("TARGET_BOT_ID")     or ""  -- user ID of the NotaBot instance
+local GUILD_ID     = os.getenv("TEST_GUILD_ID")     or ""  -- your server ID


make these variables required as well

Equinox4 · 2026-04-26T17:36:32Z

+
+    -- Print summary
+    print("\n" .. string.rep("─", 60))
+    print(string.format("%-40s %-8s %s", "COMMAND", "RESULT", "RESPONSE"))


can't we use "p()" func here?

Equinox4 · 2026-04-26T17:36:47Z

+        if r.passed then passed = passed + 1 else failed = failed + 1 end
+    end
+    print(string.rep("─", 60))
+    print(string.format("Total: %d passed, %d failed / %d", passed, failed, passed + failed))


docs: add comprehensive README documentation

d2fd1b0

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

View reviewed changes

docs: address PR review comments on README

68ba84c

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

tomgelu requested a review from Equinox4 April 7, 2026 16:51

Equinox4 reviewed Apr 7, 2026

View reviewed changes

chore: readd the direct mention of the bot in the readme

22320c1

tomgelu requested a review from Equinox4 April 8, 2026 15:18

Equinox4 suggested changes Apr 26, 2026

View reviewed changes


		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.

	- 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.

	\| `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). \|

	\| `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. \|


		-- ── Configuration ────────────────────────────────────────────────────────────

		local TOKEN = os.getenv("TEST_BOT_TOKEN") or "" -- token of your test bot app

	assert(TOKEN ~= "", "TEST_BOT_TOKEN is required — set the env var or paste it above")
	assert(TOKEN ~= nil, "TEST_BOT_TOKEN is required — set the env var")

Conversation

tomgelu commented Apr 6, 2026

Uh oh!

Equinox4 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Equinox4 commented Apr 26, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants