Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/DasWolke/CloudStorm
Modular discord gateway library for microservice oriented bots
https://github.com/DasWolke/CloudStorm
Last synced: about 1 month ago
JSON representation
Modular discord gateway library for microservice oriented bots
- Host: GitHub
- URL: https://github.com/DasWolke/CloudStorm
- Owner: DasWolke
- License: mit
- Created: 2017-08-20T00:33:45.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-08-27T01:47:19.000Z (4 months ago)
- Last Synced: 2024-08-27T03:34:49.027Z (4 months ago)
- Language: TypeScript
- Homepage:
- Size: 318 KB
- Stars: 58
- Watchers: 6
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-discord-bot-tools - Weather Stack - Ecosystem of tools for microservice Discord bots (Libraries / JavaScript)
- awesome-discord-bot-tools - Weather Stack - Ecosystem of tools for microservice Discord bots (Libraries / JavaScript)
README
# A minimal discord gateway library
Part of the WeatherStack
CloudStorm is a small library specially made to **only** cover the Gateway area of the discord api.
It makes no assumptions about the rest of your stack, therefore you can use it anywhere as long as you use node 14 or higher.
## Some of the things that make CloudStorm awesome:
- Standalone discord gateway connection
- zlib-stream, etf and json support
- Well documented
## Example:
```js
const { Client } = require("cloudstorm");
const bot = new Client(token, { intents: ["GUILDS"] });
const startup = async () => {
await bot.connect();
bot.on("ready", () => console.log("Bot received ready event"););
};
startup().catch(e => {
console.error("Error on startup!");
console.error(e);
});
```
## Gotchas with CloudStorm:
You may wonder how you you are able to get the id of a shard where an event originated from, but don't fear, CloudStorm helps you with that by adding a `shard_id` property to the events that are forwarded.
So an event you receive may look like this:
```json
{
"op": 0,
"t": "PRESENCE_UPDATE",
"s": 1337,
"shard_id": 0,
"d": {
"user": {
"id": "id"
},
"guild_id": "id",
"status": "offline",
"activities": [],
"client_status": {}
}
}
```
## Sharding for VERY large bots
CloudStorm supports max_concurrency and gets this info on initial connect, but does not automatically attempt to fetch new info related to max_concurrency. You are expected to re-fetch this data at your own discretion as Discord does not recommend caching the data for extended periods as it can change as your client leaves and joins guilds and possibly cause rate limit errors.
You should start your clusters 1 by 1 as rate limit info is only fetched on Client.connect or when you manually call Client.fetchConnectInfo when /gateway/bot is fetched
### Microservice Bots:
I've written a general whitepaper on the idea of microservice bots, which you can find on gist: [Microservice Bot Whitepaper](https://gist.github.com/DasWolke/c9d7dfe6a78445011162a12abd32091d)
### Documentation:
You can find the docs at [https://daswolke.github.io/CloudStorm/](https://daswolke.github.io/CloudStorm/)
### Installation:
To install CloudStorm, make sure that you have node 14 or higher on your computer.
Then run the following command in a terminal `npm install cloudstorm`