Discord integration Documentation - ilpersi/BHBot GitHub Wiki
Discord documentation
What is Discord?
If you play Bit Heroes and you are part of a guild, you probably already know Discord. :) In short, Discord is a platform designed for video gaming communities, that specializes in text, image, video and audio communication between users in a chat channel. For more details on it, look here.
Is Discord free?
Yes, Discord is 100% free
How do I use Discord with BHBot?
Starting from v45 BHBot is able to use Discord to notify you when specific events happen. To make this happen you need a dedicated channel on a server (you could also use a shared channel and this is not advised: if you do so, you'll share the notification with other people).
This guide assumes that you're going to create a dedicated channel, if you prefer to use an already existing channels just skip the unnecessary steps.
To get started:
-
Install the application on your favorite device (multiple versions are available based on your device)
-
If you haven't already create an account and log in your client of choice.
-
(Optional, skip if you already have a server) Once you're logged in create a new server. To do so refer to the official documentation.
-
(Optional, skip if you already have a channel) Create a dedicated channel for the notifications.
-
From the server menu select create channel
-
When prompted select "Text Channel", give your channel the name you like and click "Create Channel"
-
-
Once that you've created the channel
-
Edit the channel settings
-
Select the "Webhooks" pane and "Create Webhook"
-
Give your webhook the name you like, select the channel that you previously created, copy the webhook url and save
-
-
Edit your
settings.ini
file and add the url of the webhook you copied in the previous step to thediscordWebHookUrl
parameter
How do I check if the configuration is correct?
Starting from v34.1 you can use the test notification <your message>
command to send a test message. This command will also print output the following information taken from your settings.ini
:
- discordWebHookUrl
The discordWebHookUrl
printed by this command has to match with the one you got in your channel settings during the initial setup
What can be notified with Discord
You can configure how you want to be notified using dedicated settings in the settings.ini
file
Parameter Name | Parameter Type | Default Value | Description |
---|---|---|---|
enableDiscord |
True/False | 0 | Set this parameter to 1 to enable Discord notifications and to 0 to disable them |
discordWebHookUrl |
String | N/A | The URL used in the configuration (refer to the privious paragraphs) |
discordUserName |
String | Empty | The username you want to display in the notifications |
discordNotifyCrash |
True/False | 0 | 1 to be notified about crashes, 0 to disable crash notifications |
discordNotifyAlive |
Integer | 0 | Alive notifications to be triggered every n hours, set to 0 to disable alive notifications |
discordNotifyErrors |
True/False | 0 | 1 to be notified about errors, 0 to disable errors notifications |
discordNotifyPM |
True/False | 0 | 1 to be notified about PM, 0 to disable PM notifications |
discordNotifyBribe |
True/False | 0 | 1 to be notified of bribe attempts, 0 to disable bribe notifications |
discordNotifyDrop |
Multi Value String | 0 | Do you want to be notified of special drops? Add l for legendary, s for set, m for mythical |