eris-threads v1.0.3

About the package

Eris-threads is a sharding and cluster manager for discord bots based on eris. Eris-threads spreads shards evenly among your cores. Eris-threads is based on eris-sharder (an updated version). Supports CommonJS and ESM.

You can find examples and usage here.

Requirements

• Node.js version 16+
• Eris version 0.16.0+

Installation

npm:

npm install eris-threads eris

yarn:

yarn add eris-threads eris

pnpm:

pnpm add eris-threads eris

Example

Directory Tree

In this example the directory tree will look something like this:

Project/
├── node-modules/
│   ├── eris-threads
|
├── main.js
│
├── index.js

Example of index.js

const { ShardingManager } = require('eris-threads');

const shardManager = new ShardingManager('/main.js', {
  token: 'botToken',
  stats: true,
  debug: true,
  guildsPerShard: 1500,
  webhooks: {
    shard: {
      id: 'webhookID',
      token: 'webhookToken',
      embed: {} // Custom embed if you wish
    },
    cluster: {
      id: 'webhookID',
      token: 'webhookToken',
      embed: {}
    },
  },
  clientOptions: {
    messageLimit: 150,
    defaultImageFormat: 'png',
  },
});

shardManager.spawn();

Example of main.js

const { Base } = require('eris-threads');

class Bot extends Base {
  constructor(bot) {
    super(bot);
  }
}

module.exports = Bot;

You can start your bot using

node index.js

Sharding Manager Options

Base

When you extend the Base class (main.js) you get access to this.bot, this.clusterID, and this.ipc

this.bot is the eris client

this.clusterID will return the cluster id.

IPC Methods