mx-puppet-vk/README.md

49 lines
1.9 KiB
Markdown
Raw Normal View History

2020-11-02 14:48:22 +00:00
# mx-puppet-vk
This is a Matrix <-> VK bridge based on [mx-puppet-bridge](https://github.com/Sorunome/mx-puppet-bridge).
It is it early development and should be considered as proof-of-concept.
## Installation
```bash
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`.
2020-11-03 13:47:02 +00:00
## Features and roadmap
- Matrix -> VK
- [x] Text content
2020-11-03 19:02:44 +00:00
- [x] Image content
- [x] Audio/Video content
- [x] Other files
2020-11-03 16:38:06 +00:00
- [x] Replies
- [ ] Typing notifs - not possible yet
- [ ] Presence - not possible yet
- [ ] Read notifications - not possible yet
2020-11-13 01:40:53 +00:00
- [x] Message edits
2020-11-03 14:36:14 +00:00
- [ ] Message redacts
2020-11-03 13:47:02 +00:00
- VK -> Matrix
- [x] Text content
2020-11-03 19:02:44 +00:00
- [x] Image content
2020-11-13 01:40:53 +00:00
- [x] Audio content
- [ ] Video content
- [x] Stickers
2020-11-03 13:47:02 +00:00
- [ ] Other files
2020-11-03 16:38:06 +00:00
- [ ] Presence - not effective to track
2020-11-03 13:47:02 +00:00
- [x] Typing notifs
- [x] User profiles
2020-11-13 01:40:53 +00:00
- [ ] Read notifications - not effective to track
- [x] Message edits
2020-11-03 14:36:14 +00:00
- [ ] Message redacts
2020-11-03 13:47:02 +00:00
2020-11-02 14:48:22 +00:00
## Usage
2020-11-03 13:47:02 +00:00
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.