mirror of
https://github.com/42wim/matterbridge.git
synced 2024-11-25 05:29:40 +01:00
Update Discord docs to match current flow; fix image linkrot; expand on needed permissions; fixes https://github.com/42wim/matterbridge/issues/1944
Nick
parent
ea67869605
commit
1eb89573dd
@ -1,51 +1,72 @@
|
|||||||
(based upon https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token)
|
(based upon https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token)
|
||||||
|
|
||||||
## New application
|
## Create Bot
|
||||||
|
|
||||||
First, you need to go [here](https://discordapp.com/developers/applications/me) and click "New Application"
|
First, you need to go [here](https://discord.com/developers/applications) and click "New Application".
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Now give your bot a name.
|
Now give your bot a name.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Click "Create". On the next screen, you can set an Avatar Icon for your app and description (not necessary).
|
Click "Create". On the next screen, you can optionally set an Avatar Icon for your app and description.
|
||||||
This is also where you will find your Client ID, more on that later.
|
|
||||||
|
|
||||||
|
|
||||||
Next, click on Bot on the left-hand menu, then click "Add Bot"
|
|
||||||
|
|
||||||
|
Next, click on Bot on the left-hand menu
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
hen click "Add Bot"
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Click "Yes Do It"
|
Click "Yes Do It"
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
On the Bot screen you will get to see your token, you can click "Copy" to put it in your clipboard or "Click to reveal your Token", put this in your config file.
|
On the Bot screen you will generate your **token**. Click "Reset Token" and "Yes, Do It!" a second time.
|
||||||
Here, you can toggle if the bot is public (which will allow others to invite to their servers, this is on by default).
|
|
||||||
|
|
||||||
|
|
||||||
## Privileged Gateway Intents
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Then you can click "Copy" to put the token it in your clipboard. Keep this for your matterbridge config file.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Here, you can also toggle if the bot is public, which will allow others to invite to their servers. This is off by default and will not do anything unless the matterbridge configuration file lists the servers it has been invited to, so you should just leave this off.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### Privileged Gateway Intents
|
||||||
|
|
||||||
Make sure to also toggle the "Server Members Intent" and "Message Content Intent" options further down under "Privileged Gateway Intents" to allow the bot to see the member list, otherwise you'll get an error message similar to `Error obtaining server members: HTTP 403 Forbidden, {"message": "Missing Access", "code": 50001}`.
|
Make sure to also toggle the "Server Members Intent" and "Message Content Intent" options further down under "Privileged Gateway Intents" to allow the bot to see the member list, otherwise you'll get an error message similar to `Error obtaining server members: HTTP 403 Forbidden, {"message": "Missing Access", "code": 50001}`.
|
||||||
|
|
||||||
Click "Save Changes"
|
Click "Save Changes"
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Invite bot
|
## Invite bot
|
||||||
|
|
||||||
Now it's time to invite your bot to your server. Don't worry about your bot being started for this next step. You can get this under OAuth2 → General
|
Now it's time to invite your bot to your server. Don't worry about your bot being started for this next step. You can get this under OAuth2 → General
|
||||||
|
|
||||||
|
|
||||||
|
Copy the client ID into this URL and go to it
|
||||||
Change the client_id to your Client ID under App Details, then go to this URL
|
|
||||||
|
|
||||||
```https://discordapp.com/oauth2/authorize?&client_id=YOUR_CLIENT_ID_HERE&scope=bot&permissions=536870912```
|
```https://discordapp.com/oauth2/authorize?&client_id=YOUR_CLIENT_ID_HERE&scope=bot&permissions=536870912```
|
||||||
|
|
||||||
The weird number (536870912 = 0x20000000) corresponds to the "Manage Webhooks" permission. If you don't want to use `AutoWebhooks=true`, then you can use `0` instead.
|
The weird number (536870912 = 0x20000000) corresponds to the "Manage Webhooks" permission. If you don't want to use `AutoWebhooks=true`, then you can use `0` instead, but you will need to configure the necessary webhooks manually.
|
||||||
|
|
||||||
Now select your server, then click authorize.
|
It will prompt you to select your server
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
and then Authorize it
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Solve CAPTCHA if necessary
|
Solve CAPTCHA if necessary
|
||||||
|
|
||||||
@ -53,20 +74,38 @@ Solve CAPTCHA if necessary
|
|||||||
|
|
||||||
Then you should see
|
Then you should see
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
You can confirm the bot is added under Your Guild > Settings > Integrations > Bots and Apps, and in your #general channel you should see "A wild [bot name] appeared!".
|
You can confirm the bot is added by looking in your #general channel for "A wild [bot name] appeared!" or "Welcome [bot name]. We hope you brought pizza." or some other pithy welcome message, and checking under Your Guild > Settings > Integrations > Bots and Apps.
|
||||||
|
|
||||||
## Take token
|
|
||||||
|
## Invite to channels
|
||||||
|
|
||||||
|
For each channel you want to bridge, you need to make sure the bot user is a member.
|
||||||
|
|
||||||
|
The bot should be in all public channels in your server by default, but for private channels you must either make sure to give it an appropriate Role, or to directly add it under Edit Channel > Permissions > Roles/Members
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
It needs to have View and Send permissions
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
If you have trouble with this, open an issue and we can improve these docs.
|
||||||
|
|
||||||
|
|
||||||
|
## Matterbridge Config
|
||||||
|
|
||||||
Take the bot's token (the _token_, not the client ID) and add it to your matterbridge config like so:
|
Take the bot's token (the _token_, not the client ID) and add it to your matterbridge config like so:
|
||||||
|
|
||||||
```
|
```
|
||||||
[discord.yourbridgename]
|
[discord.yourbridgeid]
|
||||||
Token="NzY1OTgwMjA2Nzc4Mjg2MTIx.X4csqA.HO0F0tg7rvnVrv70kMhQcdXikjY"
|
Token="NzY1OTgwMjA2Nzc4Mjg2MTIx.Gpz4tE.HOslqKftF2_bm2y_bIaaACyy3_vLBmbevl02JQ"
|
||||||
|
# ....
|
||||||
# Server (REQUIRED) is the ID or name of the guild to connect to, selected from the guilds the bot has been invited to
|
|
||||||
Server="70489999999999999999"
|
|
||||||
```
|
```
|
||||||
|
|
||||||
That's it! Now you can start your bot and enjoy chatting!
|
Then [[Section-Discord-(basic)|set up your individual bridges]].
|
||||||
Loading…
Reference in New Issue
Block a user