vaporvee/discord-rpc-godot
1
2
Fork 0
Code Issues 1 Pull Requests 1 Actions Releases 20 Wiki Activity

Updated Readme.md added links

Browse Source
This commit is contained in:
Yannik
2023-04-23 13:36:49 +02:00
committed by GitHub
parent dbefe3acdc
commit 84db87503e
1 changed files with 10 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -6,11 +6,12 @@ Don't forget to run the following command **if you clone this project** or the g
git submodule update --init
```
# Addon Usage :rocket:
1. Put the `discord-sdk-gd/` folder in a `addons/` folder in your Godot project
2. Enable the addon in your Project Settings under "Plugins" and "DiscordSDK". (if it doesn't show up reopen the project)
3. Create an Application under https://discord.com/developers/applications and get the Application ID
4. (optional) Set images under "Rich Presence" and "Art Assets" and remember the keys
5. Exporting: You need to copy the `discord_game_sdk.dll` or on linux `discord_game_sdk.so` from `res://addons/discord-sdk-gd/bin/PLATFORM/discord_game_sdk.[dll/.so]` to your exported project in the same directory as `discord_game_sdk_binding_debug.[dll/.so]`
1. [Download the addon](https://github.com/vaporvee/discord-sdk-godot/releases/latest/)
2. Put the `discord-sdk-gd/` folder in a `addons/` folder in your Godot project
3. Enable the addon in your Project Settings under "Plugins" and "DiscordSDK". (if it doesn't show up reopen the project)
4. Create an Application under https://discord.com/developers/applications and get the Application ID
5. (optional) Set images under "Rich Presence" and "Art Assets" and remember the keys
6. Exporting: You need to copy the `discord_game_sdk.dll` or on linux `discord_game_sdk.so` from `res://addons/discord-sdk-gd/bin/PLATFORM/discord_game_sdk.[dll/.so]` to your exported project in the same directory as `discord_game_sdk_binding_debug.[dll/.so]`
```gdscript
extends Node
@@ -33,6 +34,10 @@ func _ready():
#### Then it should look like this:
<img src="https://cdn.discordapp.com/attachments/825019604207927326/1099642861256970311/activity.webp">
### [Try a built demo](https://github.com/vaporvee/discord-sdk-godot/releases/download/1.0/Demo-Export.zip)
<br />
## Extra Info
- "Step 2" (enabling the addon) is needed to add `Discord_Activity.coreupdate()` to a `_process()` function with a singleton. This function is needed by pretty everything but you can it also just add it yourself.
- 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)