Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shipgirlproject/kearsarge
An alternative set of strategies for @discordjs/ws using CloudStorm
https://github.com/shipgirlproject/kearsarge
discord discord-js discordjs websocket
Last synced: 3 months ago
JSON representation
An alternative set of strategies for @discordjs/ws using CloudStorm
- Host: GitHub
- URL: https://github.com/shipgirlproject/kearsarge
- Owner: shipgirlproject
- License: mit
- Created: 2023-07-30T08:44:33.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-08-01T09:53:00.000Z (over 1 year ago)
- Last Synced: 2024-09-28T09:07:04.100Z (4 months ago)
- Topics: discord, discord-js, discordjs, websocket
- Language: TypeScript
- Homepage:
- Size: 95.7 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Kearsarge
> An alternative set of strategies for [@discordjs/ws](https://github.com/discordjs/discord.js/tree/main/packages/ws) using [CloudStorm](https://github.com/DasWolke/CloudStorm/tree/master)
> The ShipGirl Project, feat Kearsarge; ⓒ Azur Lane
### Notes
* Uses mixed code between [@discordjs/ws](https://github.com/discordjs/discord.js/tree/main/packages/ws) and [CloudStorm](https://github.com/DasWolke/CloudStorm/tree/master)
* Does not break anything in [@discordjs/ws](https://github.com/discordjs/discord.js/tree/main/packages/ws)
* Implements both simple and worker sharding strategies of [@discordjs/ws](https://github.com/discordjs/discord.js/tree/main/packages/ws)
* Has support for etf encoding and zlib compression (If you need those!)
* Probably fast as well?
### Installation
* Stable Branch
> `npm i kearsarge --save`
* Dev Branch
> `npm install https://github.com/Deivu/Kearsarge.git --save`
### Example usages
> Using with Discord.JS with (Discord.JS default strategy)
```js
import { KearsargeSimpleStrategy } from 'kearsarge';
import { GatewayIntentBits } from 'discord-api-types/v10';
import { Client } from 'discord.js';
const options = {
allowedMentions: { parse: [ 'users', 'roles' ] },
intents: [ Guilds ],
makeCache: Options.cacheWithLimits(Options.DefaultMakeCacheSettings),
ws: {
buildStrategy: (manager) => new KearsargeSimpleStrategy(manager)
}
}
const client = new Client(options);
await client.login();
```
> Using with Indomitable with enabled concurrency handling
* Note: Don't use this if you don't use `handleConcurrency`. in those cases, use the discordjs strategies
```js
import { IndomitableStrategy } from 'kearsarge';
import { Indomitable } from 'indomitable';
import { Client } from 'discord.js';
const options = {
clusterCount: 2,
shardCount: 8,
clientOptions: {
intents: [1 << 0],
ws: {
buildStrategy: manager => new IndomitableStrategy(manager)
}
},
autoRestart: true,
handleConcurrency: true,
client: Client,
token: process.env.DISCORD_TOKEN
}
const manager = new Indomitable(options)
.on('error', console.error);
manager.spawn();
```
> Using simple strategy (Discord.JS default strategy)
```js
import { KearsargeSimpleStrategy } from 'kearsarge';
import { WebSocketManager, WebSocketShardEvents } from '@discordjs/ws';
import { REST } from '@discordjs/rest';
const rest = new REST().setToken(process.env.DISCORD_TOKEN);
const manager = new WebSocketManager({
token: process.env.DISCORD_TOKEN,
intents: 0,
buildStrategy: (manager) => new KearsargeSimpleStrategy(manager),
rest
});
manager.on(WebSocketShardEvents.Dispatch, (event) => console.log(event));
await manager.connect();
```
> Using worker strategy
```js
import { KearsargeWorkerStrategy } from 'kearsarge';
import { WebSocketManager, WebSocketShardEvents } from '@discordjs/ws';
import { REST } from '@discordjs/rest';
const rest = new REST().setToken(process.env.DISCORD_TOKEN);
const manager = new WebSocketManager({
token: process.env.DISCORD_TOKEN,
intents: 0,
buildStrategy: (manager) => new KearsargeWorkerStrategy(manager, { shardsPerWorker: 2 }),
rest
});
manager.on(WebSocketShardEvents.Dispatch, (event) => console.log(event));
await manager.connect();
```
> Use of different encoding with compression
```js
import { KearsargeWorkerStrategy, WebsocketEncoding } from 'kearsarge';
import { CompressionMethod, WebSocketManager, WebSocketShardEvents } from '@discordjs/ws';
import { REST } from '@discordjs/rest';
const rest = new REST().setToken(process.env.DISCORD_TOKEN);
const manager = new WebSocketManager({
token: process.env.DISCORD_TOKEN,
// @ts-expect-error: overrides the type of discord.js encodings
encoding: WebsocketEncoding.ETF,
compression: CompressionMethod.ZlibStream,
intents: 0,
buildStrategy: (manager) => new KearsargeWorkerStrategy(manager, { shardsPerWorker: 2 }),
rest
});
```
### Reminder
* If you have custom strategies or bootstrappers, changing the WebsocketShard class to Kearsarge's websocket class will work. You don\'t need to use any of my strategies if you have your own