https://github.com/abmantis/matrix-remarkable-bot
A Matrix chat bot that can send files and webpages to reMarkable tablet
https://github.com/abmantis/matrix-remarkable-bot
matrix-bot matrix-chat remarkable-tablet
Last synced: 12 months ago
JSON representation
A Matrix chat bot that can send files and webpages to reMarkable tablet
- Host: GitHub
- URL: https://github.com/abmantis/matrix-remarkable-bot
- Owner: abmantis
- License: mit
- Created: 2022-03-04T22:58:59.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-03-15T00:34:37.000Z (about 4 years ago)
- Last Synced: 2025-06-10T00:41:54.483Z (12 months ago)
- Topics: matrix-bot, matrix-chat, remarkable-tablet
- Language: TypeScript
- Homepage:
- Size: 80.1 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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.
1. Run this project's setup:
`$ npm run setup`
After the setup completes, an `out` folder should be generated.
1. Copy the `config-example.yaml` file to the `out` folder, name it `config.yaml`.
1. 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).
1. 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.