Skip to content

Modular discord gateway library for microservice oriented bots

License

Notifications You must be signed in to change notification settings

xandium/CloudStorm

 
 

Repository files navigation

CloudStorm

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 8 or higher.

Some of the things that make CloudStorm awesome:

  • Standalone discord gateway connection
  • zlib-stream, etf and json support
  • Well documented

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:

{
  "op":0,
  "t":"PRESENCE_UPDATE",
  "s":1337,
  "shard_id":0,
  "d": {
    "game": null,
    "guild_id": "id",
    "nick": null,
    "roles": [],
    "status": "offline",
    "user": { 
     "id": "id"
    } 
  }
}

Microservice Bots:

I've written a general whitepaper on the idea of microservice bots, which you can find on gist: Microservice Bot Whitepaper

Documentation:

You can find the docs at https://daswolke.github.io/CloudStorm/

Installation:

To install CloudStorm, make sure that you have node 8 or higher and npm installed on your computer.

Then run the following command in a terminal npm install cloudstorm

About

Modular discord gateway library for microservice oriented bots

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%