mirror of
https://github.com/sern-handler/handler
synced 2026-06-06 01:16:55 +00:00
bfcc160a39
Idk I was bored and saw this was different to mine. Change mine instead or just close this pr, idm.
122 lines
3.9 KiB
Markdown
122 lines
3.9 KiB
Markdown
<div align="center">
|
|
<img src="https://raw.githubusercontent.com/sern-handler/.github/main/banner.png" width="900px" />
|
|
</div>
|
|
|
|
<h1 align="center">Handlers. Redefined.</h1>
|
|
<h4 align="center">A customizable, batteries-included, powerful discord.js framework to streamline bot development.</h4>
|
|
|
|
<div align="center" styles="margin-top: 10px">
|
|
<img src="https://img.shields.io/badge/open-source-brightgreen" />
|
|
<a href="https://www.npmjs.com/package/@sern/handler"><img src="https://img.shields.io/npm/v/@sern/handler?maxAge=3600" alt="NPM version" /></a>
|
|
<a href="https://www.npmjs.com/package/@sern/handler"><img src="https://img.shields.io/npm/dt/@sern/handler?maxAge=3600" alt="NPM downloads" /></a>
|
|
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-brightgreen" alt="License MIT" /></a>
|
|
<a href="https://sern.dev"><img alt="docs.rs" src="https://img.shields.io/docsrs/docs" /></a>
|
|
<img alt="Lines of code" src="https://img.shields.io/badge/total%20lines-2k-blue" />
|
|
</div>
|
|
|
|
|
|
## 📜 Installation
|
|
|
|
```sh
|
|
npm install @sern/handler
|
|
```
|
|
|
|
```sh
|
|
yarn add @sern/handler
|
|
```
|
|
|
|
```sh
|
|
pnpm add @sern/handler
|
|
```
|
|
## Why?
|
|
- Most handlers don't support discord.js 14.7+
|
|
- Customizable commands
|
|
- Plug and play or customize to your liking
|
|
- Embraces reactive programming for consistent and reliable backend
|
|
- Customizable logger, error handling, and more
|
|
- Active development and growing [community](https://sern.dev/discord)
|
|
## 👀 Quick Look
|
|
|
|
* Support for discord.js v14 and all interactions
|
|
* Hybrid commands
|
|
* Lightweight and customizable
|
|
* ESM, CommonJS and TypeScript support
|
|
* A powerful CLI and awesome community-made plugins
|
|
|
|
## 👶 Basic Usage
|
|
|
|
#### ` index.js (CommonJS)`
|
|
|
|
```js
|
|
// Import the discord.js Client and GatewayIntentBits
|
|
const { Client, GatewayIntentBits } = require('discord.js');
|
|
|
|
// Import Sern namespace
|
|
const { Sern } = require('@sern/handler');
|
|
|
|
const client = new Client({
|
|
intents: [
|
|
GatewayIntentBits.Guilds,
|
|
GatewayIntentBits.GuildMembers,
|
|
GatewayIntentBits.GuildMessages
|
|
]
|
|
});
|
|
export const useContainer = Sern.makeDependencies({
|
|
build: root => root
|
|
.add({ '@sern/client': single(client) })
|
|
.upsert({ '@sern/logger': single(new DefaultLogging()) })
|
|
});
|
|
|
|
//View docs for all options
|
|
Sern.init({
|
|
defaultPrefix: '!', // removing defaultPrefix will shut down text commands
|
|
commands: 'src/commands',
|
|
// events: 'src/events' (optional),
|
|
containerConfig : {
|
|
get: useContainer
|
|
}
|
|
});
|
|
|
|
client.login("YOUR_BOT_TOKEN_HERE");
|
|
```
|
|
|
|
#### ` ping.js (CommonJS)`
|
|
|
|
```js
|
|
const { CommandType, commandModule } = require('@sern/handler');
|
|
|
|
exports.default = commandModule({
|
|
name: 'ping',
|
|
description: 'A ping pong command',
|
|
type: CommandType.Slash,
|
|
execute(ctx) {
|
|
ctx.reply('pong!');
|
|
}
|
|
});
|
|
```
|
|
|
|
## 🤖 Bots Using sern
|
|
- [Community Bot](https://github.com/sern-handler/sern-community), the community bot for our [discord server](https://sern.dev/discord).
|
|
- [Vinci](https://github.com/SrIzan10/vinci), the bot for Mara Turing.
|
|
- [Bask](https://github.com/baskbotml/bask), Listen your favorite artists on Discord.
|
|
- [ava](https://github.com/SrIzan10/ava), A discord bot that plays KNGI and Gensokyo Radio.
|
|
- [Siamese (WIP)](https://github.com/Benzo-Fury/Siamese-Bot), Using AI to unleash the power in your server.
|
|
- [Protector (WIP)](https://github.com/needhamgary/Protector), Just a simple bot to help enhance a private minecraft server.
|
|
|
|
## 💻 CLI
|
|
|
|
It is **highly encouraged** to use the [command line interface](https://github.com/sern-handler/cli) for your project. Don't forget to view it.
|
|
|
|
## 🔗 Links
|
|
|
|
- [Official Documentation and Guide](https://sern.dev)
|
|
- [Support Server](https://sern.dev/discord)
|
|
|
|
## 👋 Contribute
|
|
|
|
- Read our contribution [guidelines](https://github.com/sern-handler/handler/blob/main/.github/CONTRIBUTING.md) carefully
|
|
- Pull up on [issues](https://github.com/sern-handler/handler/issues) and report bugs
|
|
- All kinds of contributions are welcomed.
|
|
|
|
|