Reacjibot

This is a Maubot plugin for use in a Matrix chat room. The plugin allows you to define arbitrary emoji reactions that will cause messages tagged with the specified emoji to be automatically cross-posted to a different room. Once you have installed an initial configuration, you can define, undefine, and list mappings in the room with the !reacji command (or whatever you define as base_command in the configuration).

Example use cases could be tagging messages with 💡 to post them to an #ideas channel for follow-up. Or if a message is off-topic, an emoji-reaction (say 🚋) could cause the message to be reposted to the room with the correct topic for further discussion (say #public_transportation).

You'll need to create an initial config.yaml (based on example-config.yaml) to specify mappings. For example:

mapping:
  ⭐️: 'favorites'
  💡: 'ideas'
  🚋: 'public_transportation'

Will cause any message tagged with the star emoji ⭐ to be posted to the local room with the alias #favorites, and likewise for 💡 to #ideas and 🚋 to #public_transportation. You can define as many actions as you want, although currently the plugin is limited to posting to one room per emoji reaction.

In the cross-posted channel, the message will have the emoji that caused the cross-post appended to the end which serves as a hyperlink back to the original message, as well as the name of the user who caused the cross-post.

Note the YAML parser is fussy and needs a space after the colon for the mapping to work correctly. You will also need to put the room name in quotes if you use the fully qualified room name (!room_id:server.tld) as opposed to the local alias.

Although perhaps obvious, your Maubot user running this plugin will need to be a member of both the source and target rooms to perform its function.

Important security warning

If insecure is set to true (the default setting), the plugin will post from any room defined in the configuration to any other room defined in the configuration, regardless of encryption of the source and destination rooms. So, depending on how you configure it, you could have it post from an encrypted room to a non-encrypted room (or vice-versa), so long as your maubot client is in both rooms. If you want to prohibit this behavior, set insecure in config.yaml to false.

TODO

• cull back unnecessary libraries
• allow multiple room posting with single emoji