VK puppeting bridge for Matrix, taking use of VK Communities API
Go to file
Inex Code 757badde67 Linting 2020-11-13 03:14:53 +00:00
.devcontainer Initial commit 2020-11-02 14:48:22 +00:00
.github/workflows Create codeql-analysis.yml 2020-11-02 18:57:49 +03:00
src Linting 2020-11-13 03:14:53 +00:00
.gitignore Initial commit 2020-11-02 14:48:22 +00:00
LICENSE Initial commit 2020-11-02 14:48:22 +00:00
README.md Update readme and default log level 2020-11-13 02:57:21 +00:00
package-lock.json Initial commit 2020-11-02 14:48:22 +00:00
package.json Initial commit 2020-11-02 14:48:22 +00:00
sample.config.yaml Update readme and default log level 2020-11-13 02:57:21 +00:00
tsconfig.json Initial commit 2020-11-02 14:48:22 +00:00
tslint.json Linting 2020-11-13 03:14:53 +00:00

README.md

mx-puppet-vk

This is a Matrix <-> VK bridge based on mx-puppet-bridge and VK-IO.

It is in early development and should be considered as proof-of-concept. Right now it logs message data when log level includes "info" level.

Group chats are not properly tested.

Installation

git pull https://github.com/innereq/mx-puppet-vk
npm install
npm run build

Next copy the sample.config.yaml to config.yaml, edit it and then run npm run start -- -r to generate a registration file. Register that one with synapse and start the bridge with npm run start.

Features and roadmap

  • Matrix -> VK
    • Text content
    • Image content
    • Audio/Video content
    • Other files
    • Replies
    • Typing notifs - not possible yet
    • Presence - not possible yet
    • Read notifications - not possible yet
    • Message edits
    • Message redacts - only works in 24 hours after message is sent
  • VK -> Matrix
    • Text content
    • Forwards
    • Image content
    • Audio content
    • Video content
    • Stickers
    • Other files
    • Presence - not effective to track
    • Typing notifs
    • User profiles
    • Read notifications - not effective to track
    • Message edits
    • Message redacts - doesn't work

Usage

  1. Get VK community token (Just open the "Manage community" tab, go to "API usage" tab and click "Create token")
  2. Activate Bots Long Poll API ("Manage community" → "API usage" → "Bots Long Poll API") and choose the latest API version. Make sure that under event types all message-realted events are turned on.
  3. Activate an option to message your community. To allow group chats, activate it under bot capabilities.
  4. On matrix, contact @_vk_puppet_bot:your.domain and type link <vk token>
  5. Now, if someone contacts your community, you will be invited to the corresponding room on Matrix.

Plese note: when community is invited to the group chat as a bot, make sure it has message access. Only chat admins can change bot permissions.