blob: 1a33d5f1e7073ce74923c00b215a905529986be2 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
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
|
