search

Lachee / discord-rpc-unity

C# custom implementation for Discord Rich Presence. Unity package to easy add to your own games.
MIT License
39 stars 2 forks source link
discord discord-net discord-rich-presence discord-rpc discord-rpc-csharp library rich-presence rich-presence-discord unity unity3d

readme

Discord RPC Unity

GitHub package.json version
This package provides a wrapper for lachee/discord-rpc-csharp and a better experience when intergrating with Unity3D, as well as solving some tricky annoyances such as named pipes and mono.

Usage

Add the package to your project and look at the sample code. For more documentation about the RPC, check the discord-rpc-csharp documentation

Check out the documentation at https://lachee.github.io/discord-rpc-unity/

Dependencies

Installation

OpenUPM

The openupm registry is a open source package manager for Unity and provides the openupm-cli to manage your dependencies.

openupm add com.lachee.discordrpc

Manual UPM GitHub package.json version

Use the Unity Package Manager to add a git package. Adding the git to your UPM will limit updates as Unity will not track versioning on git projects (even though they totally could with tags).

  1. Open the Unity Package Manager and Add Package by git URL...
  2. https://github.com/Lachee/discord-rpc-unity.git

For local editable versions, manually clone the repo into your package folder. Note the exact spelling on destination name.

  1. git clone https://github.com/Lachee/discord-rpc-unity.git Packages/com.lachee.discordrpc

Unity Package

Go old school and download the Unity Package and import it into your project.

  1. Download the .unitypackage from the Releases or via the last run Create Release action.
  2. Import that package into your Unity3D

Logging

By default, the DiscordManager will log to the Unity Console while in the Editor. To enable logging in builds, create a Development Build and a new discordrpc.log file will be generated with your app when it runs.

Licensing

The license is MIT so do what you want;

However, i do appriciate attributations where possible and a link. Also if you plan to "fix" the library and sell it, please contribute back to this project with your fixes so others can benifit too.