|
|
|
|
|
|
5
|
## Usage
|
5
|
## Usage
|
|
6
|
|
6
|
|
|
7
|
* To see the list of commands, type `$rb_help`.
|
7
|
* To see the list of commands, type `$rb_help`.
|
|
8
|
-* To get help on a specific command, type `$rb_help command` (don't prefix the command name you want help on)
|
|
|
|
9
|
-* To get help on a command group, type `$rb_help group`
|
|
|
|
10
|
-* To get help on a subcommand in a group, type `$rb_help group command`
|
|
|
|
11
|
-* To see if the bot is alive, type `$rb_hello`
|
|
|
|
|
|
8
|
+* To get help on a specific command, type `$rb_help commandname` (don't prefix the command name you want help on). E.g. `$rb_help hello`.
|
|
|
|
9
|
+* To get help on a command group, type `$rb_help groupname`. E.g. `$rb_help config`.
|
|
|
|
10
|
+* To get help on a subcommand in a group, type `$rb_help groupname commandname`. E.g. `$rb_help config setwarningchannel`.
|
|
|
|
11
|
+* To see if the bot is alive, type `$rb_hello`.
|
|
|
|
12
|
+* Other commands are too numerous and always changing to document here, so see `$rb_help` for more.
|
|
12
|
|
13
|
|
|
13
|
## Setup
|
14
|
## Setup
|
|
14
|
|
15
|
|
|
15
|
-Currently the bot is just run in the console locally. It blocks until Ctrl+C is pressed. Before running, you must copy config.py.sample to config.py and fill in the "client_token" value. To get a token, visit https://discord.com/developers/applications and create an application. Then create a bot for the application and enable the "server members intent". Click the "copy" button in the "token" section near the top and paste this value into config.py's "client_token" attribute.
|
|
|
|
|
|
16
|
+Currently the bot is just run in the console locally. It blocks until Ctrl+C is
|
|
|
|
17
|
+pressed. Before running, you must copy config.py.sample to config.py and fill
|
|
|
|
18
|
+in the "client_token" value. To get a token, visit
|
|
|
|
19
|
+https://discord.com/developers/applications and create an application. Then
|
|
|
|
20
|
+create a bot for the application and enable the "server members intent". Click
|
|
|
|
21
|
+the "copy" button in the "token" section near the top and paste this value into
|
|
|
|
22
|
+config.py's "client_token" attribute.
|
|
16
|
|
23
|
|
|
17
|
Create a "config" subdirectory under your source folder. This is where guild-specific configuration is written as JSON files.
|
24
|
Create a "config" subdirectory under your source folder. This is where guild-specific configuration is written as JSON files.
|
|
18
|
|
25
|
|
|
19
|
-To start, run `python3 rocketbot.py`. Then visit https://discord.com/oauth2/authorize?client_id=[application_id]&scope=bot&permissions=395204357318, where [application_id] is the "application id" value on your app configuration "general information" page. Once invited, test if the bot is working by typing `$rb_hello` in your Discord server.
|
|
|
|
|
|
26
|
+To start, run `python3 rocketbot.py`. Then visit
|
|
|
|
27
|
+https://discord.com/oauth2/authorize?client_id=[application_id]&scope=bot&permissions=395204357318,
|
|
|
|
28
|
+where [application_id] is the "application id" value on your app configuration
|
|
|
|
29
|
+"general information" page. Once invited, test if the bot is working by typing
|
|
|
|
30
|
+`$rb_hello` in your Discord server.
|
|
|
|
31
|
+
|
|
|
|
32
|
+Once running, you should immediately set up a warning channel and optionally a
|
|
|
|
33
|
+user/role to tag in warning messages. Go to a channel you want warnings to be
|
|
|
|
34
|
+posted (typically a channel the general userbase cannot see) and type
|
|
|
|
35
|
+`$rb_config setwarningchannel`. This will set that channel as the destination
|
|
|
|
36
|
+for warnings about suspicious behavior on the server. To have these messages
|
|
|
|
37
|
+tag a user or role (such as `@Mods`), type `$rb_config setwarningmention @userorrole`.
|
|
|
|
38
|
+This must be an actual autocompleted @ mention that shows up in a different
|
|
|
|
39
|
+color, not just the name of the user/role. Otherwise warning messages will
|
|
|
|
40
|
+be prefixed with that plaintext name, not with an actual @. To mention several
|
|
|
|
41
|
+people or roles, enclose the whole list in double quotes. E.g.
|
|
|
|
42
|
+`$rb_config setwarningmention "@Mod @Admin"`. You can test out this configuration
|
|
|
|
43
|
+by entering `$rb_testwarn` to issue a test warning.
|