Files
discord-rpc-godot/README.md
2023-04-27 09:07:15 +02:00

2.7 KiB

This is an early version! In future versions there will be lobbies, invites, linux builds etc. very soon!

Don't forget to run the following command if you clone this project or the godot-cpp folder will be empty

git submodule update --init

Addon Usage 🚀

  1. Download the addon
  2. Put the addons/ folder in your Godot project
  3. Enable the addon in your Project Settings under "Plugins" and "DiscordSDK". (if it doesn't show up restart your project and try again)
  4. Restart your project
  5. Create an Application under https://discord.com/developers/applications and get the Application ID
  6. (optional) Set images under "Rich Presence" and "Art Assets" and remember the keys
extends Node

func _ready():
	Discord_Activity.app_id = 1099618430065324082 # Application ID
	print("Discord working: " + str(Discord_Activity.get_is_discord_working())) # A boolean if everything worked
	Discord_Activity.details = "A demo activity by vaporvee#1231"
	Discord_Activity.state = "Checkpoint 23/23"
	
	Discord_Activity.large_image = "game" # Image key from "Art Assets"
	Discord_Activity.large_image_text = "Try it now!"
	Discord_Activity.small_image = "boss" # Image key from "Art Assets"
	Discord_Activity.small_image_text = "Fighting the end boss! D:"
	
	Discord_Activity.start_timestamp = int(Time.get_unix_time_from_system()) # "02:41 elapsed"
	# Discord_Activity.end_timestamp = int(Time.get_unix_time_from_system()) + 3600 # +1 hour in unix time

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

Then it should look like this:

Try a built demo

📨 Still questions? write an issue! I'll answer very fast :)


Extra Info

  • The Discord SDK itself doesn't build under Linux for some reason (I don't have a Mac so i don't even know if it's builds under OSX) its not well documented but I try as hard as i can to get it working crossplatform but at the time its only working under Windows... (But feel free to make pull requests btw)
  • Its an early release some features aren't implemented only because i need a small amount of time not because it's not possible


Credit

@Pukimaa - Logo Design


This project is not endorsed or affiliated with Discord Inc. or the Godot Foundation.