1# Discord RPC
  2
  3This is a library for interfacing your game with a locally running Discord desktop client. It's known to work on Windows, macOS, and Linux. You can use the lib directly if you like, or use it as a guide to writing your own if it doesn't suit your game as is. PRs/feedback welcome if you have an improvement everyone might want, or can describe how this doesn't meet your needs.
  4
  5Included here are some quick demos that implement the very minimal subset to show current status, and
  6have callbacks for where a more complete game would do more things (joining, spectating, etc).
  7
  8## Documentation
  9
 10The most up to date documentation for Rich Presence can always be found on our [developer site](https://discordapp.com/developers/docs/rich-presence/how-to)! If you're interested in rolling your own native implementation of Rich Presence via IPC sockets instead of using our SDK—hey, you've got free time, right?—check out the ["Hard Mode" documentation](https://github.com/discordapp/discord-rpc/blob/master/documentation/hard-mode.md).
 11
 12## Basic Usage
 13
 14Zeroith, you should be set up to build things because you are a game developer, right?
 15
 16First, head on over to the [Discord developers site](https://discordapp.com/developers/applications/me) and make yourself an app. Keep track of `Client ID` -- you'll need it here to pass to the init function.
 17
 18### Unity Setup
 19
 20If you're a Unity developer looking to integrate Rich Presence into your game, follow this simple guide to get started towards success:
 21
 221. Download the DLLs for any platform that you need from [our releases](https://github.com/discordapp/discord-rpc/releases)
 232. In your Unity project, create a `Plugins` folder inside your `Assets` folder if you don't already have one
 243. Copy the file `DiscordRpc.cs` from [here](https://github.com/discordapp/discord-rpc/blob/master/examples/button-clicker/Assets/DiscordRpc.cs) into your `Assets` folder. This is basically your header file for the SDK
 25
 26We've got our `Plugins` folder ready, so let's get platform-specific!
 27
 28#### Windows
 29
 304. Create `x86` and `x86_64` folders inside `Assets/Plugins/`
 315. Copy `discord-rpc-win/win64-dynamic/bin/discord-rpc.dll` to `Assets/Plugins/x86_64/`
 326. Copy `discord-rpc-win/win32-dynamic/bin/discord-rpc.dll` to `Assets/Plugins/x86/`
 337. Click on both DLLs and make sure they are targetting the correct architectures in the Unity editor properties pane
 348. Done!
 35
 36#### MacOS
 37
 384. Copy `discord-rpc-osx/osx-dynamic/lib/libdiscord-rpc.dylib` to `Assets/Plugins/`
 395. Rename `libdiscord-rpc.dylib` to `discord-rpc.bundle`
 406. Done!
 41
 42#### Linux
 43
 444. Copy `discord-rpc-linux/linux-dynamic-lib/libdiscord-rpc.so` to `Assets/Plugins/`
 455. Done!
 46
 47You're ready to roll! For code examples on how to interact with the SDK using the `DiscordRpc.cs` header file, check out [our example](https://github.com/discordapp/discord-rpc/blob/master/examples/button-clicker/Assets/DiscordController.cs)
 48
 49### From package
 50
 51Download a release package for your platform(s) -- they have subdirs with various prebuilt options, select the one you need add `/include` to your compile includes, `/lib` to your linker paths, and link with `discord-rpc`. For the dynamically linked builds, you'll need to ship the associated file along with your game.
 52
 53### From repo
 54
 55First-eth, you'll want `CMake`. There's a few different ways to install it on your system, and you should refer to [their website](https://cmake.org/install/). Many package managers provide ways of installing CMake as well.
 56
 57To make sure it's installed correctly, type `cmake --version` into your flavor of terminal/cmd. If you get a response with a version number, you're good to go!
 58
 59There's a [CMake](https://cmake.org/download/) file that should be able to generate the lib for you; Sometimes I use it like this:
 60
 61```sh
 62    cd <path to discord-rpc>
 63    mkdir build
 64    cd build
 65    cmake .. -DCMAKE_INSTALL_PREFIX=<path to install discord-rpc to>
 66    cmake --build . --config Release --target install
 67```
 68
 69There is a wrapper build script `build.py` that runs `cmake` with a few different options.
 70
 71Usually, I run `build.py` to get things started, then use the generated project files as I work on things. It does depend on `click` library, so do a quick `pip install click` to make sure you have it if you want to run `build.py`.
 72
 73There are some CMake options you might care about:
 74
 75| flag                                                                                     | default | does                                                                                                                                                  |
 76| ---------------------------------------------------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
 77| `ENABLE_IO_THREAD`                                                                       | `ON`    | When enabled, we start up a thread to do io processing, if disabled you should call `Discord_UpdateConnection` yourself.                              |
 78| `USE_STATIC_CRT`                                                                         | `OFF`   | (Windows) Enable to statically link the CRT, avoiding requiring users install the redistributable package. (The prebuilt binaries enable this option) |
 79| [`BUILD_SHARED_LIBS`](https://cmake.org/cmake/help/v3.7/variable/BUILD_SHARED_LIBS.html) | `OFF`   | Build library as a DLL                                                                                                                                |
 80| `WARNINGS_AS_ERRORS`                                                                     | `OFF`   | When enabled, compiles with `-Werror` (on \*nix platforms).                                                                                           |
 81
 82## Continuous Builds
 83
 84Why do we have three of these? Three times the fun!
 85
 86| CI                   | badge                                                                                                                                            |
 87| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
 88| TravisCI             | [![Build status](https://travis-ci.org/discordapp/discord-rpc.svg?branch=master)](https://travis-ci.org/discordapp/discord-rpc)                  |
 89| AppVeyor             | [![Build status](https://ci.appveyor.com/api/projects/status/qvkoc0w1c4f4b8tj?svg=true)](https://ci.appveyor.com/project/crmarsh/discord-rpc)    |
 90| Buildkite (internal) | [![Build status](https://badge.buildkite.com/e103d79d247f6776605a15246352a04b8fd83d69211b836111.svg)](https://buildkite.com/discord/discord-rpc) |
 91
 92## Sample: send-presence
 93
 94This is a text adventure "game" that inits/deinits the connection to Discord, and sends a presence update on each command.
 95
 96## Sample: button-clicker
 97
 98This is a sample [Unity](https://unity3d.com/) project that wraps a DLL version of the library, and sends presence updates when you click on a button. Run `python build.py unity` in the root directory to build the correct library files and place them in their respective folders.
 99
100## Sample: unrealstatus
101
102This is a sample [Unreal](https://www.unrealengine.com) project that wraps the DLL version of the library with an Unreal plugin, exposes a blueprint class for interacting with it, and uses that to make a very simple UI. Run `python build.py unreal` in the root directory to build the correct library files and place them in their respective folders.
103
104### Using the Unreal Engine plugin with your own project
105
106To use the Rich Presense plugin with Unreal Engine Projects:
107
1081.  Download the latest [release](https://github.com/discordapp/discord-rpc/releases) for each operating system you are targeting and the zipped source code
1092.  In the source code zip, copy the UE plugin—`examples/unrealstatus/Plugins/discordrpc`—to your project's plugin directory
1103.  At `[YOUR_UE_PROJECT]/Plugins/discordrpc/source/ThirdParty/DiscordRpcLibrary/`, create an `Include` folder and copy `discord_rpc.h` and `discord_register.h` to it from the zip
1114.  Follow the steps below for each OS
1125.  Build your UE4 project
1136.  Launch the editor, and enable the Discord plugin.
114
115#### Windows
116
117- At `[YOUR_UE_PROJECT]/Plugins/discordrpc/source/ThirdParty/DiscordRpcLibrary/`, create a `Win64` folder
118- Copy `lib/discord-rpc.lib` and `bin/discord-rpc.dll` from `[RELEASE_ZIP]/win64-dynamic` to the `Win64` folder
119
120#### Mac
121
122- At `[YOUR_UE_PROJECT]/Plugins/discordrpc/source/ThirdParty/DiscordRpcLibrary/`, create a `Mac` folder
123- Copy `libdiscord-rpc.dylib` from `[RELEASE_ZIP]/osx-dynamic/lib` to the `Mac` folder
124
125#### Linux
126
127- At `[YOUR_UE_PROJECT]/Plugins/discordrpc/source/ThirdParty/DiscordRpcLibrary/`, create a `Linux` folder
128- Inside, create another folder `x86_64-unknown-linux-gnu`
129- Copy `libdiscord-rpc.so` from `[RELEASE_ZIP]/linux-dynamic/lib` to `Linux/x86_64-unknown-linux-gnu`
130
131## Wrappers and Implementations
132
133Below is a table of unofficial, community-developed wrappers for and implementations of Rich Presence in various languages. If you would like to have yours added, please make a pull request adding your repository to the table. The repository should include:
134
135- The code
136- A brief ReadMe of how to use it
137- A working example
138
139###### Rich Presence Wrappers and Implementations
140
141| Name                                                                      | Language                          |
142| ------------------------------------------------------------------------- | --------------------------------- |
143| [Discord RPC C#](https://github.com/Lachee/discord-rpc-csharp)            | C#                                |
144| [Discord RPC D](https://github.com/voidblaster/discord-rpc-d)             | [D](https://dlang.org/)           |
145| [discord-rpc.jar](https://github.com/Vatuu/discord-rpc 'Discord-RPC.jar') | Java                              |
146| [java-discord-rpc](https://github.com/MinnDevelopment/java-discord-rpc)   | Java                              |
147| [Discord-IPC](https://github.com/jagrosh/DiscordIPC)                      | Java                              |
148| [Discord Rich Presence](https://npmjs.org/discord-rich-presence)          | JavaScript                        |
149| [drpc4k](https://github.com/Bluexin/drpc4k)                               | [Kotlin](https://kotlinlang.org/) |
150| [lua-discordRPC](https://github.com/pfirsich/lua-discordRPC)              | LuaJIT (FFI)                      |
151| [pypresence](https://github.com/qwertyquerty/pypresence)                  | [Python](https://python.org/)     |
152| [SwordRPC](https://github.com/Azoy/SwordRPC)                              | [Swift](https://swift.org)        |