|
1 | 1 | # Verification |
2 | 2 |
|
3 | | -This Cog is used to add a Verification System. |
| 3 | +This Cog is used to add a verification system. |
4 | 4 |
|
5 | 5 |
|
6 | 6 | ## add |
7 | 7 |
|
8 | 8 |
|
9 | | -With the `add` subcommand you can a Verification Role. |
10 | | -You can set `reverse` to `true` then the Role will get removed from the user and not added. |
| 9 | +With the `add` subcommand you can add a verification role. |
| 10 | +If you set `reverse` to `true`, the role will be removed from the user instead of added. |
11 | 11 |
|
12 | 12 | ```css |
13 | 13 | .verification [add|a|+] <role> [reverse=False] |
14 | 14 | ``` |
15 | 15 |
|
16 | 16 | Argument | Required | Description |
17 | 17 | ---------|---------------------|------------ |
18 | | -role | :heavy_check_mark: | The Verification Role |
19 | | -reverse | | The Role assignment will be reversed => Role will get removed |
| 18 | +role | :heavy_check_mark: | The verification role |
| 19 | +reverse | | The role assignment will be reversed => role will be removed |
20 | 20 |
|
21 | | -Required Permissions: |
| 21 | +Required permissions: |
22 | 22 |
|
23 | 23 | - `settings.change_prefix` |
24 | 24 |
|
25 | 25 |
|
26 | 26 | ## delay |
27 | 27 |
|
28 | 28 |
|
29 | | -Set the Time you have to be on the Server until you can Verify. |
| 29 | +Set the time a user has to be on the server until they can verify. |
30 | 30 |
|
31 | 31 | ```css |
32 | 32 | .verification [delay|d] <seconds> |
33 | 33 | ``` |
34 | 34 |
|
35 | 35 | Argument | Required | Description |
36 | 36 | ---------|---------------------|------------ |
37 | | -delay | :heavy_check_mark: | The Time in Seconds |
| 37 | +delay | :heavy_check_mark: | The time in seconds |
38 | 38 |
|
39 | 39 |
|
40 | 40 | ## password |
41 | 41 |
|
42 | 42 |
|
43 | | -Sets the *Secret* Password you'll need to Verify. |
| 43 | +Sets the *secret* password the user will need to verify. |
44 | 44 |
|
45 | 45 | ```css |
46 | 46 | .verification [password|p] <password> |
47 | 47 | ``` |
48 | 48 |
|
49 | 49 | Argument | Required | Description |
50 | 50 | ---------|---------------------|------------ |
51 | | -password | :heavy_check_mark: | The Password as string |
| 51 | +password | :heavy_check_mark: | The password as string |
52 | 52 |
|
53 | 53 | !!! note |
54 | | - Password has a Max-Length of 256 Chars |
| 54 | + The password has a max-length of 256 characters. |
55 | 55 |
|
56 | 56 |
|
57 | 57 | ## remove |
58 | 58 |
|
59 | 59 |
|
60 | | -Removes an existing Verification. |
| 60 | +Removes an existing verification. |
61 | 61 |
|
62 | 62 | ```css |
63 | 63 | .verification [remove|r|-] <role> |
64 | 64 | ``` |
65 | 65 |
|
66 | 66 | Argument | Required | Description |
67 | 67 | ---------|---------------------|------------ |
68 | | -role | :heavy_check_mark: | The Verification Role |
| 68 | +role | :heavy_check_mark: | The verification role |
0 commit comments