To run this project, you will need to add the following environment variables to your .env file
DATABASE_NAME - name of the database file (this project is using loki.js)
To deploy this project run:
Installing packages:
npm run installBuilding typescript:
npm run buildFilling database:
npm run fillStarting bot instance:
npm run start| Permission name | Description |
|---|---|
| All | Group will have all possible permissions |
| ChatCommands | Access to perform chat commands |
| ConversationCommands | Access to perform conversation commands |
| TechStatistics | Perform tech statistics monitoring |
| Mailing | Perform mail functionality (in work right now) |
| AutoAnswers | Access to template answers functionality |
| Permission name | Description |
|---|---|
| All | Member will have all posible permissions |
| CommandHealthcheck | Access to healthcheck command |
| CommandWarn | Access to warn command |
| CommandWarns | Access to warns command |
| CommandUnwarn | Access to unwarn command |
| CommandMute | Access to mute command |
| CommandUnmute | Access to unmute command |
| CommandKick | Access to kick command |
| CountTechStatistics | Flag that bot uses to write answer statistics by user, also gives permission to techstatistics command |
| CommandSummaryTechStatistics | Access to summarytechstatistics command |
| CommandGivePermission | Access to givepermission command |
| CommandTakePermission | Access to takepermission command |
| CommandMyPermissions | Access to mypermissions command |
| CommandGetPermissions | Access to getpermissions command |
| CommandGetAllPermissions | Access to getallpermissions command |
| CommandUpdateMailAvailability | Access to updatemailavailability command (in work atm) |
| CommandAddAutoAnswer | Access to addautoanswer command |
| CommandRemoveAutoAnswer | Access to removeautoanswer command |
| CommandGetAutoAnswers | Access to getautoanswers command |
| CommandEditAutoAnswer | Access to editautoanswer command |
| CommandSetPastebin | Access to setpastebin command |
| CommandGetAllSpecialEvents | Access to getallspecialevents command |
Because some commands needs larger space than VK Api can perform. Also, looking in future, statistics can be generated using pastebin.
In long command arguments we use -@- as a delimeter (with space on start), for example:
/editautoanswer 1 hello|good morning -@- notify_tech
Special events are used if template needs dynamic view or needs to implement some logic. Available special events:
| Event name | Description |
|---|---|
| NotifyTech | Send tech notification by written user |
Please be patient and ask developer if you have any questions on why and how bot should run.
Telegram: @FuryDester
VK: @FuryDester
- Make mail functionality;
- Write and correct readme;
- Probably add more special events.