Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
vk-chat-bot
Advanced tools
Changelog
[16.0.0] - 2019-12-28
moment
and moment-duration-format
dependencies with a simple function. The process uptime output format in stats is different now.yarn
.Readme
Package for easy creation of chat bots for VK communities (groups). Uses Callback API. documentation » ⋅ changelog » ⋅ features ⋅ usage ⋅ contributing ⋅ license
The version of VK API used by this package can be found here.
$ yarn add vk-chat-bot
You can find an example bot in the u32i64/vk-chat-bot-example
repository.
Deploying on Glitch
Simply press the button below and follow the SETUP.md
file there:
Deploying on Heroku
You can find a step-by-step guide on deploying the example to Heroku here.
First, require()
the package:
const vk = require('vk-chat-bot');
Then, create your bot using the vk.bot
function (see Params object for more information about params
):
const params = {
vkToken: 'your_vk_access_token',
confirmationToken: 'f123456',
groupId: 1234567,
secret: 's3r10us1y_s3cr3t_phr4s3',
port: 12345,
cmdPrefix: '/'
};
var { bot, core } = vk.bot(params);
See Core
wiki to learn more about behavior functions.
Here are some examples:
// Use stuff from the package...
const { Color, button, Keyboard } = vk.kbd;
// ...to create a keyboard like this.
// +-----------+---------+----------+----------+
// | Secondary | Primary | Negative | Positive |
// +-----------+---------+----------+----------+
// | Maximum rows is 10, columns - 4. |
// +-------------------------------------------+
var kbd = new Keyboard([
[ /* Row (array of buttons) */
button.text('Secondary'),
button.text('Primary', Color.Primary),
button.text('Negative', Color.Negative),
button.text('Positive', Color.Positive)
],
[
button.text('Maximum rows is 10, columns - 4.')
],
]);
// When user presses the `Start` button...
// (you have to enable the button in community settings)
core.on('start', $ => {
// ...send them our keyboard.
$.text('Thanks for messaging us! Choose from the options below:');
$.keyboard(kbd);
// Here, $.send() is added automatically.
});
// Searches for cmd_prefix + 'help', e.g. '/help'
core.cmd('help', $ => {
// core.help() returns the help message
$.text('Test Bot v1.0' + core.help());
// Attach an image from
// https://vk.com/team?z=photo6492_45624077
$.attach('photo', 6492, 456240778);
}, 'shows the help message');
// Use case-insensitive regular expression to find words 'hi', 'hello' or 'hey'
core.regex(/h(i|ello|ey)/i, $ => {
$.text('Hello, I am a test bot. You said: ' + $.msg);
});
Start the bot:
bot.start();
The bot will log some useful information, see Logging documentation for more information.
vk-chat-bot
better? Open a pull request!This project is licensed under the terms of the MIT license.
FAQs
Package for easy creation of chat bots for VK communities (uses Callback API).
The npm package vk-chat-bot receives a total of 220 weekly downloads. As such, vk-chat-bot popularity was classified as not popular.
We found that vk-chat-bot demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.