From 29a488b54adf426e89e4fc053a082f767ad07d75 Mon Sep 17 00:00:00 2001 From: Louis <47295080+LouisRaverdy@users.noreply.github.com> Date: Thu, 30 Dec 2021 18:15:03 +0100 Subject: [PATCH] Update README.md --- README.md | 33 +++++++++++++++++++++++++++++++-- 1 file changed, 31 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 60be1c6..f6e6d26 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,31 @@ -# DiscordRPC -A Unreal Engine plugin for making presence and invite/join for Discord. +# Discord plugin for Unreal Engine 5 + +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) +