Discord
How to Install and Configure the Scribe Discord Bot
*** If you are looking for Conquest Bot install instructions, click here ***
Prerequisite: It helps to have a Scribe Community set up already. If you have not done that yet, please go here and create a new one!
Security Note: Ensure your Server Security plugins (like Wick) will allow you to install unverified bots, as the bot is new and not yet eligible "Verified" status from Discord.
Installing the Scribe Discord Bot
There are two ways to invite the Bot to your Discord Server:
Option 1) Install from a Discord invite link: (Click to Install)
Option 2) Invite the BOT to your server from the Scribe Discord with these steps:
Visit the Scribe Discord, or any Discord you see the Bot in.
Click on the Scribe BOT in the user list of the General channel, and click Add to Server:
Configuring the Discord Bot
Once you have the bot invited to your server, it can be configured in one of two ways; you can link it to a Community ID from Scribe with a command, or you can add your Discord Server ID to your Community Setup on Scribe. In either case, or goal is to connect up the Community ID with a Discord Server ID.
Linking the BOT to a Server ID from within Scribe
1) Grab your Discord Server ID from Discord. Go to your Server Settings, click on Widget, and then click on the Copy button where your Server ID is located. We're not creating a widget, just grabbing the ID and it's conveniently in this screen:
2) If you didn't add the Server ID in your initial Community Setup, you can add it to your Scribe Community configuration by visiting the Community Area, clicking on your Community, and clicking on Admin. You will need to be logged in to Scribe to do this.
3) Enter the Discord Server ID and Save it. That's it! Your community is now connected to the Bot.
Linking the BOT to a Server ID from Scribe
1) Grab your Community ID from Scribe. Visit the Community Area, click on your community and take note of the Community ID there. Click the Copy icon button to copy the ID to your Clipboard.
2) Run the 'config' command in your Discord. We recommend you do it in a private channel, but the Scribe Bot MUST have the Read Messages permission in the channel. Also, the user running the command must have either Admin role, or a Role named "Scribe Admin". You can create the "Scribe Admin" role temporarily if you need to, and then remove it afterwards. Run the command below, replacing the SCRIBE_COMMUNITY_ID with your Community ID from Scribe:
!scribe config SCRIBE_COMMUNITY_ID
When run successfully, you will see a response like this:
3) Apply the needed permissions. Refer to this screenshot of permissions the Bot needs. Some are intended for use by various games and experiences the bot will deliver in the future.
Using the Discord Bot
Once the Discord Bot is configured, it monitors channels it can see into for messages. When a message is posted to the channel, the Discord Bot sends the user's name, discord id, and roles along with the channel name and length of the message to the Scribe API. We don't receive the message content.
These events are stored in Scribe so we can build metrics for your Discord Usage.
Getting XP with the Discord Bot
Different events get different kinds of XP (Experience Points). The XP is considered Social XP and counts towards their Social levels.
Users must be registered with Scribe to receive XP. They must also link their Discord Account to their Scribe account using the Scribe web app.
Getting NFT XP
All XP for a user count towards their general Metaverse Level and profile. However, if the user's avatar on the Discord Server EXACTLY matches an NFT they have Activated in Scribe, that NFT will receive the XP as well, and it will show up in the NFT's data as shown here with the application named 'Discord Engage':
Troubleshooting XP
If a user has signed up with Scribe and linked their Discord, they should be able to get XP on any NFT that's been Activated in Scribe. If for some reason it's not working, it's usually due to a slight mismatch in the image used for a Discord Profile picture. To ensure a close/perfect match, use the PFP Image button on the bottom of the NFT screen in Scribe. It will give you a jpeg of the NFT image and is very helpful in getting a match, especially on mobile.
Sending XP to a User
Admins or users with a role named "Scribe Admin" can send XP to any user like this:
!scribe sendxp @username 1 "optional message"
The 1 represents the size of the reward. Valid amounts are 1,2,3 (small to large).
Keep in mind that all XP earned is subject to boosts and multipliers which may be active for the user, your community, or globally (like a double XP weekend).
The Superpass NFT is a common way users boost their own XP.
Get one here: https://app.nftscribe.io/shop/superpass or on OpenSea: https://opensea.io/collection/superpassgenesis To see other ways you can earn XP, check here!
Checking your current XP and Level
Use the !scribe xp command to see your current progress and what else may be needed to achieve your next level. Output looks like this:
Use the !scribe metaverse command to see your User Metaverse XP and Level. This is inclusive of any XP sent to any NFTs you've owned.
Role Tiers
You can assign roles to the bot for XP boosts based on role.
The command to setup specific role tiers is !scribe role ROLENAME TIERNUMBER where ROLENAME is an exact role name (no quotes) and TIERNUMBER is 1,2 or 3. You can only have one role name per tier number, and the associated bonuses are 25%, 50%, 75%
You can clear a role out for any bonuses with !scribe role ROLENAME 0
Checking Community Info
You can get some info on the community you're in with this command:
!scribe community
It will return some useful stats such as the current community level, active bonuses, and other interesting stats.
Other Helpful Commands
Use the !scribe help command to get some basic information on how to setup a new user. Very useful if it's been awhile!
!scribe commands will return the current command list
Command Summary
| Command | Summary |
|---|---|
| |
| |
| |
| |
| |
| |
| |
|
Last updated
