Help and docs for the new commands
- /help is sent as a few messages (Discord caps an embed at 6000 characters), with a test for the limits - command reference, features, self-hosting, beta and getting-started pages describe the commands; the SQL section is gone - development and contributing: every setting needs a command Co-Authored-By: Claude Sonnet 5.5 <[email protected]>
This commit is contained in:
1 parent
132a2cd986
commit
30cbd9a798
11 files changed
+289
-175
No files matched your search
+14
-28
@@ -8,7 +8,7 @@ You will run:
|
||||
- **PostgreSQL**, started by the same Compose file.
|
||||
- Optionally **Lavalink**, if you want music.
|
||||
|
||||
The hosted Velox also has a web dashboard. It is proprietary and not part of this repository, so it is not something you can host. You do not need it. See [Settings without a dashboard](#settings-without-a-dashboard).
|
||||
The hosted Velox also has a web dashboard. It is proprietary and not part of this repository, so it is not something you can host, and you do not need it: everything it does is also a command. See [Everything is a command](#everything-is-a-command).
|
||||
|
||||
## Before you start
|
||||
|
||||
@@ -154,38 +154,24 @@ Run it on a schedule and keep copies off the server. To restore into an empty da
|
||||
|
||||
Discord requires you to **verify** your application once the bot is in 100 servers, and to be approved for the privileged intents (Server Members, Message Content). Plan for that if you intend to run a public bot. For a bot in a few servers you manage yourself, nothing is needed.
|
||||
|
||||
## Settings without a dashboard
|
||||
## Everything is a command
|
||||
|
||||
The bot works fully on its own, and every command in the [Command reference](commands.md) does. Most things are set with slash commands. A few settings that the hosted Velox sets on its dashboard have no command, so you set them in the database. They are plain rows, described in `schema.sql`.
|
||||
The bot is complete on its own: every setting and every action is a slash command, and nothing needs a web dashboard. The [Command reference](commands.md) lists them all. The ones you will want first:
|
||||
|
||||
**Security thresholds and filters.** The defaults are in `security_settings`. To change a server's settings, insert or update its row (the columns are documented in `schema.sql`, and invalid values are refused):
|
||||
- **Modules:** `/security toggle`, `/tickets setup`, `/slvl toggle`, `/music toggle`, `/config enablelogging`, `/config toggletwitch`.
|
||||
- **Seeing what is set:** `/security settings`, `/tickets settings`, `/slvl status`, `/config view`.
|
||||
- **Tuning security:** `/security joingate`, `words`, `raid`, `antinuke` and `heat` change every threshold, filter and action (owner or trusted users only).
|
||||
- **The beta program:** the bot's owner sets it up in a direct message with the bot, see below.
|
||||
|
||||
```sql
|
||||
INSERT INTO security_settings (guild_id, raid_join_count, raid_join_seconds)
|
||||
VALUES (123456789012345678, 15, 10)
|
||||
ON CONFLICT (guild_id) DO UPDATE
|
||||
SET raid_join_count = EXCLUDED.raid_join_count, raid_join_seconds = EXCLUDED.raid_join_seconds;
|
||||
### Setting up beta features
|
||||
|
||||
Beta features are off until you choose a beta server and a Beta Tester role. As the owner of the Discord application, open a **direct message** with your bot and run:
|
||||
|
||||
```
|
||||
/beta set server-id:<the server's ID> role-id:<the role's ID>
|
||||
```
|
||||
|
||||
Protections are switched on with `/security toggle`, not with SQL.
|
||||
|
||||
**Beta features.** Beta features are off until you choose a beta server and a Beta Tester role. Run this once, with your own IDs (the bot reads it every 30 seconds):
|
||||
|
||||
```sql
|
||||
INSERT INTO beta_settings (id, guild_id, role_id) VALUES (TRUE, 123456789012345678, 234567890123456789)
|
||||
ON CONFLICT (id) DO UPDATE SET guild_id = EXCLUDED.guild_id, role_id = EXCLUDED.role_id;
|
||||
```
|
||||
|
||||
To let another server's beta features on, add it (its owner's agreement is yours to arrange):
|
||||
|
||||
```sql
|
||||
INSERT INTO beta_guilds (guild_id, enabled_by) VALUES (345678901234567890, 123456789012345678)
|
||||
ON CONFLICT DO NOTHING;
|
||||
```
|
||||
|
||||
See [Beta features](beta-features.md) for what this does.
|
||||
|
||||
**Queue and panel requests.** The `*_commands` tables let another program ask the bot to skip a song, post the ticket panel or end a raid. See [Database](database.md#dashboard-to-bot-settings-and-requests) if you want to build something on them.
|
||||
(In Discord, turn on Developer Mode, then right-click the server or role and choose Copy ID.) `/beta status` shows the result, `/beta off` turns the beta off, `/beta servers` lists the servers that opted in. A server's owner opts the server in with `/config beta-features`. The bot reads the change within 30 seconds. See [Beta features](beta-features.md).
|
||||
|
||||
## Making it your own
|
||||
|
||||
|
||||
Reference in new issue
Block a user