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: docs/linked-roles.md
+74-3Lines changed: 74 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -64,12 +64,83 @@ this guide, but you can also click "Continue" there, since you are already here
64
64
65
65
Next, SCNX will prompt you to select which Discord credentials you want to use for Linked Roles. If you are using other
66
66
SCNX products, like [Modmail](./modmail/intro) or the [Custom Bot](./custom-bot/custom-commands), you can select them
67
-
from this list and [skip to step 3](#step-3). If you are not using any other product, please follow [these instructions](#step-2-app).
67
+
from this list and [skip to step 3](#step-3). If you are not using any other product, please
68
+
follow [these instructions](#step-2-app).
68
69
69
70
70
71
71
72
### Creating a Discord bot application {#step-2-app}
72
73
73
-
If you are not using the credentials of another product, you'll need to create a new app in your Discord Developer Dashboard.
74
+
If you are not using the credentials of another product, you'll need to create a new app in your Discord Developer
75
+
Dashboard.
74
76
75
-
## 3. Configuring Linked Roles {#step-3}
77
+
To do so, visit the [Discord Developer Portal](https://discord.com/developers/applications). There, create a new
78
+
application by clicking on "New Application" on the upper-right side of your Developer Portal. A modal will open. Enter
79
+
the name of the application (you can change this later), read & accept
80
+
the [Discord Developer Terms of Service](https://discord.com/developers/docs/policies-and-agreements/terms-of-service)
81
+
and the [Discord Developer Policy](https://discord.com/developers/docs/policies-and-agreements/developer-policy) (these
82
+
policies also apply to your use of the Discord API as part of SCNX) and create your bot by confirming with "Create".
83
+
84
+
85
+
86
+
Next, open the "Bot"-Settings in the navigation bar on the left-hand side.
87
+
There, you can configure the avatar and username.
88
+
89
+
The final step in the Developer Dashboard is to generate a token and copy it. To do so, open the "Bot" page of your
90
+
application
91
+
and click on "Reset token" (still on the Bot page) and confirm your request in the modal. You might get asked
92
+
to enter a 2FA-Code for your Discord-Account.
93
+
94
+
Once done, please **copy the token of your bot and enter it on SCNX**.
95
+
96
+
97
+
98
+
Once done, SCNX will check your token and synchronize data with Discord. Once done, you can continue
99
+
with [the next step](#step-3).
100
+
101
+
## 3. Save redirect URL {#step-3}
102
+
103
+
Once your credentials are checked and SCNX has synchronized some Linked-Role data with Discord, you'll need to open the
104
+
Oauth2 page of your Discord Developer Portal. The easiest way to do so is to click on the link that is visible on SCNX.
105
+
Alternatively, you can click on "Oauth2" tab in your developer dashboard.
106
+
107
+
108
+
109
+
Once you've opened the Oauth2 page, you'll need to copy and paste the redirect URL from your SCNX Dashboard. Doing this
110
+
is easy: Simply click on the URL shown in SCNX (this will copy the URL to your clipboard). If you are wondering, the
111
+
redirect URL should look something like this:
112
+
`https://linked-roles.scnx.app/api/b4e5e89a-1c92-11f0-b688-03c2706e348f/callback` (the middle part might change based on
113
+
your server).
114
+
115
+
116
+
117
+
Go back to the "Oauth2"-Page
118
+
in your Discord Developer Portal. There, scroll to "Redirects", click on "Add another" and paste the URL you just copied
119
+
in the text field. Remember to save your changes!
120
+
121
+
122
+
123
+
## 4. Enter Client Secret {#step-4}
124
+
125
+
:::warning Confusion avoidance warning
126
+
There's a big difference between your **Bot Token** and **Client Secret**. Please double-check which value you are
127
+
entering to avoid issues later. For this step, you'll need the **Client Secret**, not the Bot Token.
128
+
:::
129
+
130
+
Once you've entered and saved the Redirect URL, please stay on the "Oauth2 page". Below "Client Information", generate
131
+
the Client secret, by clicking on "Reset Secret" below the "Client Secret" field. Discord might ask you to verify your
132
+
account by entering a 2FA code. Once this is done, you'll be able to copy the Client-ID. Enter the copied value in your
133
+
SCNX Dashboard and click on "Create Linked-Roles" to finish setup.
134
+
135
+
136
+
137
+
## 5. Time to party 🎉 {#step-5}
138
+
139
+
:::info Don't worry
140
+
Your new Linked Role Bot won't stay online unless
141
+
:::
142
+
143
+
Finally, finish setup by inviting the Linked Roles Bot to your server. Do so by clicking "Invite Linked-Roles-Bot" in
144
+
the dashboard. Once done, you can continue by creating your first Linked Role. To learn more about that, continue in our [Role management documentation](./linked-roles/role-managment#create-linked-scnx-role), where we explain how to create your Linked Roles on SCNX and on Discord.
145
+
146
+
0 commit comments