mx-puppet-vk/README.md

# mx-puppet-vk
This is a Matrix <-> VK bridge based on [mx-puppet-bridge](https://github.com/Sorunome/mx-puppet-bridge) and [VK-IO](https://github.com/negezor/vk-io).

It is in early development. Right now it logs message data when log level includes "info" level.

Relay mode works too, but we don't recommend it.

## 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`.

## Features and roadmap
- Matrix -> VK
    - [x] Text content
    - [x] Image content
    - [x] Audio/Video content
    - [x] Other files
    - [x] Replies
    - [ ] Typing notifs - Synapse 1.22.0 or later required
    - [ ] Presence - ~~not possible yet~~
    - [ ] Read notifications - ~~not possible yet~~
    - [x] Message edits
    - [x] Message redacts - works as edit, real redact unavailable without being admin in chat
- VK -> Matrix
    - [x] Text content
    - [x] Forwards
    - [x] Image content
    - [x] Audio content
    - [ ] Video content
    - [x] Stickers
    - [x] Other files
    - [ ] Presence - not effective to track
    - [x] Typing notifs
    - [x] User profiles
    - [ ] Read notifications - not effective to track
    - [x] 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.

Bridge doesn't handle being kicked from chat yet.

### Relay usage

See [mx-puppet-bridge docs](https://github.com/Sorunome/mx-puppet-bridge#relay-mode)
Initial commit 2020-11-02 14:48:22 +00:00			`# mx-puppet-vk`
Update readme and default log level 2020-11-13 02:57:21 +00:00			`This is a Matrix <-> VK bridge based on [mx-puppet-bridge](https://github.com/Sorunome/mx-puppet-bridge) and [VK-IO](https://github.com/negezor/vk-io).`
Initial commit 2020-11-02 14:48:22 +00:00
Move from global message IDs to local IDs 2020-11-13 06:42:45 +00:00			`It is in early development. Right now it logs message data when log level includes "info" level.`
Update readme and default log level 2020-11-13 02:57:21 +00:00
Move from global message IDs to local IDs 2020-11-13 06:42:45 +00:00			`Relay mode works too, but we don't recommend it.`
Initial commit 2020-11-02 14:48:22 +00:00
			`## 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`.

Add usage info to readme 2020-11-03 13:47:02 +00:00			`## Features and roadmap`
			`- Matrix -> VK`
			`- [x] Text content`
Add file handling 2020-11-03 19:02:44 +00:00			`- [x] Image content`
			`- [x] Audio/Video content`
			`- [x] Other files`
Initial reply implementation 2020-11-03 16:38:06 +00:00			`- [x] Replies`
Forwards formatting 2020-11-20 08:45:31 +00:00			`- [ ] Typing notifs - Synapse 1.22.0 or later required`
			`- [ ] Presence - ~~not possible yet~~`
			`- [ ] Read notifications - ~~not possible yet~~`
Support for edits and better replies 2020-11-13 01:40:53 +00:00			`- [x] Message edits`
Move from global message IDs to local IDs 2020-11-13 06:42:45 +00:00			`- [x] Message redacts - works as edit, real redact unavailable without being admin in chat`
Add usage info to readme 2020-11-03 13:47:02 +00:00			`- VK -> Matrix`
			`- [x] Text content`
Forwards formatting 2020-11-20 08:45:31 +00:00			`- [x] Forwards`
Add file handling 2020-11-03 19:02:44 +00:00			`- [x] Image content`
Support for edits and better replies 2020-11-13 01:40:53 +00:00			`- [x] Audio content`
			`- [ ] Video content`
			`- [x] Stickers`
Redacts from matrix and documents from vk 2020-11-13 02:02:21 +00:00			`- [x] Other files`
Initial reply implementation 2020-11-03 16:38:06 +00:00			`- [ ] Presence - not effective to track`
Add usage info to readme 2020-11-03 13:47:02 +00:00			`- [x] Typing notifs`
			`- [x] User profiles`
Support for edits and better replies 2020-11-13 01:40:53 +00:00			`- [ ] Read notifications - not effective to track`
			`- [x] Message edits`
Redacts from matrix and documents from vk 2020-11-13 02:02:21 +00:00			`- [ ] Message redacts - doesn't work`
Add usage info to readme 2020-11-03 13:47:02 +00:00
Initial commit 2020-11-02 14:48:22 +00:00			`## Usage`
Add usage info to readme 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.`
Move from global message IDs to local IDs 2020-11-13 06:42:45 +00:00
			`Bridge doesn't handle being kicked from chat yet.`

			`### Relay usage`

			`See [mx-puppet-bridge docs](https://github.com/Sorunome/mx-puppet-bridge#relay-mode)`