# aether-sharder

> A Sharder for Aether-Library

Latest version **1.0.0** (published 2021-09-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install aether-sharder
pnpm add aether-sharder
yarn add aether-sharder
bun add aether-sharder
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2021-09-29 |
| First published | 2021-09-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 40.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jxckson-dev |
| Maintainers | jxckson-dev |
| Keywords | Aether, Sharder, Library |

## Links

- npm: https://www.npmjs.com/package/aether-sharder
- npm.io page: https://npm.io/package/aether-sharder

## Dependencies (8)

- [os](https://npm.io/package/os.md) ^0.1.2
- [util](https://npm.io/package/util.md) ^0.12.4
- [colors](https://npm.io/package/colors.md) ^1.4.0
- [crypto](https://npm.io/package/crypto.md) ^1.0.1
- [events](https://npm.io/package/events.md) ^3.3.0
- [cluster](https://npm.io/package/cluster.md) ^0.7.7
- [fancy-log](https://npm.io/package/fancy-log.md) ^1.3.3
- [aether-library](https://npm.io/package/aether-library.md) ^0.15.4

## Recent versions

- 1.0.0 (latest) — 2021-09-29

## README

## About
Aether-Sharder is a powerful sharding manager for thew Aether discord library. It uses Node.js's cluster module to spread shards evenly among all the cores.

## Installation and Usage
To download Aether-sharder, run ``npm install aether-sharder --save``

To use Aether-sharder simply copy this code and paste it into the file, in the same directory you ran npm install in:

```js
const Sharder = require('Aether-Sharder').Master;
const sharder = new Sharder(token, pathToMainFile, options)
```

## Options
| Name  | Description |
| ------------- | ------------- |
| `token`  | your discord bot token. It will be used to calculate how many shards to spawn and to pass it on to your main file.  |
| `pathToMainFile`  | path to a file that exports a class. The class must containt a method called "launch". In the constructor the only paramater you should put is for the bot.  |
| `options.stats` | boolean. When set to true it enables stats output. |
| `options.webhooks` | Object.```{shard: {id: "webhookID", token: "webhookToken"}, cluster:{id: "webhookID", token: "webhookToken"}}```|
| `options.clientOptions` | A object of client options you want to pass to the Aether client constructor.|
| `options.clusters` | The number of how many clusters you want. Defaults to the amount of threads |
| `options.clusterTimeout` | Number of seconds between starting up clusters. Values lower than 5 may lead to an Invalid Session on first shard. |
| `options.shards` | The number of total shards you plan to run. Defaults to the amount that the gateway reccommends, taking into account `options.guildsPerShard` |
| `options.firstShardID` | ID of the first shard to start on this instance. Defaults to `0` |
| `options.lastShardID` | ID of the last shard to start on this instance. Defaults to `options.shards - 1` |
| `options.debug` | Boolean to enable debug logging.|
|`options.statsInterval` | Interval to release the stats event in milliseconds. Defaults to every minute
| `options.name` | Name to print on startup. By default it's "Aether-Sharder".|
| `options.guildsPerShard` | Number to calculate how many guilds per shard. Defaults to 1300. Overriden if you only have 1 shard.|

# IPC
Aether-Sharder supports a variety of IPC events. All IPC events can be used via `process.send({type: "event"});`

## Info
In every cluster when your code is loaded, if you extend the Base class you get access to `this.bot`, `this.clusterID`, and  `this.ipc`. `this.ipc` has a couple methods which you can find very useful.

| Name         | Example                                   | Description                                                                           |
|--------------|-------------------------------------------|---------------------------------------------------------------------------------------|
| register     | `this.ipc.register(event, callback);`     | Using this you can register to listen for events and a callback that will handle them |
| unregister   | `this.ipc.unregister(event);`             | Use this to unregister for an event                                                   |
| broadcast    | `this.ipc.broadcast(name, message);`      | Using this you can send a custom message to every cluster                             |
| sendTo       | `this.ipc.sendTo(cluster, name, message)` | Using this you can send a message to a specific cluster                               |
| fetchUser    | `await this.ipc.fetchUser(id)`            | Using this you can search for a user by id on all clusters                            |
| fetchGuild   | `await this.ipc.fetchGuild(id)`           | Using this you can search for a guild by id on all clusters                           |
| fetchChannel | `await this.ipc.fetchChannel(id)`         | Using this you can search for a channel by id on all clusters                         |

# Example
## Directory Tree
In this example the directory tree will look something like this:
```
Project/
├── node-modules/
│   ├── Aether-Sharder
|
├── src/
│   ├── main.js
│   
├── index.js
```

## Example of main.js
```javascript
const Base = require('Aether-Sharder').Base;
class Class extends Base{
    constructor(bot) {
        super(bot);
    }

    launch() {

    }

}

module.exports = Class;
```

## Example of index.js
```javascript
const Sharder = require('Aether-Sharder').Master;
const sharder = new Sharder("someToken", "/src/main.js", {
  stats: true,
  debug: true,
  guildsPerShard: 1500,
  name: "ExampleBot",
  webhooks: {
    shard: {
      id: "webhookID",
      token: "webhookToken"
    },
     cluster: {
      id: "webhookID",
      token: "webhookToken"
    }
  },
  clientOptions: {
      messageLimit: 150,
      defaultImageFormat: "png"
  }
});

sharder.on("stats", stats => {
  console.log(stats);
});
```

## Starting the script

```
node index.js
```

## NOTICE

If you are using pm2 to run your script add the `-- --colors` option to enable the colorful logging.

---
_Source: https://npm.io/package/aether-sharder · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._