discoIPC icon indicating copy to clipboard operation
discoIPC copied to clipboard

Connect to the local Discord IPC Socket, for features like Rich Presence.

discoIPC

Connect to the local Discord IPC Socket, for features like Rich Presence_.

|GitHub release| |Known Vulnerabilities| |license| |Say Thanks!|

Installation

This is a Python_ module available through the PyPI_.

Before installing, download and install Python_. We recommend installing version 3.5+ of Python.

Installation is done using the pip install command:

.. code:: bash

$ pip install discoIPC

For more info, see pip install_ docs.

Get Started

Read the Wiki_ to see the available classes and methods and know how to use them.

Examples

  • Riddles: A small & simple text based riddles game showing the implementation of discoIPC_: https://github.com/k3rn31p4nic/riddles-rich-presence
  • DiscoIPC Examples: Example scripts that send Rich Presence to Discord using discoIPC_: https://github.com/An0n3m0us/DiscoIPC-Examples

If want to add some examples, feel free to open a PR.

Links

  • Discord Rich Presence Website_
  • Discord Developer Documentation_
  • Official Discord RPC Bindings_

Contributors

The developer of the discoIPC_ package is k3rn31p4nic_

List of all contributors_

License

GPL-3.0_

If you liked this project you can **⭐ Star** it on `GitHub`_ to show
your love.

.. _Python: https://python.org .. _PyPI: https://pypi.python.org/ .. _download and install Python: https://www.python.org/downloads/ .. _pip install: https://docs.python.org/3/installing/index.html .. _Wiki: https://github.com/k3rn31p4nic/discoIPC/wiki .. _Rich Presence: https://discordapp.com/rich-presence .. _Discord Rich Presence Website: https://discordapp.com/rich-presence .. _Discord Developer Documentation: https://discordapp.com/developers .. _Official Discord RPC Bindings: https://github.com/discordapp/discord-rpc .. _k3rn31p4nic: https://sankarsankampa.com .. _List of all contributors: https://github.com/k3rn31p4nic/discoIPC/graphs/contributors .. _GPL-3.0: https://github.com/k3rn31p4nic/discoIPC/blob/master/LICENSE.txt .. _GitHub: https://github.com/k3rn31p4nic/discoIPC

.. |GitHub release| image:: https://img.shields.io/github/release/k3rn31p4nic/discoIPC.svg?style=flat :target: https://github.com/k3rn31p4nic/discoIPC/releases .. |license| image:: https://img.shields.io/github/license/k3rn31p4nic/discoIPC.svg :target: LICENSE .. |Known Vulnerabilities| image:: https://snyk.io/test/github/k3rn31p4nic/discoIPC/badge.svg :target: https://snyk.io/test/github/k3rn31p4nic/discoIPC .. |Say Thanks!| image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg :target: https://saythanks.io/to/k3rn31p4nic