/GodotDiscordWebHooks

A Godot api to send messages via a discord web hook

Primary LanguageGDScriptMIT LicenseMIT

Welcome to GodotDiscordWebHooks

Warning

Be sure to check the unsupported features to ensure that you can use this plugin efficiently.

Checkout the api in action

Check the docs

Check the docs

Getting started

  1. To get started with GodotDiscordWebHooks install this plugin either from downloading / cloning the GitHub repository.
  2. Get a webhook url if you haven't already.
  3. Next you can create your first message

My first message

  1. After installing the files for GodotDiscordWebHooks, create a scene and attach a node to the root.
  2. Open the script and create a _ready() function.
# In res://Node.gd
func  _ready() -> void:
   pass
  1. Create a webhook object to send content and change the webhooks username. Remember to replace WEBHOOK_URL with your webhook's url. Get a webhook url if you haven't already.
# In res://Node.gd
func _read() -> void:
	var webhook := DiscordWebHook.new(WEBHOOK_URL)
	webhook.message("Hello from godot!")
	webhook.username("A robot")
	# DiscordWebHook allows chaining so the above code can also be written as:
	# webhook.message("Hello from godot!").username("A robot")
  1. Finally, we post the message, for this introduction we won't be doing anything with the response so we won't cast it
# In res://Node.gd
func _read() -> void:
	var webhook := DiscordWebHook.new(WEBHOOK_URL)
	webhook.message("Hello from godot!")
	webhook.username("A robot")

	# Post the message
	await webhook.post()

Get a webhook url

  1. Screenshot 2024-06-12 153035
  2. CreateWebhook
  3. GettingWebhookUrl

Api in action

Screenshot 2024-06-14 040147 Screenshot 2024-06-14 040403