mirrors/discord-rpc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Moar readme

Browse source
This commit is contained in:
Chris Marsh 2017-07-31 15:58:46 -07:00
parent 1e971e1161
commit 67a81b82cd
1 changed files with 19 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -1,16 +1,19 @@
# Discord RPC
This is a lib and a couple of quick demos, one that implements the very minimal subset to show
current status, and one that is more complete. The idea here is to give you an lib that implements
the rpc connection and wraps sending events, and a basic example that uses it; 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.
This is a lib and a quick demo that implements the very minimal subset to show current status, and
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.
PRs/feedback welcome if you have an improvement everyone might want.
PRs/feedback welcome if you have an improvement everyone might want, or can describe how this
doesn't meet your needs.
## Usage
Zeroith, you should be set up to build things because you are a game developer, right?
First, 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.
and make yourself an app. Keep track of `Client ID` -- you'll need it here to pass to the init
function.
### From package
@ -19,15 +22,21 @@ linker paths, and link with `discord-rpc`.
### From repo
There's a CMake file that should be able to generate the lib for you; I use it like this:
There's a [CMake](https://cmake.org/download/) file that should be able to generate the lib for
you; I use it like this:
```sh
cd /path/to/discord-rpc
cd <path to discord-rpc>
mkdir build
cd build
cmake .. -DCMAKE_INSTALL_PREFIX=/path/to/that
cmake .. -DCMAKE_INSTALL_PREFIX=<path to install discord-rpc to>
cmake --build . --config Release --target install
```
Sometimes I use the generated project files.
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
## Sample: send-presence