Permalink
Browse files

Merge pull request #6983 from yourWaifu/add-discord-rpc-support

Add Discord Rich Presence support
  • Loading branch information...
delroth committed Jun 24, 2018
2 parents 7388094 + 63f0345 commit 2cfdf89898c4689884fbffb1c693ec24a7083f66
Showing with 18,060 additions and 4 deletions.
  1. +8 −0 CMakeLists.txt
  2. +28 −0 Externals/discord-rpc/CMakeLists.txt
  3. +19 −0 Externals/discord-rpc/LICENSE
  4. +91 −0 Externals/discord-rpc/README.md
  5. +304 −0 Externals/discord-rpc/build.py
  6. +26 −0 Externals/discord-rpc/include/discord_register.h
  7. +87 −0 Externals/discord-rpc/include/discord_rpc.h
  8. +142 −0 Externals/discord-rpc/src/CMakeLists.txt
  9. +40 −0 Externals/discord-rpc/src/backoff.h
  10. +19 −0 Externals/discord-rpc/src/connection.h
  11. +122 −0 Externals/discord-rpc/src/connection_unix.cpp
  12. +128 −0 Externals/discord-rpc/src/connection_win.cpp
  13. +93 −0 Externals/discord-rpc/src/discord-rpc.vcxproj
  14. +100 −0 Externals/discord-rpc/src/discord_register_linux.cpp
  15. +80 −0 Externals/discord-rpc/src/discord_register_osx.m
  16. +185 −0 Externals/discord-rpc/src/discord_register_win.cpp
  17. +500 −0 Externals/discord-rpc/src/discord_rpc.cpp
  18. +8 −0 Externals/discord-rpc/src/dllmain.cpp
  19. +36 −0 Externals/discord-rpc/src/msg_queue.h
  20. +141 −0 Externals/discord-rpc/src/rpc_connection.cpp
  21. +59 −0 Externals/discord-rpc/src/rpc_connection.h
  22. +245 −0 Externals/discord-rpc/src/serialization.cpp
  23. +215 −0 Externals/discord-rpc/src/serialization.h
  24. +271 −0 Externals/discord-rpc/thirdparty/include/rapidjson/allocators.h
  25. +2,575 −0 Externals/discord-rpc/thirdparty/include/rapidjson/document.h
  26. +299 −0 Externals/discord-rpc/thirdparty/include/rapidjson/encodedstream.h
  27. +716 −0 Externals/discord-rpc/thirdparty/include/rapidjson/encodings.h
  28. +74 −0 Externals/discord-rpc/thirdparty/include/rapidjson/error/en.h
  29. +155 −0 Externals/discord-rpc/thirdparty/include/rapidjson/error/error.h
  30. +99 −0 Externals/discord-rpc/thirdparty/include/rapidjson/filereadstream.h
  31. +104 −0 Externals/discord-rpc/thirdparty/include/rapidjson/filewritestream.h
  32. +151 −0 Externals/discord-rpc/thirdparty/include/rapidjson/fwd.h
  33. +290 −0 Externals/discord-rpc/thirdparty/include/rapidjson/internal/biginteger.h
  34. +258 −0 Externals/discord-rpc/thirdparty/include/rapidjson/internal/diyfp.h
  35. +245 −0 Externals/discord-rpc/thirdparty/include/rapidjson/internal/dtoa.h
  36. +78 −0 Externals/discord-rpc/thirdparty/include/rapidjson/internal/ieee754.h
  37. +304 −0 Externals/discord-rpc/thirdparty/include/rapidjson/internal/itoa.h
  38. +181 −0 Externals/discord-rpc/thirdparty/include/rapidjson/internal/meta.h
  39. +55 −0 Externals/discord-rpc/thirdparty/include/rapidjson/internal/pow10.h
  40. +701 −0 Externals/discord-rpc/thirdparty/include/rapidjson/internal/regex.h
  41. +230 −0 Externals/discord-rpc/thirdparty/include/rapidjson/internal/stack.h
  42. +55 −0 Externals/discord-rpc/thirdparty/include/rapidjson/internal/strfunc.h
  43. +269 −0 Externals/discord-rpc/thirdparty/include/rapidjson/internal/strtod.h
  44. +46 −0 Externals/discord-rpc/thirdparty/include/rapidjson/internal/swap.h
  45. +115 −0 Externals/discord-rpc/thirdparty/include/rapidjson/istreamwrapper.h
  46. +70 −0 Externals/discord-rpc/thirdparty/include/rapidjson/memorybuffer.h
  47. +71 −0 Externals/discord-rpc/thirdparty/include/rapidjson/memorystream.h
  48. +316 −0 Externals/discord-rpc/thirdparty/include/rapidjson/msinttypes/inttypes.h
  49. +300 −0 Externals/discord-rpc/thirdparty/include/rapidjson/msinttypes/stdint.h
  50. +81 −0 Externals/discord-rpc/thirdparty/include/rapidjson/ostreamwrapper.h
  51. +1,358 −0 Externals/discord-rpc/thirdparty/include/rapidjson/pointer.h
  52. +255 −0 Externals/discord-rpc/thirdparty/include/rapidjson/prettywriter.h
  53. +615 −0 Externals/discord-rpc/thirdparty/include/rapidjson/rapidjson.h
  54. +1,879 −0 Externals/discord-rpc/thirdparty/include/rapidjson/reader.h
  55. +2,006 −0 Externals/discord-rpc/thirdparty/include/rapidjson/schema.h
  56. +179 −0 Externals/discord-rpc/thirdparty/include/rapidjson/stream.h
  57. +117 −0 Externals/discord-rpc/thirdparty/include/rapidjson/stringbuffer.h
  58. +610 −0 Externals/discord-rpc/thirdparty/include/rapidjson/writer.h
  59. +2 −0 Externals/licenses.md
  60. +1 −0 Source/Core/Core/CMakeLists.txt
  61. +14 −0 Source/Core/Core/Config/UISettings.cpp
  62. +21 −0 Source/Core/Core/Config/UISettings.h
  63. +5 −0 Source/Core/Core/ConfigLoaders/IsSettingSaveable.cpp
  64. +2 −0 Source/Core/Core/Core.vcxproj
  65. +6 −0 Source/Core/Core/Core.vcxproj.filters
  66. +4 −0 Source/Core/DolphinNoGUI/CMakeLists.txt
  67. +7 −0 Source/Core/DolphinNoGUI/MainNoGUI.cpp
  68. +4 −0 Source/Core/DolphinQt2/CMakeLists.txt
  69. +2 −2 Source/Core/DolphinQt2/DolphinQt2.vcxproj
  70. +7 −0 Source/Core/DolphinQt2/MainWindow.cpp
  71. +19 −0 Source/Core/DolphinQt2/Settings/GeneralPane.cpp
  72. +3 −0 Source/Core/DolphinQt2/Settings/GeneralPane.h
  73. +4 −0 Source/Core/DolphinWX/CMakeLists.txt
  74. +32 −0 Source/Core/DolphinWX/Config/GeneralConfigPane.cpp
  75. +6 −0 Source/Core/DolphinWX/Config/GeneralConfigPane.h
  76. +2 −2 Source/Core/DolphinWX/DolphinWX.vcxproj
  77. +7 −0 Source/Core/DolphinWX/FrameTools.cpp
  78. +6 −0 Source/Core/UICommon/CMakeLists.txt
  79. +73 −0 Source/Core/UICommon/DiscordPresence.cpp
  80. +13 −0 Source/Core/UICommon/DiscordPresence.h
  81. +3 −0 Source/Core/UICommon/UICommon.cpp
  82. +5 −0 Source/Core/UICommon/UICommon.vcxproj
  83. +1 −0 Source/VSProps/Base.props
  84. +7 −0 Source/dolphin-emu.sln
View
@@ -28,6 +28,7 @@ option(ENABLE_HEADLESS "Enables running Dolphin as a headless variant" OFF)
option(ENABLE_ALSA "Enables ALSA sound backend" ON)
option(ENABLE_PULSEAUDIO "Enables PulseAudio sound backend" ON)
option(ENABLE_LLVM "Enables LLVM support, for disassembly" ON)
option(USE_DISCORD_PRESENCE "Enables Discord Rich Presence, show the current game on Discord" ON)
# Maintainers: if you consider blanket disabling this for your users, please
# consider the following points:
@@ -366,6 +367,7 @@ if(ANDROID)
set(USE_EGL 1)
set(ENABLE_WX 0)
set(ENABLE_QT2 0)
set(USE_DISCORD_PRESENCE 0)
# We are cross compiling, search only the toolchain for libraries and includes
SET(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
@@ -388,6 +390,7 @@ if(ENABLE_HEADLESS)
set(USE_X11 0)
set(ENABLE_WX 0)
set(ENABLE_QT2 0)
set(USE_DISCORD_PRESENCE 0)
add_definitions(-DUSE_HEADLESS)
endif()
@@ -717,6 +720,11 @@ if(ENABLE_WX)
endif()
endif()
if(USE_DISCORD_PRESENCE)
message(STATUS "Using static DiscordRPC from Externals")
add_subdirectory(Externals/discord-rpc)
endif()
find_package(Libsystemd)
if(SYSTEMD_FOUND)
message(STATUS "libsystemd found, enabling traversal server watchdog support")
@@ -0,0 +1,28 @@
cmake_minimum_required (VERSION 3.2.0)
project (DiscordRPC)
include(GNUInstallDirs)
# format
file(GLOB_RECURSE ALL_SOURCE_FILES
include/*.h
src/*.cpp src/*.h src/*.c
)
# Set CLANG_FORMAT_SUFFIX if you are using custom clang-format, e.g. clang-format-5.0
find_program(CLANG_FORMAT_CMD clang-format${CLANG_FORMAT_SUFFIX})
if (CLANG_FORMAT_CMD)
add_custom_target(
clangformat
COMMAND ${CLANG_FORMAT_CMD}
-i -style=file -fallback-style=none
${ALL_SOURCE_FILES}
DEPENDS
${ALL_SOURCE_FILES}
)
endif(CLANG_FORMAT_CMD)
# add subdirs
add_subdirectory(src)
@@ -0,0 +1,19 @@
Copyright 2017 Discord, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
@@ -0,0 +1,91 @@
# Discord RPC
This 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.
Included here are some quick demos that implement the very minimal subset to show current status, and
have callbacks for where a more complete game would do more things (joining, spectating, etc).
## Documentation
The 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).
## Basic 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 to pass to the init function.
### From package
Download 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.
### From repo
First-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.
To 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!
There's a [CMake](https://cmake.org/download/) file that should be able to generate the lib for you; Sometimes I use it like this:
```sh
cd <path to discord-rpc>
mkdir build
cd build
cmake .. -DCMAKE_INSTALL_PREFIX=<path to install discord-rpc to>
cmake --build . --config Release --target install
```
There is a wrapper build script `build.py` that runs `cmake` with a few different options.
Usually, 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`.
There are some 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.
| `USE_STATIC_CRT` | `OFF` | (Windows) Enable to statically link the CRT, avoiding requiring users install the redistributable package. (The prebuilt binaries enable this option)
| [`BUILD_SHARED_LIBS`](https://cmake.org/cmake/help/v3.7/variable/BUILD_SHARED_LIBS.html) | `OFF` | Build library as a DLL
| `WARNINGS_AS_ERRORS` | `OFF` | When enabled, compiles with `-Werror` (on *nix platforms). |
## Continuous Builds
Why do we have three of these? Three times the fun!
| CI | badge |
|----|-------|
| TravisCI | [![Build status](https://travis-ci.org/discordapp/discord-rpc.svg?branch=master)](https://travis-ci.org/discordapp/discord-rpc)
| AppVeyor | [![Build status](https://ci.appveyor.com/api/projects/status/qvkoc0w1c4f4b8tj?svg=true)](https://ci.appveyor.com/project/crmarsh/discord-rpc)
| Buildkite (internal) | [![Build status](https://badge.buildkite.com/e103d79d247f6776605a15246352a04b8fd83d69211b836111.svg)](https://buildkite.com/discord/discord-rpc)
## Sample: send-presence
This is a text adventure "game" that inits/deinits the connection to Discord, and sends a presence update on each command.
## Sample: button-clicker
This 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.
## Sample: unrealstatus
This 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.
## Wrappers and Implementations
Below 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:
- The code
- A brief ReadMe of how to use it
- A working example
###### Rich Presence Wrappers and Implementations
| Name | Language |
|------|----------|
| [DerelictDiscordRPC](https://github.com/voidblaster/DerelictDiscordRPC) | [D](https://dlang.org/) |
| [discord-rpc.jar](https://github.com/Vatuu/discord-rpc "Discord-RPC.jar") | Java |
| [java-discord-rpc](https://github.com/MinnDevelopment/java-discord-rpc) | Java |
| [Discord-IPC](https://github.com/jagrosh/DiscordIPC) | Java |
| [Discord Rich Presence](https://npmjs.org/discord-rich-presence) | JavaScript |
| [drpc4k](https://github.com/Bluexin/drpc4k) | [Kotlin](https://kotlinlang.org/) |
| [lua-discordRPC](https://github.com/pfirsich/lua-discordRPC) | LuaJIT (FFI) |
| [pypresence](https://github.com/qwertyquerty/pypresence) | [Python](https://python.org/) |
| [SwordRPC](https://github.com/Azoy/SwordRPC) | [Swift](https://swift.org) |
Oops, something went wrong.

0 comments on commit 2cfdf89

Please sign in to comment.