Unity-DiscordWebhook

Unity-DiscordWebhook is a library that allows you to easily send messages and files to Discord channels using webhooks. It provides a simple API for sending text messages, capturing and attaching screenshots, and even compressing and attaching log files for bug reports.

Features

• Sending messages and create posts/threads to text channels and forums.
• Builder pattern for creating a message.
• Awaitable API with UniTask
• Unity Coroutine and EditorCoroutine API. (IEnumerator and callback)
• A few Discord Bot API to query the server and channel information.
  • See DiscordBotApi.cs.
• Helper methods for creating a bug report.
  • Attach files by file path or byte array.
  • Attach images by Texture2D.
  • Capture and attach screenshots by setting a flag.
  • Compress all attached files to a zip file by setting a flag.
  • Get the message URL after sending a message.

Table of Contents

• Setup
  • Requirement
  • Installation
• Getting Started
  • Send a message to a text channel
  • Create a post in a forum with screenshots and log files
  • How do I get tag IDs from the forum?
• Use Cases

Setup

Requirement

• (Optional) Cysharp/UniTask
  • We recommend using UniTask for asynchronous programming. However, you can use the library without it, we provide Unity Coroutine API as well.
  • If your UniTask is not installed from Unity Package Manager, add the scripting define symbol DISCORD_WEBHOOK_UNITASK_SUPPORT to Project Settings.

Installation

Install via Unity Package Manager.

https://github.com/qwe321qwe321qwe321/Unity-DiscordWebhook.git?path=src/DiscordWebhook/Assets/DiscordWebhook

Getting Started

Send a message to a text channel

UniTaskSample.cs

WebhookResponseResult result = await WebhookBuilder.CreateTextChannel(textChannelWebhookUrl)
	.SetUsername("MyBot") // username is optional.
	.SetContent("Hello WORLD") // content is required.
	.ExecuteAsync();
// handle the result.

CoroutineSample.cs

WebhookBuilder.CreateTextChannel(textChannelWebhookUrl)
	.SetUsername("MyBot") // username is optional.
	.SetContent("Hello WORLD") // content is required.
	.ExecuteCoroutine(this, (result) => {
    	// handle the result with callback.
	}));

EditorCoroutineSample.cs

WebhookBuilder.CreateTextChannel(textChannelWebhookUrl)
	.SetUsername("MyBot") // username is optional.
	.SetContent("Hello WORLD") // content is required.
	.ExecuteEditorCoroutine((result) => { // No need a MonoBehaviour to run.
    	// handle the result with callback.
	}));

Create a post in a forum with screenshots and log files

UniTaskSample.cs

private async UniTaskVoid CreateBugReportTheadToForum() {
	string markdownContent = "# Bug report from user\nHere is the description.\n" + SystemInfoHelper.GetSystemInfoInMarkdownList();
	WebhookResponseResult result = await WebhookBuilder.CreateForum(forumWebhookUrl)
		.SetThreadName("TITLE")
		.SetContent(markdownContent)
		.AddTags(forumTagIds) // Add tags to the thread. (You have to get the tag IDs by DiscordBotApi upfront.)
		.SetCaptureScreenshot(true) // capture screenshot and attach it.
		.AddFile(Application.consoleLogPath) // add log file.
		.AddFile("systemInfo.txt", Encoding.UTF8.GetBytes(SystemInfoHelper.GetSystemInfoInMarkdownList())) // add system info.
		.SetCompressAllFilesToZip(true, "LogFiles") // compress the all files to a zip named "LogFiles.zip"
		.ExecuteAsync();
	
	if (result.isSuccess) {
		Debug.Log($"Success! {result.response}");
		
		string url = result.GetMessageURL(serverId);
		Debug.Log(url);
		if (url != null) {
			// Directly open the message in the browser.
			Application.OpenURL(url);
		}
	}
}

CoroutineSample.cs

private void CreateBugReportTheadToForum() {
	string markdownContent = "# Bug report from user\nHere is the description.\n" + SystemInfoHelper.GetSystemInfoInMarkdownList();
	WebhookBuilder.CreateForum(forumWebhookUrl)
		.SetThreadName("TITLE")
		.SetContent(markdownContent)
		.AddTags(forumTagIds) // Add tags to the thread. (You have to get the tag IDs by DiscordBotApi upfront.)
		.SetCaptureScreenshot(true) // capture screenshot and attach it.
		.AddFile(Application.consoleLogPath) // add log file.
		.AddFile("systemInfo.txt", Encoding.UTF8.GetBytes(SystemInfoHelper.GetSystemInfoInMarkdownList())) // add system info.
		.SetCompressAllFilesToZip(true, "LogFiles") // compress the all files to a zip named "LogFiles.zip"
		.ExecuteCoroutine(this, OnComplete);
	
	void OnComplete(WebhookResponseResult result) {
		if (result.isSuccess) {
			Debug.Log($"Success! {result.response}");
			
			string url = result.GetMessageURL(serverId);
			Debug.Log(url);
			if (url != null) {
				Application.OpenURL(url);
			}
		}
	}
}

Where can I find my User/Server/Message/Tag ID?

Turn on the Developer Mode and right-click on them.

(See More: https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID)

How to find the Tag ID from forums?

😜right-click on it.

Use Cases

CAVEAT: You should never directly expose your webhook token in a public product, as this poses a risk of allowing anyone to send any message through the webhook. The use cases here are either a limited scope of confidential users or implementing thier own backends to prevent from exposing the token to clients.

If you want your use case added to or removed from this list just open an issue.

Bionic Bay

Bug reporter for the in-house level editor.

In-game UI	Discord

Minds Beneath Us

In-game bug reporter for beta test.

In-game UI	Discord
24BBED0A00001.mp4

Nine Sols

In-game bug reporter with their own backend.

Autopanic Zero

Patch notes informer in Unity Editor.

---

I actually wrote an article that introduces the implementation of bug reports using Discord webhooks, covering its advantages and caveats, but it's in Chinese..