2017-07-20 22:59:15 +00:00
# Discord RPC
2017-06-23 23:04:36 +00:00
2017-08-03 17:24:08 +00:00
This is a lib and quick demos that implement the very minimal subset to show current status, and
2017-07-31 22:58:46 +00:00
have callbacks for where a more complete game would do more things. 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.
2017-06-23 23:04:36 +00:00
2017-07-31 22:58:46 +00:00
PRs/feedback welcome if you have an improvement everyone might want, or can describe how this
doesn't meet your needs.
2017-07-20 22:59:15 +00:00
2017-08-16 21:00:00 +00:00
## Documentation
The most up to date documentation for Rich Presence can always be found in our [developer site ](https://discordapp.com/developers/docs/topics/rich-presence )!
2017-07-20 22:59:15 +00:00
## Usage
2017-07-31 22:58:46 +00:00
Zeroith, you should be set up to build things because you are a game developer, right?
2017-07-25 23:00:12 +00:00
First, head on over to the [Discord developers site ](https://discordapp.com/developers/applications/me )
2017-07-31 22:58:46 +00:00
and make yourself an app. Keep track of `Client ID` -- you'll need it here to pass to the init
function.
2017-07-25 23:00:12 +00:00
### From package
Download a release package, extract it, add `/include` to your compile includes, `/lib` to your
linker paths, and link with `discord-rpc` .
### From repo
2017-07-31 22:58:46 +00:00
There's a [CMake ](https://cmake.org/download/ ) file that should be able to generate the lib for
you; I use it like this:
2017-07-25 20:40:30 +00:00
```sh
2017-07-31 22:58:46 +00:00
cd < path to discord-rpc >
2017-07-20 22:59:15 +00:00
mkdir build
cd build
2017-07-31 22:58:46 +00:00
cmake .. -DCMAKE_INSTALL_PREFIX=< path to install discord-rpc to >
2017-07-25 23:00:12 +00:00
cmake --build . --config Release --target install
2017-07-20 22:59:15 +00:00
```
2017-07-31 22:58:46 +00:00
Sometimes I use the generated project files. There are a couple of CMake options you might care about:
| flag | default | does |
|------|---------|------|
| `ENABLE_IO_THREAD` | `ON` | When enabled, we start up a thread to do io processing, if disabled you should call `Discord_UpdateConnection` yourself.
| `BUILD_DYNAMIC_LIB` | `OFF` | Build library as a DLL
2017-07-20 22:59:15 +00:00
## Sample: send-presence
This is a text adventure "game" that inits/deinits the connection to Discord, and sends a presence
update on each command.
2017-08-03 17:24:08 +00:00
## Sample: button-clicker
This is a sample [Unity ](https://unity3d.com/ ) project that wraps a DLL version of the library, and
2017-08-16 21:00:00 +00:00
sends presence updates when you click on a button.
