discord rpc

Discórdia RPC

Aviso de descontinuação

Esta biblioteca foi descontinuada em favor do GameSDK do Discord. Saiba mais aqui

---

Esta é uma biblioteca para fazer a interface do seu jogo com um cliente de desktop Discord executado localmente. É conhecido por funcionar em Windows, macOS e Linux. Você pode usar a biblioteca diretamente, se desejar, ou usá-la como um guia para escrever a sua própria biblioteca, caso ela não se adapte ao seu jogo como está. PRs/feedback são bem-vindos se você tiver uma melhoria que todos possam desejar ou puder descrever como isso não atende às suas necessidades.

Incluídas aqui estão algumas demonstrações rápidas que implementam o subconjunto mínimo para mostrar o status atual e têm retornos de chamada para onde um jogo mais completo faria mais coisas (entrar, assistir, etc.).

Documentação

A documentação mais atualizada do Rich Presence sempre pode ser encontrada em nosso site do desenvolvedor! Se você estiver interessado em implementar sua própria implementação nativa do Rich Presence por meio de soquetes IPC em vez de usar nosso SDK - ei, você tem tempo livre, certo? - verifique a documentação do "Modo Hard".

Uso Básico

Zeroith, você deveria estar preparado para construir coisas porque é um desenvolvedor de jogos, certo?

Primeiro, acesse o site de desenvolvedores do Discord e crie um aplicativo para você. Acompanhe o Client ID - você precisará dele aqui para passar para a função init.

Configuração do Unreal Engine 4

Para usar o plugin Rich Presense com projetos Unreal Engine:

1. Baixe a versão mais recente de cada sistema operacional de destino e o código-fonte compactado
2. No zip do código-fonte, copie o plugin UE examples/unrealstatus/Plugins/discordrpc — para o diretório de plugins do seu projeto
3. Em [YOUR_UE_PROJECT]/Plugins/discordrpc/source/ThirdParty/DiscordRpcLibrary/ , crie uma pasta Include e copie discord_rpc.h e discord_register.h para ela a partir do zip
4. Siga as etapas abaixo para cada sistema operacional
5. Construa seu projeto UE4
6. Inicie o editor e habilite o plugin Discord.

Windows

• Em [YOUR_UE_PROJECT]/Plugins/discordrpc/source/ThirdParty/DiscordRpcLibrary/ , crie uma pasta Win64
• Copie lib/discord-rpc.lib e bin/discord-rpc.dll de [RELEASE_ZIP]/win64-dynamic para a pasta Win64

Mac

• Em [YOUR_UE_PROJECT]/Plugins/discordrpc/source/ThirdParty/DiscordRpcLibrary/ , crie uma pasta Mac
• Copie libdiscord-rpc.dylib de [RELEASE_ZIP]/osx-dynamic/lib para a pasta Mac

Linux

• Em [YOUR_UE_PROJECT]/Plugins/discordrpc/source/ThirdParty/DiscordRpcLibrary/ , crie uma pasta Linux
• Dentro, crie outra pasta x86_64-unknown-linux-gnu
• Copie libdiscord-rpc.so de [RELEASE_ZIP]/linux-dynamic/lib para Linux/x86_64-unknown-linux-gnu

Configuração da unidade

Se você é um desenvolvedor Unity que deseja integrar o Rich Presence ao seu jogo, siga este guia simples para começar a ter sucesso:

1. Baixe as DLLs para qualquer plataforma que você precisar de nossos lançamentos
2. No seu projeto Unity, crie uma pasta Plugins dentro da sua pasta Assets se você ainda não tiver uma
3. Copie o arquivo DiscordRpc.cs daqui para sua pasta Assets . Este é basicamente o seu arquivo de cabeçalho para o SDK

Temos nossa pasta Plugins pronta, então vamos especificar a plataforma!

Windows

4. Crie pastas x86 e x86_64 dentro de Assets/Plugins/
5. Copie discord-rpc-win/win64-dynamic/bin/discord-rpc.dll para Assets/Plugins/x86_64/
6. Copie discord-rpc-win/win32-dynamic/bin/discord-rpc.dll para Assets/Plugins/x86/
7. Clique em ambas as DLLs e certifique-se de que elas estão direcionando as arquiteturas corretas no painel de propriedades do editor Unity
8. Feito!

Mac OS

4. Copie discord-rpc-osx/osx-dynamic/lib/libdiscord-rpc.dylib para Assets/Plugins/
5. Renomeie libdiscord-rpc.dylib para discord-rpc.bundle
6. Feito!

Linux

4. Copie discord-rpc-linux/linux-dynamic-lib/libdiscord-rpc.so para Assets/Plugins/
5. Feito!

Você está pronto para rolar! Para exemplos de código sobre como interagir com o SDK usando o arquivo de cabeçalho DiscordRpc.cs , confira nosso exemplo

Do pacote

Baixe um pacote de lançamento para sua(s) plataforma(s) - eles têm subdiretórios com várias opções pré-construídas, selecione aquele que você precisa adicionar /include às suas inclusões de compilação, /lib aos caminhos do vinculador e vincule com discord-rpc . Para as compilações vinculadas dinamicamente, você precisará enviar o arquivo associado junto com o jogo.

Do repositório

Primeiro, você vai querer CMake . Existem algumas maneiras diferentes de instalá-lo em seu sistema e você deve consultar o site delas. Muitos gerenciadores de pacotes também oferecem maneiras de instalar o CMake.

Para ter certeza de que está instalado corretamente, digite cmake --version em seu tipo de terminal/cmd. Se você receber uma resposta com um número de versão, estará pronto!

Há um arquivo CMake que deve ser capaz de gerar a biblioteca para você; Às vezes eu uso assim:

    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

Existe um script de construção wrapper build.py que executa cmake com algumas opções diferentes.

Normalmente, eu executo build.py para começar e, em seguida, uso os arquivos de projeto gerados enquanto trabalho nas coisas. Depende da biblioteca click , então faça um pip install click para ter certeza de que você o possui se quiser executar build.py .

Existem algumas opções do CMake que você pode gostar:

bandeira	padrão	faz
ENABLE_IO_THREAD	ON	Quando ativado, iniciamos um thread para fazer o processamento io; se desativado, você mesmo deve chamar Discord_UpdateConnection .
USE_STATIC_CRT	OFF	(Windows) Permite vincular estaticamente o CRT, evitando exigir que os usuários instalem o pacote redistribuível. (Os binários pré-construídos habilitam esta opção)
BUILD_SHARED_LIBS	OFF	Construir biblioteca como uma DLL
WARNINGS_AS_ERRORS	OFF	Quando habilitado, compila com -Werror (em plataformas *nix).

Construções contínuas

Por que temos três desses? Três vezes mais diversão!

IC	distintivo
TravisCI
AppVeyor
Buildkite (interno)

Amostra: envio de presença

Este é um "jogo" de aventura em texto que inicia/desativa a conexão com o Discord e envia uma atualização de presença a cada comando.

Exemplo: clicker de botão

Este é um exemplo de projeto do Unity que agrupa uma versão DLL da biblioteca e envia atualizações de presença quando você clica em um botão. Execute python build.py unity no diretório raiz para construir os arquivos de biblioteca corretos e colocá-los em suas respectivas pastas.

Amostra: status irreal

Este é um exemplo de projeto Unreal que envolve a versão DLL da biblioteca com um plug-in Unreal, expõe uma classe de blueprint para interagir com ela e usa isso para criar uma interface de usuário muito simples. Execute python build.py unreal no diretório raiz para construir os arquivos de biblioteca corretos e colocá-los em suas respectivas pastas.

Wrappers e Implementações

Abaixo está uma tabela de wrappers não oficiais desenvolvidos pela comunidade e implementações do Rich Presence em vários idiomas. Se você quiser que o seu seja adicionado, faça uma solicitação pull adicionando seu repositório à tabela. O repositório deve incluir:

• O código
• Um breve Leia-me de como usá-lo
• Um exemplo prático

Wrappers e implementações de presença avançada

Nome	Linguagem
Discórdia RPC C#	C#
Discord RPC D	D
discord-rpc.jar	Java
java-discord-rpc	Java
Discord-IPC	Java
Presença rica em discórdia	JavaScript
drpc4k	Kotlin
lua-discordRPC	LuaJIT (FFI)
presença de pi	Pitão
EspadaRPC	Rápido