How to Setup Discord

Send a message to a Discord channel when an upload starts, finishes, or fails.

---

Where things get saved

• Edit->Preferences->Build Uploader->Services->Discord holds your bot token. Saved to your own PC only and never written into your project. Every person on your team enters their own.
• Project Settings->Build Uploader->Services->Discord holds server names, channel IDs and app names. Saved to <YourProjectPath>/BuildUploader/ and safe to commit so your team shares them.

Create the entry in Project Settings, then enter its secret in Preferences. The Name is what links the two - it must match exactly.

---

1. Create a Discord bot

• Go to the Discord developer dashboard
  • (Or press the Developer Dashboard button at the top of the Preferences page)
• Press New Application, give it a name (eg: Build Uploader) and press Create
• Get the token
  • Go to Bot in the left sidebar
  • Press Reset Token and confirm
  • Copy the token it shows you. You only get to see it once - if you lose it, reset it again
• Invite the bot to your server
  • Go to OAuth2 in the left sidebar
  • Under Scopes tick bot
  • Under Bot Permissions tick Send Messages
  • Copy the generated URL at the bottom, paste it into your browser, and pick the server to add the bot to
    • You need Manage Server permission on that Discord server to do this

---

2. Setup Preferences: Edit->Preferences->Build Uploader->Services->Discord

• Turn on Enabled
• Under Apps press + to create a new App
  • Name: anything you like. This is just a label so you can pick it in a dropdown later. eg: Release Bot
  • Token: paste the token from step 1
    • Tick Show if you want to see what you pasted

---

3. Setup Project Settings: Project Settings->Build Uploader->Services->Discord

Add the App

• Under Apps press +
  • Name: the exact same Name you used in Preferences
  • Is Bot: leave this on. Turn it off only if you are using a user token instead of a bot token

Add your server and channels

• Press Add Server at the top
  • Name: your Discord server name. Anything you like. eg: My Studio
  • Server ID: your Discord server ID (see below). Used to keep channels grouped in the UI
• Under Channels press + for each channel you want to post to
  • Name: anything you like. eg: Build Notifications
  • Channel ID: the real Discord channel ID. This one matters

Finding Server and Channel IDs

The easiest way is to read them out of the URL. Open Discord in a browser (or press a channel in the desktop app and look at the address), and you'll see:

https://discord.com/channels/123456789012345678/987654321098765432
                             ^ Server ID          ^ Channel ID

Alternatively, turn on User Settings->Advanced->Developer Mode in Discord, then right click any server or channel and press Copy Server ID / Copy Channel ID.

---

4. Use it in an Upload Config

• Go to Window->Build Uploader->Open Window
• Add a Discord Message Channel action to your Upload Config
  • App: the App you made
  • Server: the server you made
  • Channel: the channel you added
  • Text: the message. Supports {keys} - see String Formatter
  • Embeds: optional. Press + to add a nicely formatted box below the message
    • Title: the heading of the embed
    • Desc: the body text
    • Color: the coloured bar down the left side, as a hex value. eg: #009000 for green
    • All three support {keys}
• Set Triggers and When To Execute to control when it fires
  • eg: OnTaskFinished + Always posts once at the end whether the upload passed or failed
  • eg: OnTaskFinished + IfFailed only nags you when something broke