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

Updated GitHub stuff

Browse Source
This commit is contained in:
Yannik
2023-05-14 12:01:32 +02:00
parent 0c9e4123b7
commit 5e080bc846
2 changed files with 20 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
README.md
View File

@@ -1,52 +1,21 @@
<img src="/project/assets/Banner.svg" alt="Project Banner" />
![HitCount](https://hits.dwyl.com/vaporvee/discord-sdk-godot.svg)
### :warning: This is an early version! MacOS support still doesn't work! In future versions there also will be invites, user info etc. very soon!
Don't forget to run the following command **if you clone this project** or files will be missing
```sh
python setup.py
```
# Addon Usage :rocket:
1. [Download the addon](https://github.com/vaporvee/discord-sdk-godot/releases/latest/download/ADDON-Discord-SDK-Godot.zip/)
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
```gdscript
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:46 elapsed"
# Discord_Activity.end_timestamp = int(Time.get_unix_time_from_system()) + 3600 # +1 hour in unix time / "01:00 remaining"
Discord_Activity.refresh() # Always refresh after changing the values!
```
#### Then it will look similar to this:
<img src="/project/assets/ActivityPreview.svg" alt="Activity Preview" />
### [Try a built demo](https://github.com/vaporvee/discord-sdk-godot/releases/latest/download/Demo-Export.zip)
:incoming_envelope: Still questions? write an [issue](https://github.com/vaporvee/discord-sdk-godot/issues)! I'll answer very fast :)
**:warning: This is an early version! MacOS support still doesn't work! In future versions there also will be invites, user info etc. very soon!**
**Discord Game SDK support for GDScript in Godot Engine 4.0. with the easiest code pattern!**<br><br>
**Please leave a star that would really help! And thanks to all the people that already starred this project! ❤️**
<br />
<br />
# [Quick start :rocket: (click here)](https://github.com/vaporvee/discord-sdk-godot/wiki/Quick-start)
<br />
**A small donation with the sponsor button would be nice if you sell your project with this addon but is of course not mandatory!**
<br />
### Credit
[@Pukimaa](https://github.com/pukimaa) - Designer<br>
[@koyuawsmbrtn](https://github.com/koyuawsmbrtn) - Getting it to work on MacOS (shes giving her best)
<br />
*This project is not endorsed or affiliated with Discord Inc. or the Godot Foundation.*