matrix threadbot

matrix chatbot for capturing thread messages

About

A bot running on Node.js connecting to a matrix network. On receiving a mention in a thread message it captures the preceding messages into a single copy-pastable reply.

The intended purpose is knowledge capturing by facilitating the transfer of relevant discussions into longer lived and searchable media like forums, wikis, documentations,...

Built With

• Matrix.org
• Node.js
• Typescript

↑

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

• nodejs >= 16
• npm or yarn

Installation

1. Clone the repo

   git clone https://github.com/woeishi/matrix-threadbot-ts.git

2. Install NPM packages

   npm install

   or

   yarn install

3. Create an .env and enter required data (see .env.example)

↑

Usage

live bot

mention its user handle in a message of a matrix chat thread. optionally following arguments:

• below: post the captured message sequence in the thread instead of as direct message
• part: only capture up to last bot mention, defaults to capturing the whole thread
• html or plain: format as html or plain text (minimal md) instead of default markdown
• help or ?: show help message

Development

start node.js with typescript compiler and filewatcher

npm run start:dev

or

yarn start:dev

Building

npm run build

or

yarn build

↑

License

Distributed under the MIT License. See LICENSE.txt for more information.

↑