Skip to content

Home

Jump to bottom
Yannik edited this page Dec 17, 2023 · 57 revisions

Important

The GameSDK's Achievements, Applications, Voice, Images, Lobbies, Networking, Storage, and Store (purchases and discounts) features have been deprecated and will not be added.
However the rest is and will still be supported by Discord.

appleAbout MacOS Support

The plugin has been updated to Godot 4.1. The last 4.0.X release can be found here: https://github.com/vaporvee/discord-sdk-godot/releases/tag/2.3

Note

To make anything work in the plugin make sure to run

func _process(_delta):
    DiscordSDK.run_callbacks()

This happens normaly inside the Autoload wich should be automatically added by the plugin.
Something that does not get added automatically is your app_id. It is also mandatory to be able to use anything in the plugin.

DiscordSDK.app_id = #<your Application ID>

Quick start

Recommended Manual
1. Open the AssetLib tab in your Godot Editor.
2. Search for "discord" and install all the files from this plugin 		1. Download the addon
2. Put the addons/ folder in the root of your Godot project
  1. Enable the addon in your Project Settings under "Plugins" and "DiscordSDK".
    (Also adds DiscordSDKLoader autoload wich should be ignored. It needs to run in the background to comunicate with the Discord client)
  2. Restart your project with the window that should now appear.

  3. Create an Application under https://discord.com/developers/applications and get the Application ID
  4. While you're here, head to the "OAuth2" section of your application and add http://127.0.0.1 as a redirect URI for your application.
    (Discord says you should do that but it doesn't change anything)
  5. (optional) Set images under "Rich Presence" and "Art Assets" and remember the keys
  6. Create a gdscript wich gets run for example at startup wich looks something like the following
extends Node

func _ready():
	DiscordSDK.app_id = 1099618430065324082 # Application ID
	DiscordSDK.details = "A demo activity by vaporvee"
	DiscordSDK.state = "Checkpoint 23/23"
	
	DiscordSDK.large_image = "example_game" # Image key from "Art Assets"
	DiscordSDK.large_image_text = "Try it now!"
	DiscordSDK.small_image = "boss" # Image key from "Art Assets"
	DiscordSDK.small_image_text = "Fighting the end boss! D:"

	DiscordSDK.start_timestamp = int(Time.get_unix_time_from_system()) # "02:46 elapsed"
	# DiscordSDK.end_timestamp = int(Time.get_unix_time_from_system()) + 3600 # +1 hour in unix time / "01:00:00 remaining"

	DiscordSDK.refresh() # Always refresh after changing the values!

Then it will look similar to this:

Try a built demo

Troubleshooting

First of all try reinstalling the plugin and restart both your Godot Editor and your Discord client.

I have no errors in my Godot console from the plugin but my Activity doesn't show up in my Discord Client.

Make sure a `DiscordSDK.run_callbacks()` function runs in a `_process(delta)` function. This should happen in the Autoload added by the plugin. If it still doesn't help, try the Demo above. If still nothing appears in your Discord profile card, you have to reset the depending settings in you Discord or reinstall it.

I have a lot of `DiscordSDK not declared` errors spammed in my Godot Console and i can't use the plugin.

Make sure the plugin is actually enabled. Then the plugin should work and after the second restart you shouldn't get any errors from the plugin. But if it still gives you the errors delete the file `/addons/discord-sdk-gd/bin/.gdignore` and restart the editor manually.

Clone this wiki locally