Skip to content

Commit

Permalink
Merge pull request #12 from MoonlightCapital/faqs-and-clarifications
Browse files Browse the repository at this point in the history
  • Loading branch information
MoonlightCapital authored Oct 28, 2022
2 parents 8531715 + d0f37f3 commit 8918891
Show file tree
Hide file tree
Showing 6 changed files with 50 additions and 40 deletions.
24 changes: 9 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,25 @@
# MoonlightBot Documentation

MoonlightBot is a powerful Discord bot designed to help server moderation without bloat. It features extremely customizable logging, easy to use commands, management of temporary actions, and much much more to make your server life easier.
MoonlightBot is a powerful Discord bot designed to help server moderation without bloat. It features extremely customizable logging, easy to use commands, management of temporary actions, and much much more to make your server life easier. It is very easy to setup and learn its commands.

## Getting started

The first step in using MoonlightBot is to invite it to your server. [Click here](https://discord.com/api/oauth2/authorize?client_id=314110696071888896\&scope=bot+applications.commands\&permissions=470150342) for a link that lets you invite the bot with all permissions it requires to work.
The first step in using MoonlightBot is to invite it to your server. [Click here](https://discord.com/api/oauth2/authorize?client_id=314110696071888896&permissions=1512298638534&scope=applications.commands%20bot) for a link that lets you invite the bot with all permissions it requires to work.

{% hint style="info" %}
Only servers in which you have **Manage Server** permission will show there.

The bot can still work without its managed role, but some commands may not work if proper permissions are not set.
{% endhint %}

{% hint style="success" %}
Feel good and want early access to new things? Check out [MoonlightBot beta](versions-of-the-bot/beta.md).
{% endhint %}

### Commands

You can use MoonlightBot's commands by sending a Slash Command. We're currently removing support for legacy prefixes, due to changes being made by Discord.
MoonlightBot uses Slash Commands. Type a slash (`/`) into the send message box to see all commands.

![An example of a command](<.gitbook/assets/PingExample.png>)

{% hint style="info" %}
Use `/help <name of a command>` to know how to use a command, as well as to know if the command exists.
Use `/help <name of a command>` for information on a command.
{% endhint %}

### Configuration
Expand All @@ -34,14 +30,12 @@ By default, there's nothing to configure to use the core features, but if you wa

### Support us

{% hint style="success" %}
If you've been enjoying MoonlightBot, please [upvote it on bot listing sites](support/upvote-moonlightbot.md). This really helps speeding up the development of the bot.
{% endhint %}
MoonlightBot is fully funded by [Premium Subscriptions](./versions-of-the-bot/premium.md) and ran by a small group of volunteers. Please help us out cover hosting costs or [Vote](support/upvote-moonlightbot.md) to give us more visibility!

### Extras
### Next steps

Confused on the syntax of arguments? [Check the arguments page.](start-up/arguments.md)
- [Learn the syntax of arguments](start-up/arguments.md)

Have a question not answered here? [Read the FAQ.](start-up/faqs.md)
- [Read the FAQs](start-up/faqs.md)

This guide still does not help you or you want to suggest improvements? [Join the support server.](https://discord.gg/hNQWVVC)
- [Join the support server](https://discord.gg/hNQWVVC) to get answers by humans
4 changes: 4 additions & 0 deletions staff-commands/temprole.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ You can reduce the total duration of a temprole by setting a negative duration
/temprole <user> <role> <duration> [reason]
```

{% hint style="info" %}
The [FAQs page](../start-up/faqs.md) has answers for some of the most common temprole-related questions
{% endhint %}

### **Required permission**

This command's level is 50 by default.\
Expand Down
10 changes: 7 additions & 3 deletions start-up/faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ Try doing the following things:
* [ ] Try checking channel permission. If needed, you can add to the bot channel-specific permissions such as Read Messages, Send Messages, Embed Links and View Message History.
* [ ] It can happen that the server admins disabled the `showPermissionError` option and you do not have permissions to use the command you're trying to use. Contact the server admins.

If the problem persists, please ask in the [support server](https://discord.gg/hNQWVVC).
If the problem persists, please [contact support](https://discord.gg/hNQWVVC).

## Can I use bots to trigger MoonlightBot commands?

For security reasons, MoonlightBot will ignore messages sent by bots and webhooks.
No, other bots and webhooks cannot trigger MoonlightBot, due to safety reasons. Using [selfbots](https://support.discord.com/hc/en-us/articles/115002192352-Automated-user-accounts-self-bots-) is a violation of Discord's Terms of Service.

## How does the temprole feature work?

Expand Down Expand Up @@ -51,7 +51,11 @@ If someone is threatening to stop sustaining temproles to damage your server, [c

You can also contact support to receive a temporary exemption from sustaining, if necessary.

## MoonlightBot is sending me offensive messages. What can I do?
## Will my temproles be erased if a bot downtime happens?

No! There's absolutely no reason to worry about potential data losses as MoonlightBot is designed to be resilient. We are committed to 99% uptime, but if it ever happens that the bot goes down, your temproles will be removed as nothing happened.

## MoonlightBot is sending me offensive direct messages. What can I do?

This is happening because someone is abusing the infraction system to harass you. Our Staff does not tolerate this use at all. Please report it at the [support server](https://discord.gg/hNQWVVC).

Expand Down
6 changes: 5 additions & 1 deletion start-up/privacy-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ The database is hosted in a VPS residing in the United Kingdom.

The Discord.js library automatically caches many things that come from Discord directly, they can range from avatars to message contents, to meta parameters such as role colors, names, user tags, user flags (badges). Most of this content is used to provide logs or command output, and is deleted on bot shutdown, as it is put into a volatile storage.

## Message content

MoonlightBot is approved for the "message content privileged intent", which means it **can see the content of messages you send**. Message contents are only stored in the cache for a brief period of time, and are used to provide message deletion and edit logs. If you are a server administrator and wish to opt-out a channel from being logged, please disable the bot's permission to read messages in such channel.

## Stored in Discord

Output of bot commands that is sent to Discord may include things like names, IDs and icons/avatars. Those things cannot be deleted by us as there's no feasible way to do so. This also includes server mod logs that belong to the service the bot provides, which will not be deleted by us.
Expand All @@ -39,7 +43,7 @@ Bot logs will not be deleted, as they are necessary to keep the service healthy.

Sometimes data from the database is cleaned, this usually relates to unnecessary data (such as config and other things related to the server itself) for merely technical reasons. If you disagree, please inform the Staff promptly.

The MoonlightBot Staff deserves the right to modify or delete any data at any given time, without notice or warning.
The MoonlightBot Staff deserves the right to modify or delete any data stored at any given time, without notice or warning.
{% endhint %}

## TL;DR
Expand Down
31 changes: 16 additions & 15 deletions start-up/setting-up-reaction-roles.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ MoonlightBot allows users to assign or remove roles from themselves by reacting
Before beginning, make sure of the following things:

* MoonlightBot has View Messages, Send Messages, Add Reactions and Manage Messages permissions in both the channel you're using commands in and the one you want reaction roles to be applied to
* You have developer mode enabled. [Here's a guide on how to enable it](https://moonlightbot.gitbook.io/docs/advanced/developer-mode)
* Plan ahead what roles and emojis you want to use

## Creating a group
Expand Down Expand Up @@ -68,13 +67,17 @@ To do this, you simply need to use the following command:
/reaction-roles apply <group> <message>
```

Once again, `<group>` is a group you created before, and `<message>` is an argument that can be resolved to a message. The following are valid message identifiers:
Once again, `<group>` is a group you created before, and `<message>` is for the message the reaction roles will work on. The following are valid message identifiers:

* A simple message ID, like `663696313086509106.` This only works if the message was sent in the channel you're using the command in.
* A simple message ID, like `663696313086509106`. This only works if the message was sent in the channel you're using the command in.
* A Channel ID and a message ID, separed by a single dash, like `659297716920254465-663696313086509106`. You can get this by holding the SHIFT key while copying the message ID. This works if you want to keep the reaction roles channel clean.
* A message link, composed of Server ID/Channel ID/Message ID, like `https://discord.com/channels/359057740200673280/659297716920254465/663696313086509106`. This is the easiest option which combines ease of use from mobile devices and keeping the channel clean, as point 2.
* **(recommended)** A message link, composed of Server ID/Channel ID/Message ID, like `https://discord.com/channels/359057740200673280/659297716920254465/663696313086509106`. Right click (or long press) the message from mobile then click "Copy Link". You can then paste the link from your clipboard.

And voila! The bot will ask you to confirm since already existing reactions will be removed, then, all reactions from the group will be added. This may take a while (say, 21 seconds in the worst case scenario).
{% hint style="warning" %}
To copy message IDs, you first need to [enable developer mode](../advanced/developer-mode.md). It is not necessary for links.
{% endhint %}

And voila! The bot will ask you to confirm since already existing reactions will be removed, then, all reactions from the group will be added. This operation may take about 20 seconds to complete, depending on the amount of reactions.

![](<../.gitbook/assets/immagine (12).png>)

Expand All @@ -99,25 +102,23 @@ For an in-depth view of all options, see the [Configuring Reaction Roles](../adm

## FAQ

### How can I make the same emoji add/remove more than one role?

{% hint style="warning" %}
This is no longer necessary as version `2.17.0`, as you can set more than one role per reaction in the same group
{% endhint %}
### How do I make reaction roles temporary?

Create multiple groups, map the same emoji to different roles, and apply them to the same message. Keep in mind that you may need to re-add some reactions that aren't in common for both roles as the autopurge on apply takes effect.
Use `/config arguments: reactionroles <group> duration <duration>` to add a timer that starts when the reaction is clicked. The duration is provided in, say, [the same way as](arguments.md#durations) you use the `temprole` command.

Group settings are independent from each other, meaning someone can click a reaction and get both a temporary and a permanent role.
### Can I make a single click of a reaction give out more than one role?

### How do I make reaction roles temporary?
Yes! However, group settings are common for each role in the group. Though you can apply multiple groups to the same message, which will allow you to:

Use `/config arguments: reactionroles <group> duration <duration>` to add a timer that starts when the reaction is clicked. The duration is provided in, say, [the same way as](arguments.md#durations) you use the `temprole` command.
- Make some roles temporary, and other ones permanent
- Make some roles only joinable, while removing other ones on click
... And much more, you can experiment which settings works best for you.

### How do I disable notifications that are sent to the user?

#### If you are a server admin:

Use `/config reactionroles <group> dmnotification false` to disable notifications for a group.
Use `/config arguments:reactionroles <group> dmnotification false` to disable notifications for a group.

{% hint style="warning" %}
If a message has multiple groups, notifications will still be sent, providing at least one of the other groups has notifications enabled
Expand Down
15 changes: 9 additions & 6 deletions versions-of-the-bot/beta.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,21 @@
MoonlightBot beta is a public beta version of the bot that let users who want the upcoming features be able to try out these features before they get publicly released to MoonlightBot. Beta also gets bug fixes early.

{% hint style="warning" %}
To keep MoonlightBot beta in a server, any member with manage server permissions must be in the support server, and respond within a reasonable time to MoonlightBot's staff. Failing the first requirement at any time will result in an automatic removal of the bot.
To keep MoonlightBot beta in a server, any member with manage server permissions must be in the support server, to act as a point of contact for us. Failing to meet this requirement at any time will result in an automatic removal of the bot.
{% endhint %}

## How to get MoonlightBot beta

1. Join [MoonlightBot's support server](https://discord.gg/hNQWVVC)
2. Go to the **#get-beta** channel
1. Join [MoonlightBot's support server](https://discord.gg/8376ZVg)
2. Go to the **#get-beta** channel (the link above will take you directly)
3. Click on the invite link, then proceed to invite it like any other bot

## Debunking common misconceptions and FAQs

### Will I have to keep both stable and beta if I want to use it?

No, you don't need to clutter your server with two almost identical bots. As stated above, you can ask support for a data transfer, then remove stable. Transferrals are free and instant.

### It does not have the "Verified bot" checkmark

A bot is eligible for verification once it [reaches 75 servers](https://support.discord.com/hc/en-us/articles/360040720412-Bot-Verification-and-Data-Whitelisting). The checkmark only signifies that a bot has been reviewed by Discord, and allows it to join more than 100 servers.
Expand All @@ -34,7 +38,6 @@ You can seamlessly switch to beta by asking for all your data to be transferred

Having MoonlightBot beta in a server requires someone with "Manage server" permission to be in the support server, so the Staff can have a point of contact to refer that server by.

### Will I have to keep both stable and beta if I want to use it?

No, you don't need to clutter your server with two almost identical bots. As stated above, you can ask for a data transfer, then remove stable.
### I have no time/I don't know how to look for bugs

No problem! You are not required to actively find bugs, rather, use the features you'd normally use and report any bugs you may find.

0 comments on commit 8918891

Please sign in to comment.