summaryrefslogtreecommitdiff
path: root/desktop/node_modules/@xhayper/discord-rpc/README.md
diff options
context:
space:
mode:
authorRaindropsSys <raindrops@equestria.dev>2023-10-27 22:29:56 +0200
committerRaindropsSys <raindrops@equestria.dev>2023-10-27 22:29:56 +0200
commit4d4308c46d4f7801c657cc79d2243e1a81831334 (patch)
treea2e392e0af92b9a3ca3d1b5afb841640276e2294 /desktop/node_modules/@xhayper/discord-rpc/README.md
parent9f9d66afebc59c6c265c4424f7b8fb36d8876541 (diff)
downloadmist-4d4308c46d4f7801c657cc79d2243e1a81831334.tar.gz
mist-4d4308c46d4f7801c657cc79d2243e1a81831334.tar.bz2
mist-4d4308c46d4f7801c657cc79d2243e1a81831334.zip
Updated 32 files, added 279 files, deleted 3 files and renamed 14 files (automated)
Diffstat (limited to 'desktop/node_modules/@xhayper/discord-rpc/README.md')
-rw-r--r--desktop/node_modules/@xhayper/discord-rpc/README.md66
1 files changed, 66 insertions, 0 deletions
diff --git a/desktop/node_modules/@xhayper/discord-rpc/README.md b/desktop/node_modules/@xhayper/discord-rpc/README.md
new file mode 100644
index 0000000..1a33d5f
--- /dev/null
+++ b/desktop/node_modules/@xhayper/discord-rpc/README.md
@@ -0,0 +1,66 @@
+<!-- markdownlint-disable -->
+<div align="center">
+ <br />
+ <h3>@xhayper/discord-rpc</h3>
+ <br />
+ <p>
+ <a href="https://www.npmjs.com/package/@xhayper/discord-rpc" target="_blank"><img src="https://img.shields.io/npm/v/@xhayper/discord-rpc.svg" alt="npm version"/></a>
+ <a href="https://discord.com/invite/xTAR8nUs2g" target="_blank"><img src="https://img.shields.io/discord/965168309731487805.svg" alt="discord"/></a>
+ <a href="https://github.com/xhayper/discord-rpc/blob/main/LICENSE" target="_blank"><img src="https://img.shields.io/github/license/xhayper/discord-rpc.svg" alt="license"/></a>
+ </p>
+</div>
+<!-- markdownlint-enable -->
+
+## About
+
+`@xhayper/discord-rpc` is a fork of [discordjs/RPC](https://github.com/discordjs/RPC) with type safety and some additional features.
+
+Looking for Deno version? Check out [discord_rpc_deno](https://github.com/xhayper/discord-rpc-deno)!
+
+## Features
+
+- flatpak / snap support
+- Low dependencies count
+- Proper error exception
+- Up-To-Date with Discord's IPC command / event list
+- Less than 100kb bundle size
+
+## Optional packages (when using WebSocket)
+
+- [bufferutil](https://www.npmjs.com/package/bufferutil)
+- [utf-8-validate](https://www.npmjs.com/package/utf-8-validate)
+
+## Example
+
+```ts
+import { Client } from "@xhayper/discord-rpc";
+
+const client = new Client({
+ clientId: "123456789012345678"
+});
+
+client.on("ready", () => {
+ client.user?.setActivity({
+ state: "Hello, world!"
+ });
+});
+
+client.login();
+```
+
+## Compatibility
+
+| OS | Normal | snap | flatpak |
+| ------- | ------ | ---- | ------- |
+| Windows | Y | - | - |
+| macOS | Y | - | - |
+| Linux | Y | Y | Y |
+
+- Linux is tested on Kubuntu 22.04
+
+## Credits
+
+- [discordjs](https://github.com/discordjs): Making [discordjs/RPC](https://github.com/discordjs/RPC)
+- [JakeMakesStuff](https://github.com/JakeMakesStuff): [snap support](https://github.com/discordjs/RPC/pull/152)
+- [Snazzah](https://github.com/Snazzah): [snap + flatpak support](https://github.com/Snazzah/SublimeDiscordRP/blob/c13e60cdbc5de8147881bb232f2339722c2b46b4/discord_ipc/__init__.py#L208)
+- [leonardssh](https://github.com/leonardssh): Making [coc-discord-rpc](https://github.com/leonardssh/coc-discord-rpc) which inspried me to make this package due to how old [discordjs/RPC](https://github.com/discordjs/RPC) is