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.4-next.5106865

11 months ago

6.0.4-next.4407e6d

11 months ago

6.0.4-next.cb6bf89

11 months ago

6.0.4-next.3d9ff24

11 months ago

6.0.4-next.8508a07

10 months ago

6.0.4-next.c7aaadd

10 months ago

6.0.4-next.b2f016e

12 months ago

6.0.4-next.c246384

12 months ago

6.0.4-next.1fc0c36

12 months ago

6.0.4-next.10ed525

11 months ago

6.0.4-next.6bd83f1

10 months ago

6.0.4-next.ae90958

10 months ago

6.0.4-next.81c1ccb

12 months ago

6.0.4-next.0d9024f

10 months ago

6.0.4-next.a24f9ec

12 months ago

6.0.4-next.b8eca5f

11 months ago

6.0.4-next.147893c

11 months ago

6.0.4-next.6664087

10 months ago

6.0.4-next.e1295d1

10 months ago

6.0.4-next.79a4381

12 months ago

6.0.4-next.e18dc27

10 months ago

6.0.4-next.db7c810

11 months ago

6.0.4-next.9f69aae

12 months ago

6.0.4-next.1ba68f6

10 months ago

6.0.4-next.30a0f86

11 months ago

6.0.4-next.b302651

12 months ago

6.0.4-next.4ce2946

11 months ago

6.0.4-next.b5bb6ef

11 months ago

6.0.4-next.9c20163

11 months ago

6.0.4-next.3c60b44

11 months ago

6.0.4-next.73fd2f1

12 months ago

6.0.4-next.cf109b1

12 months ago

6.0.4-next.9d424f1

10 months ago

6.0.4-next.b4041d6

11 months ago

6.0.4-next.abbe598

11 months ago

6.0.3

1 year ago

6.0.2

2 years ago

6.0.1

2 years ago

6.0.0

2 years ago

5.0.2

3 years ago

5.1.0

2 years ago

5.0.1

3 years ago

5.0.0

3 years ago

4.0.1

3 years ago

4.1.0

3 years ago

4.0.0

4 years ago

3.1.1

4 years ago

3.1.0

4 years ago

3.0.1

4 years ago

3.0.0

4 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