Update README.md

This commit is contained in:
Louis
2021-12-30 18:15:03 +01:00
committed by GitHub
parent 600888c175
commit 29a488b54a

View File

@@ -1,2 +1,31 @@
# DiscordRPC # Discord plugin for Unreal Engine 5
A Unreal Engine plugin for making presence and invite/join for Discord.
This plugin is designed for users of unreal engine 5. It will help you to create a discord presence for your game like this :
![image](https://user-images.githubusercontent.com/47295080/147771176-59649a7f-c255-45fe-ba55-c563d949ef42.png)
# Installation
1) Dowload this repostory
2) Extract the repo
3) Copy all content to your plugin project (YourProject/Plugins)
4) Make sure you are register on [Discord developer website](https://discord.com/developers/applications "Discord Developer Website")
5) Create your application and copy your Application ID
6) Open your project and enable the plugin
# Initialization
In order to establish a connection with the application you have created before and the discord app
You need to create something like this in your **Game Instance** :
![InitDiscord](https://user-images.githubusercontent.com/47295080/147773538-c4ac76cd-2199-4a1a-af90-cc695d8c0386.png)
# Nodes
For edit your presence in your game use this code (read the image next to it to understand the fields of the node) :
![SetPresenceDiscord](https://user-images.githubusercontent.com/47295080/147773549-6f106fda-835d-4cff-97f8-c220627b2dbf.png)
> **Note :** For use image in rich presence you need to upload them on your Discord developer game page (Rich Presence -> Art Assets)