Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
vk-chat-bot
Advanced tools
Framework for easy creation of chat bots for VK communities (uses Callback API).
A chat bot framework for VK communities (groups).
documentation » ⋅ changelog » ⋅ features ⋅ usage ⋅ contributing ⋅ license
$ npm i vk-chat-bot
You can find an example bot in the u32i64/vk-chat-bot-example
repository.
Also, a step-by-step Heroku Deploy Guide can guide you through the process of deploying u32i64/vk-chat-bot-example
to Heroku.
First, require()
the framework:
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 framework...
const { colors, Button, Keyboard } = vk.kbd;
// ...to create a keyboard like this.
// +---------+---------+----------+----------+
// | Default | Primary | Negative | Positive |
// +---------+---------+----------+----------+
// | Maximum rows is 10, columns - 4. |
// +-----------------------------------------+
var kbd = new Keyboard([
[ /* Row (array of buttons) */
new Button('Default'),
new Button('Primary', colors.primary),
new Button('Negative', colors.negative),
new Button('Positive', colors.positive)
],
[
new Button('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.
[13.1.2] - 2019-03-28
core warn Error in handler: TypeError: Cannot read property 'handler' of undefined
FAQs
Package for easy creation of chat bots for VK communities (uses Callback API).
The npm package vk-chat-bot receives a total of 9 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.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.