You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-32
Original file line number
Diff line number
Diff line change
@@ -4,90 +4,78 @@ Welcome to the documentation for MoonlightBot! MoonlightBot is a powerful modera
4
4
5
5
## Getting Started
6
6
7
-
First, add the bot to your server using [this invite link](https://discord.com/api/oauth2/authorize?client\_id=314110696071888896\&permissions=1512298638534\&scope=applications.commands%20bot). It's recommended (but not required) that you grant it all permissions it requests, so all its features will work correctly.
7
+
First, add the bot to your server using [this invite link](https://discord.com/api/oauth2/authorize?client_id=314110696071888896&permissions=1512298638534&scope=applications.commands%20bot). It's recommended (but not required) that you grant it all permissions it requests, so all its features will work correctly.
8
8
9
-
{% hint style="info" %}
10
-
You can only add bots to servers in which you have the Manage Server permission.
11
-
{% endhint %}
9
+
{% hint style="info" %} You can only add bots to servers in which you have the Manage Server permission. {% endhint %}
12
10
13
11
Once you've added it to your server, you can verify that it's working by using the `/ping` command, which simply checks the bot's latency.
14
12
15
-
13
+
16
14
17
-
If this is your first time using MoonlightBot, you'll receive a Direct Message welcoming you to the bot and providing several recommendations, including reading the [Acceptable Use Policy](policies/acceptable-use-policy.md). Please read this carefully, as a violation of the Acceptable Use Policy can result in you being banned from using the service.
15
+
If this is your first time using MoonlightBot, you'll receive a Direct Message welcoming you to the bot and providing several recommendations, including reading the [Acceptable Use Policy](./policies/acceptable-use-policy.md). Please read this carefully, as a violation of the Acceptable Use Policy can result in you being banned from using the service.
We suggest that you also review the [Moderation Tutorial](get-started/moderation-tutorial.md) and share it with your server moderators and administrators following the configuration of the bot.
19
+
We suggest that you also review the [Moderation Tutorial](./start-up/moderation-tutorial.md) and share it with your server moderators and administrators following the configuration of the bot.
22
20
23
21
## Temporary Roles
24
22
25
23
The bot can assign and remove specified roles to a user temporarily.
26
24
27
-
* You can assign or remove a temporary role to a user with [`/temprole`](role-management-commands/temprole.md)
28
-
* All temporary roles currently active in the server can be listed with [`/list-temproles`](role-management-commands/list-temproles.md)
29
-
* You can permanently assign or remove any role to a user with [`/role`](role-management-commands/role.md)
30
-
* Users can assign and remove selected roles to themselves with [`/selfrole`](role-management-commands/selfrole.md)
31
-
* You also have the option of using [Reaction Roles](get-started/setting-up-reaction-roles.md) in place of the `/selfrole` command
32
-
* A role assigned to a user can automatically be changed to a temporary role with the [`roles detect-assignment` config option](management-commands/config.md#roles-detect-assignment)
33
-
* Any role assigned to a user can also be temporarily removed with [`/pause-role`](role-management-commands/pause-role.md)
25
+
* You can assign or remove a temporary role to a user with [`/temprole`](./role-management-commands/temprole.md)
26
+
* All temporary roles currently active in the server can be listed with [`/list-temproles`](./role-management-commands/list-temproles.md)
27
+
* You can permanently assign or remove any role to a user with [`/role`](./role-management-commands/role.md)
28
+
* Users can assign and remove selected roles to themselves with [`/selfrole`](./role-management-commands/selfrole.md)
29
+
* You also have the option of using [Reaction Roles](./start-up/setting-up-reaction-roles.md) in place of the `/selfrole` command
30
+
* A role assigned to a user can automatically be changed to a temporary role with the [`roles detect-assignment` config option](./management-commands/config.md#roles-detect-assignment)
31
+
* Any role assigned to a user can also be temporarily removed with [`/pause-role`](./role-management-commands/pause-role.md)
34
32
35
33
## Command Permissions
36
34
37
-
MoonlightBot uses Discord's built-in permissions system to configure who should and should not be able to execute certain commands. Some commands have required permissions set up by default, and all commands can have permissions overridden for specific roles or users. To set up permissions properly, follow the [Permission Tutorial](get-started/permission-tutorial.md).
35
+
MoonlightBot uses Discord's built-in permissions system to configure who should and should not be able to execute certain commands. Some commands have required permissions set up by default, and all commands can have permissions overridden for specific roles or users. To set up permissions properly, follow the [Permission Tutorial](./start-up/permission-tutorial.md).
38
36
39
37
## Logging
40
38
41
39
The bot has configurable logging, and can log several kinds of actions to one or more channels. To enable and configure logging for a specific channel, use the command
where `LOG-CHANNEL` is the channel you want logs posted to.
48
44
49
-
It will ask you for the log actions, and you can enter your choice of items or categories from the [list of log names](advanced/list-of-log-names.md) or simply enter an asterisk (`*`) to log everything. The list of items and categories to log should be separated by commas and spaces, like so: `BAN, KICK, USER_JOIN, USER_LEFT`
45
+
It will ask you for the log actions, and you can enter your choice of items or categories from the [list of log names](./advanced/list-of-log-names.md) or simply enter an asterisk (`*`) to log everything. The list of items and categories to log should be separated by commas and spaces, like so: `BAN, KICK, USER_JOIN, USER_LEFT`
50
46
51
47
## Mute Setup
52
48
53
49
The bot can mute users both temporarily and permanently. To use mute features, use the command
54
-
55
50
```
56
51
/create-muterole
57
52
```
58
-
59
53
to automatically create a mute role with the correct permissions. You can specify a role to be used, or leave it blank and the bot will automatically create a new role.
60
54
61
-
55
+
62
56
63
-
You should now be able to use [`/mute`](moderation-commands/mute.md), [`/tempmute`](moderation-commands/tempmute.md), and [`/unmute`](moderation-commands/unmute.md).
57
+
You should now be able to use [`/mute`](./moderation-commands/mute.md), [`/tempmute`](./moderation-commands/tempmute.md), and [`/unmute`](./moderation-commands/unmute.md).
64
58
65
59
## Changing the Bot's Language
66
60
67
61
The bot supports multiple languages in its responses. This can be set globally for the server, or specifically for you. You can set this by using
68
-
69
62
```
70
63
/config settings locale:LANG
71
64
```
72
-
73
65
for server-wide configuration, or
74
-
75
66
```
76
67
/userconfig settings locale:LANG
77
68
```
78
-
79
69
for user-specific configuration, where `LANG` is the language you want MoonlightBot to respond in.
80
70
81
71
You can find a list of all valid languages [on the Discord Developer Portal](https://discord.com/developers/docs/reference#locales). Locale, Language Name, and Native Name are all valid inputs. You can also use `auto` and MoonlightBot will attempt to auto-detect your preferred language from your Discord settings.
82
72
83
-
{% hint style="info" %}
84
-
MoonlightBot is translated entirely by volunteers, so not all languages are complete and some may have translation errors. If you speak one of the supported languages proficiently and would like to help us translate MoonlightBot, [please consider becoming a translator!](support-our-work/volunteering.md#translator)
85
-
{% endhint %}
73
+
{% hint style="info" %} MoonlightBot is translated entirely by volunteers, so not all languages are complete and some may have translation errors. If you speak one of the supported languages proficiently and would like to help us translate MoonlightBot, [please consider becoming a translator!](./support/volunteering.md#translator) {% endhint %}
86
74
87
75
## Support the Development of MoonlightBot
88
76
89
-
MoonlightBot is run and maintained by volunteers, and is currently funded entirely by [Premium Subscriptions](support-our-work/premium.md). These subscriptions help us fund hosting and give you great benefits, making them a fantastic way to support us. You can also help by [upvoting the bot](support-our-work/upvote-moonlightbot.md) on bot lists or by [joining our team of testers, translators, and documentation writers](support-our-work/volunteering.md).
77
+
MoonlightBot is run and maintained by volunteers, and is currently funded entirely by [Premium Subscriptions](./support/premium.md). These subscriptions help us fund hosting and give you great benefits, making them a fantastic way to support us. You can also help by [upvoting the bot](./support/upvote-moonlightbot.md) on bot lists or by [joining our team of testers, translators, and documentation writers](./support/volunteering.md).
90
78
91
79
## Questions? Problems?
92
80
93
-
Please [read the Frequently Asked Questions first](get-started/faqs.md) to see if your question or problem is answered there. If your question or problem is still unanswered, [join the support server](https://discord.gg/hNQWVVC) and we will help you as best we can!
81
+
Please [read the Frequently Asked Questions first](./start-up/faqs.md) to see if your question or problem is answered there. If your question or problem is still unanswered, [join the support server](https://discord.gg/hNQWVVC) and we will help you as best we can!
Developer mode is a Discord feature that allows you to access the internal IDs used by Discord to refer to certain objects, such as users, servers, messages, channels, and roles. These can be used in place of such options in MoonlightBot's commands.
6
4
7
-
##Using Developer Mode
5
+
# Using Developer Mode
8
6
9
-
To use developer mode, you need to enable it first. Instructions for enabling developer mode are provided [in the next section](developer-mode.md#enabling-developer-mode).
7
+
To use developer mode, you need to enable it first. Instructions for enabling developer mode are provided [in the next section](#enabling-developer-mode).
10
8
11
9
Whenever MoonlightBot asks for something like a user, channel, etc., you can provide the ID as an option to make sure it is pointing to exactly what you want.
12
10
13
-
###Desktop/Web App
11
+
## Desktop/Web App
14
12
15
13
To copy the ID of an object in the desktop or web app, right-click the object and click on the **Copy ID** option.
16
14
17
-
###Android App
15
+
## Android App
18
16
19
17
For example, to copy the ID of a user in the Android app, tap on the user's profile, then tap on the three dots in the top right corner and click on **Copy ID**.
20
18
21
-
###iOS App
19
+
## iOS App
22
20
23
21
For example, to copy the ID of a user in the iOS app, tap on the user's profile, then tap on the three dots in the top right corner and click on **Copy ID**.
24
22
25
-
##Enabling Developer Mode
23
+
# Enabling Developer Mode
26
24
27
-
###Desktop/Web App
25
+
## Desktop/Web App
28
26
29
27
1. Go to **User Settings** by clicking the gear icon in the bottom left of the window
30
28
2. Go to "**Advanced**"
31
29
3. Click on the **Developer mode** toggle and you're done!
32
30
33
31
{% tabs %}
34
32
{% tab title="Step 1" %}
35
-
33
+
36
34
{% endtab %}
37
35
38
36
{% tab title="Step 2" %}
39
-
37
+
40
38
{% endtab %}
41
39
42
40
{% tab title="Step 3" %}
43
-
41
+
44
42
{% endtab %}
45
43
{% endtabs %}
46
44
47
-
###Android App
45
+
## Android App
48
46
49
47
1. Go to **User Profile** by clicking your avatar in the bottom right corner
50
48
2. Click again on your avatar in the bottom right corner or on the three dots in the top right corner
@@ -54,23 +52,23 @@ For example, to copy the ID of a user in the iOS app, tap on the user's profile,
54
52
55
53
{% tabs %}
56
54
{% tab title="Step 1" %}
57
-
.png>)
55
+
58
56
{% endtab %}
59
57
60
58
{% tab title="Step 2" %}
61
-
.png>)
59
+
62
60
{% endtab %}
63
61
64
62
{% tab title="Step 3" %}
65
-
.png>)
63
+
66
64
{% endtab %}
67
65
68
66
{% tab title="Step 4" %}
69
-
67
+
70
68
{% endtab %}
71
69
{% endtabs %}
72
70
73
-
###iOS App
71
+
## iOS App
74
72
75
73
1. Go to **User Profile** by clicking your avatar in the bottom right corner
76
74
2. Click again on your avatar in the bottom right corner or on the three dots in the top right corner
@@ -80,18 +78,18 @@ For example, to copy the ID of a user in the iOS app, tap on the user's profile,
80
78
81
79
{% tabs %}
82
80
{% tab title="Step 1" %}
83
-
.png>)
81
+
84
82
{% endtab %}
85
83
86
84
{% tab title="Step 2" %}
87
-
.png>)
85
+
88
86
{% endtab %}
89
87
90
88
{% tab title="Step 3" %}
91
-
.png>)
89
+
92
90
{% endtab %}
93
91
94
92
{% tab title="Step 4" %}
95
-
.png>)
93
+
0 commit comments