abmantis / matrix-remarkable-bot

A Matrix chat bot that can send files and webpages to reMarkable tablet

Matrix reMarkable Bot

A Matrix chat bot that can send files and webpages to the reMarkable tablet, using reMarkable's cloud.

WARNING

There is no user restrictions or multiuser support implemented yet, so anyone who knows your bot's username, can use your it (and send files to your RM).

How to use

Currently, the only way to use this is to clone or download this repo. After you do it, follow the following instructions:

1. Create a new Matrix user for your bot on any matrix homeserver.

2. Run this project's setup:

   $ npm run setup

   After the setup completes, an out folder should be generated.

3. Copy the config-example.yaml file to the out folder, name it config.yaml.

4. Edit the out/config.yaml and set the correct homeserver url and Matrix user access token (see https://t2bot.io/docs/access_tokens/ on how to get an access token).

5. Run the bot:

   $ npm run bot

From this point on the bot should be running. Invite it to an unencripted room on Matrix (e2e encryption is not supported yet), write the help command to it and follow its instructions.

matrix-remarkable-bot's Issues

Add remarkable-tablet topic

Please add the remarkable-tablet topic to the repo to make it easier to find.