6.0.3 β€’ Published 10 months ago

@sapphire/plugin-pattern-commands v6.0.3

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

Sapphire Logo

@sapphire/plugin-pattern-commands

Plugin for @sapphire/framework so you can have pattern commands.

GitHub codecov npm bundle size npm

Description

With pattern commands you can define rulesets to which the bot may respond.

Important notes

  • Starting April 2022 this plugin will only work with Message Intent. This is because this plugin relies on scanning messages, which is impossible without the intent.

Features

  • Fully ready for TypeScript!
  • Includes ESM ready entrypoint
  • Type generics for easy extension in TypeScript
  • Input/Output mapping

Installation

@sapphire/plugin-pattern-commands depends on the following packages. Be sure to install these along with this package!

You can use the following command to install this package, or replace npm install with your package manager of choice.

npm install @sapphire/plugin-pattern-commands @sapphire/framework @sapphire/utilities discord.js

Usage

  • Paste this in your Bot.ts (or where you initiate your client)
import '@sapphire/plugin-pattern-commands/register';
  • Create a new pattern-commands directory under /src
  • Make your first pattern command:
import type { Message } from 'discord.js';
import { PatternCommand } from '@sapphire/plugin-pattern-commands';
import { ApplyOptions } from '@sapphire/decorators';

@ApplyOptions<PatternCommand.Options>({
	aliases: ['cat', 'postman'],
	chance: 85
})
export class AwooCommand extends PatternCommand {
	public messageRun(message: Message) {
		message.reply('Woof!');
	}
}

In this example there's a 85% chance when your bot will bark at someone who says cat or postman. The matcher is case-insensitive and can match at substrings as well (so in the example above the word catnip also can trigger your bot) For aliases you can use regexp as well, but you have to encapsulate them as a string. For example:

@ApplyOptions<PatternCommand.Options>({
    aliases: ['a{3,}'],
})

Buy us some doughnuts

Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!

We accept donations through Open Collective, Ko-fi, Paypal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.

Donate WithAddress
Open CollectiveClick Here
Ko-fiClick Here
PatreonClick Here
PayPalClick Here

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

6.0.3-next.80d26ac

11 months ago

6.0.3-next.d512e6d

11 months ago

6.0.3-next.b4f1701

11 months ago

6.0.3-next.b2086e1

11 months ago

6.0.3

11 months ago

6.0.3-next.6b9d139

11 months ago

6.0.4-next.0782cfd

10 months ago

6.0.4-next.a0edebf

11 months ago

6.0.4-next.5395ccc

11 months ago

6.0.3-next.d9dd30c

11 months ago

6.0.4-next.21d90cf

11 months ago

6.0.4-next.c75b7c2

11 months ago

6.0.3-next.dd4b95f

11 months ago

6.0.4-next.e0e4d74

11 months ago

6.0.3-next.12ccd3c

11 months ago

6.0.3-next.d2c9aaa

11 months ago

6.0.3-next.6a148bb

11 months ago

6.0.3-next.ccf3dc1

11 months ago

6.0.3-next.5aa5898

11 months ago

6.0.3-next.518ac87

11 months ago

6.0.3-next.9e3ae6f

11 months ago

6.0.3-next.8128717

11 months ago

6.0.3-next.a1d7d5e

11 months ago

6.0.3-next.352f2cd

12 months ago

6.0.3-next.5ea63b2

11 months ago

6.0.3-next.fa73a83

11 months ago

6.0.3-next.22ae85d

11 months ago

6.0.3-next.96ac961

12 months ago

6.0.3-next.f177359

12 months ago

6.0.3-next.51af5e9

12 months ago

6.0.3-next.1c40781

12 months ago

6.0.3-next.f8b2f60

12 months ago

6.0.3-next.8de2057

12 months ago

6.0.3-next.e6fdc84

12 months ago

6.0.3-next.f730be1

12 months ago

6.0.3-next.f61b06f

12 months ago

6.0.3-next.9b36bae

12 months ago

6.0.2

2 years ago

6.0.1

2 years ago

6.0.0

2 years ago

5.0.2

2 years ago

5.1.0

2 years ago

5.0.1

2 years ago

5.0.0

3 years ago

4.0.1

3 years ago

4.1.0

3 years ago

4.0.0

3 years ago

3.1.1

3 years ago

3.1.0

3 years ago

3.0.1

3 years ago

3.0.0

3 years ago

1.0.2

4 years ago

1.0.1

4 years ago

2.2.0

4 years ago

2.1.1

4 years ago

2.1.0

4 years ago

2.0.0

4 years ago

1.0.0

4 years ago