README.md
1# Discord RPC
2
3## Deprecation Notice
4
5This library has been deprecated in favor of Discord's GameSDK. [Learn more here](https://discordapp.com/developers/docs/game-sdk/sdk-starter-guide)
6
7---
8
9This 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.
10
11Included here are some quick demos that implement the very minimal subset to show current status, and
12have callbacks for where a more complete game would do more things (joining, spectating, etc).
13
14## Documentation
15
16The 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).
17
18## Basic Usage
19
20Zeroith, you should be set up to build things because you are a game developer, right?
21
22First, 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.
23
24### Unreal Engine 4 Setup
25
26To use the Rich Presense plugin with Unreal Engine Projects:
27
281. Download the latest [release](https://github.com/discordapp/discord-rpc/releases) for each operating system you are targeting and the zipped source code
292. In the source code zip, copy the UE plugin—`examples/unrealstatus/Plugins/discordrpc`—to your project's plugin directory
303. 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
314. Follow the steps below for each OS
325. Build your UE4 project
336. Launch the editor, and enable the Discord plugin.
34
35#### Windows
36
37- At `[YOUR_UE_PROJECT]/Plugins/discordrpc/source/ThirdParty/DiscordRpcLibrary/`, create a `Win64` folder
38- Copy `lib/discord-rpc.lib` and `bin/discord-rpc.dll` from `[RELEASE_ZIP]/win64-dynamic` to the `Win64` folder
39
40#### Mac
41
42- At `[YOUR_UE_PROJECT]/Plugins/discordrpc/source/ThirdParty/DiscordRpcLibrary/`, create a `Mac` folder
43- Copy `libdiscord-rpc.dylib` from `[RELEASE_ZIP]/osx-dynamic/lib` to the `Mac` folder
44
45#### Linux
46
47- At `[YOUR_UE_PROJECT]/Plugins/discordrpc/source/ThirdParty/DiscordRpcLibrary/`, create a `Linux` folder
48- Inside, create another folder `x86_64-unknown-linux-gnu`
49- Copy `libdiscord-rpc.so` from `[RELEASE_ZIP]/linux-dynamic/lib` to `Linux/x86_64-unknown-linux-gnu`
50
51### Unity Setup
52
53If you're a Unity developer looking to integrate Rich Presence into your game, follow this simple guide to get started towards success:
54
551. Download the DLLs for any platform that you need from [our releases](https://github.com/discordapp/discord-rpc/releases)
562. In your Unity project, create a `Plugins` folder inside your `Assets` folder if you don't already have one
573. 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
58
59We've got our `Plugins` folder ready, so let's get platform-specific!
60
61#### Windows
62
634. Create `x86` and `x86_64` folders inside `Assets/Plugins/`
645. Copy `discord-rpc-win/win64-dynamic/bin/discord-rpc.dll` to `Assets/Plugins/x86_64/`
656. Copy `discord-rpc-win/win32-dynamic/bin/discord-rpc.dll` to `Assets/Plugins/x86/`
667. Click on both DLLs and make sure they are targetting the correct architectures in the Unity editor properties pane
678. Done!
68
69#### MacOS
70
714. Copy `discord-rpc-osx/osx-dynamic/lib/libdiscord-rpc.dylib` to `Assets/Plugins/`
725. Rename `libdiscord-rpc.dylib` to `discord-rpc.bundle`
736. Done!
74
75#### Linux
76
774. Copy `discord-rpc-linux/linux-dynamic-lib/libdiscord-rpc.so` to `Assets/Plugins/`
785. Done!
79
80You'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)
81
82### From package
83
84Download 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.
85
86### From repo
87
88First-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.
89
90To 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!
91
92There's a [CMake](https://cmake.org/download/) file that should be able to generate the lib for you; Sometimes I use it like this:
93
94```sh
95 cd <path to discord-rpc>
96 mkdir build
97 cd build
98 cmake .. -DCMAKE_INSTALL_PREFIX=<path to install discord-rpc to>
99 cmake --build . --config Release --target install
100```
101
102There is a wrapper build script `build.py` that runs `cmake` with a few different options.
103
104Usually, 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`.
105
106There are some CMake options you might care about:
107
108| flag | default | does |
109| ---------------------------------------------------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
110| `ENABLE_IO_THREAD` | `ON` | When enabled, we start up a thread to do io processing, if disabled you should call `Discord_UpdateConnection` yourself. |
111| `USE_STATIC_CRT` | `OFF` | (Windows) Enable to statically link the CRT, avoiding requiring users install the redistributable package. (The prebuilt binaries enable this option) |
112| [`BUILD_SHARED_LIBS`](https://cmake.org/cmake/help/v3.7/variable/BUILD_SHARED_LIBS.html) | `OFF` | Build library as a DLL |
113| `WARNINGS_AS_ERRORS` | `OFF` | When enabled, compiles with `-Werror` (on \*nix platforms). |
114
115## Continuous Builds
116
117Why do we have three of these? Three times the fun!
118
119| CI | badge |
120| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
121| TravisCI | [](https://travis-ci.org/discordapp/discord-rpc) |
122| AppVeyor | [](https://ci.appveyor.com/project/crmarsh/discord-rpc) |
123| Buildkite (internal) | [](https://buildkite.com/discord/discord-rpc) |
124
125## Sample: send-presence
126
127This is a text adventure "game" that inits/deinits the connection to Discord, and sends a presence update on each command.
128
129## Sample: button-clicker
130
131This 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.
132
133## Sample: unrealstatus
134
135This 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.
136
137## Wrappers and Implementations
138
139Below 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:
140
141- The code
142- A brief ReadMe of how to use it
143- A working example
144
145###### Rich Presence Wrappers and Implementations
146
147| Name | Language |
148| ------------------------------------------------------------------------- | --------------------------------- |
149| [Discord RPC C#](https://github.com/Lachee/discord-rpc-csharp) | C# |
150| [Discord RPC D](https://github.com/voidblaster/discord-rpc-d) | [D](https://dlang.org/) |
151| [discord-rpc.jar](https://github.com/Vatuu/discord-rpc 'Discord-RPC.jar') | Java |
152| [java-discord-rpc](https://github.com/MinnDevelopment/java-discord-rpc) | Java |
153| [Discord-IPC](https://github.com/jagrosh/DiscordIPC) | Java |
154| [Discord Rich Presence](https://npmjs.org/discord-rich-presence) | JavaScript |
155| [drpc4k](https://github.com/Bluexin/drpc4k) | [Kotlin](https://kotlinlang.org/) |
156| [lua-discordRPC](https://github.com/pfirsich/lua-discordRPC) | LuaJIT (FFI) |
157| [pypresence](https://github.com/qwertyquerty/pypresence) | [Python](https://python.org/) |
158| [SwordRPC](https://github.com/Azoy/SwordRPC) | [Swift](https://swift.org) |
159
){kind=link}
){kind=link}