# Introduction

Welcome to Status Sharding! This package is designed to provide an efficient and flexible solution for sharding Discord bots, allowing you to scale your bot across multiple processes or workers with many useful functions!

## Features

* **Efficient Sharding**: The sharding package utilizes an optimized sharding algorithm to distribute bot functionality across multiple shards and clusters.
* **Enhanced Performance**: Improve your bot's performance by leveraging the power of parallel processing and multi-threading.
* **Flexible Configuration**: Easily configure the number of shards, clusters, and other parameters to suit your bot's needs.
* **Comprehensive Documentation**: Detailed documentation and usage examples are provided to help you get started quickly.
* **Scalability**: Scale your bot's capabilities by distributing the workload across multiple processes or workers.
* **Customizable**: Extend and customize the sharding package to adapt it to your specific requirements.
* **Cross Hosting Support**: *Comming soon!*

## Comparison

Here's a comparison between Status Sharding, Discord Hybrid Sharding and Discord.js Sharding.

<table data-full-width="false"><thead><tr><th>Feature</th><th align="center">Status Sharding</th><th align="center">Discord Hybrid Sharding</th><th align="center">Discord.js Sharding</th><th data-hidden data-type="checkbox"></th></tr></thead><tbody><tr><td>Flexible <br>configuration</td><td align="center">✔️</td><td align="center">✔️</td><td align="center">✔️</td><td>false</td></tr><tr><td>Clustering<br>Support</td><td align="center">✔️</td><td align="center">✔️</td><td align="center">❌</td><td>false</td></tr><tr><td>Processes &#x26; Workers</td><td align="center">✔️</td><td align="center">✔️</td><td align="center">❌</td><td>false</td></tr><tr><td>Comprehensive documentation</td><td align="center">✔️</td><td align="center">❌</td><td align="center">❌</td><td>false</td></tr><tr><td>Some performance <br>optimizations</td><td align="center">✔️</td><td align="center">❌</td><td align="center">❌</td><td>false</td></tr></tbody></table>

You can view more in-depth comparison below:

{% content-ref url="/pages/5ZXmyqHSC218bn4A1NzR" %}
[Benchmarks](/status-sharding/benchmarks.md)
{% endcontent-ref %}

## Installation

```bash
npm install status-sharding
yarn add status-sharding
```

{% content-ref url="/pages/GKcv7ub2s9ems36YVsL9" %}
[Getting Started](/status-sharding/getting-started.md)
{% endcontent-ref %}

## Credits

* This clone was created by [Digital](https://crni.xyz/). The original can be found [here](https://github.com/meister03/discord-hybrid-sharding).
* Special thanks to maintainers for their work on the initial package, which served as the foundation for this clone. Their contributions are greatly appreciated.
* Please note that this clone is an independent project and may have diverged from the original discord-hybrid-sharding package in certain aspects.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.crni.xyz/status-sharding/introduction.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
