Giter Club home page Giter Club logo

awesome-remarkable's Introduction

Awesome reMarkable Discord

The reMarkable is a paper tablet for those who prefer writing on paper. Its remarkably fast paper-white display, Linux based operating system and awesome community make it highly attractive amongst hackers and developers.

Contributions are welcome as long as they follow the guidelines.

Disclaimer

No project here is affiliated or endorsed by reMarkable AS. If you modify your device official support might refuse to help you.

Write down your SSH password

⚠️ WARNING, READ THIS FIRST ⚠️

Make sure you have saved your SSH password somewhere secure, or you have setup a SSH key

You can find the SSH password in your settings: Settings > Help > Copyrights and licenses > General information (scroll down).

Failure to do so could result in a soft-bricked device that requires emergency recovery.

Factory reset may brick your device

This function may not do what you are expecting. While it resets all user data, it will not restore the device to the original factory condition. It will reset your SSH password and remove all SSH keys, which may make it impossible to connect to your device if it is malfunctioning.

See remarkable.guide for more information on how to properly factory reset your device.

Take special care if you are using a reMarkable 2.

Contents

APIs

Cloud API

  • (Unmaintained) google-drive-remarkable-sync - Apps Script API for reMarkable Cloud. Includes Synchronizer capability to automate mirroring of documents from Google Drive to reMarkable Cloud.
  • jrmapi - A Java API for the reMarkable Cloud.
  • reMarkableAPI - Docs and implementation of the reMarkable file sync API.
  • reMarkable-typescript - TypeScript API for reMarkable Cloud.
  • Remarkable.jl - Julia API Interface to the reMarkable cloud.
  • remarkdav - A tool to sync PDF files from a WebDAV directory to the reMarkable Cloud.
  • rMAPI - ReMarkable Cloud Go API.
  • rmapy - ReMarkable Cloud Python API.
  • rmcl- Asynchronous Python library for the reMarkable Cloud.
  • rmfakecloud - Fake Cloud Sync, server implementation of the Cloud API.

Lines Format

  • lines-are-beautiful - C++ File API for the reMarkable tablet.
  • lines-are-rusty - Rust File API for the reMarkable tablet.
  • reMarkable-kaitai - Kaitai Struct format specification for the binary lines format.
  • (Unmaintained) reMarkable-layers - Python API for reading & writing reMarkable Lines format. Supports very basic conversion of PDFs and SVGs to Lines format.
  • rmrl - The reMarkable Rendering Library for Python converts annotated documents to PDF files.

Other APIs

  • libreMarkable - A framework for developing applications with native refresh support for reMarkable Tablet.

Applications

Games

  • chessMarkable - Play chess against a bot or a friend.
  • DOOMarkable - Play DOOM on the reMarkable 1.
  • minesweeper - A mine detection game.
  • recrossable - Crossword game with simplistic handwriting recognition and automatic generation of crosswords.
  • retris - Play a clone of the popular block stacking game with either buttons or swipe guestures.

Launchers

  • draft-reMarkable - A launcher for the reMarkable tablet, which wraps around the standard interface.
  • oxide - A launcher application for the reMarkable tablet.
  • remux - A multi-tasking launcher for the reMarkable tablet.

Cloud Tools

  • CUPS Printing - Script to print directly to reMarkable Cloud from CUPS using rMAPI.
  • mendeley-rMsync - Script to sync PDFs (with annotations) from/to a Mendeley folder.
  • (Unmaintained) reCatchable - Turn websites into ebooks, upload them to reMarkable.
  • reGitable - Backup your reMarkable with git and sync changes to a remote repository automatically.
  • remarkable_simplenote - Sync simplenote notes to reMarkable (currently one-way)
  • reMarkable-Sink - Turn a folder into a wormhole to your reMarkable.
  • remarkable-substack - Syncs unread Substack posts to the reMarkable Cloud.
  • reMarkable_syncthing - Syncthing on reMarkable.
  • remarkable-zapier - Zapier Integration for reMarkable Cloud
  • remarking - CLI tool to extract highlights from any document in the reMarkable cloud.
  • rm-pdf-tools - Service that allows users to insert and delete pages from annotated PDFs on the device.
  • rM-sync - Sync script for reMarkable paper tablet.
  • RMfuse - FUSE filesystem for the reMarkable Cloud.
  • sync_zotero_remarkable - Sync PDFs from Zotero to reMarkable.
  • url2epub - Telegram bot to generate ePub out of URL and send directly to reMarkable Cloud.
  • zotero-reMarkable - Script to sync PDFs from the Zotero reference manager.
  • Zotero2reMarkable Bridge - Sync files from Zotero to reMarkable and back based on tags; supports v2.7< highlights.

Device Tools

  • paginator - Physical foot pedal to turn pages on the device with no hands (e.g. for playing sheet music).
  • ReCept - Fix for the rM2 jagged line issue.
  • rM-signature-patch - Simple script to remove that pesky advert at the bottom of a mail originating from a reMarkable.
  • remarvin - Profile and file encrytion manager that allows to manage notebooks for different users and to optionally protect the files with a password through gocryptfs-based encryption (device only).
  • Signature-rM - Remove the signature from the bottom of emails sent from the device.
  • splash.dat converter - Simple script to convert an image to the rM2 .dat format for a splash screen.
  • WebInterface-OnBoot - Enable the web interface on boot.
  • WebInterface-Upload-Button - Upload button for the web interface, alternative to drag and drop.
  • WebInterface-Wifi - View the web interface if running, over wifi.

GUI Clients

  • asTounding - A multiplatform GUI application for the reMarkable cloud, including Linux.
  • RemaPy - GUI to browse, download/upload files and backup the tablet (also on Linux) using the cloud.
  • reMarkable-assistant - Manage templates, splash screens, and settings on your reMarkable tablet.
  • reMarkable Connection Utility (RCU) - A cross-platform client for offline management of backups, screenshots, notebooks, templates, wallpaper, and third-party software.
  • reMarkable-hyutilities - A GUI written in java to backup your device, upload templates and modify splash screens.
  • reMarkable Remember - A cross-platform client for offline management of backups, notebooks, templates and hand writing recognition via MyScript.
  • ReMy - A GUI to browse, preview documents, export documents with custom settings, all via SSH (no cloud needed); works from local raw backups too.
  • rM2 Template Helper Windows tool for template management, and to download community templates.
  • rMExplorer - GUI to browse, download/upload files and backup the tablet without using the cloud.
  • rmUploader - Simple web app to upload epub or pdf files to the reMarkable tablet via drag and drop.
  • rmWebUI - Simple web interface to the reMarkable® cloud.
  • (Unmaintained) Slithin - Free Management Application for Windows/Linux/MacOS.

Other

  • Book-safe - Hide books/documents between a given time period.
  • (Unmaintained) Calibre-Remarkable-Device-Driver-Plugin - A Calibre Plugin to Manage your Remarkable Books.
  • Crazy Cow - Typewriter input from USB keyboard directly into reMarkable interface.
  • Drawj2d - Create technical line drawings on an editable reMarkable notebook page. (Guidance how to upload the page to the device using rMAPI.)
  • Funcky reMarkable Exporter - Export notes from a reMarkable Tablet to File System and External Services.
  • Goosepaper: Deliver prettily-formatted RSS feeds, news articles, Wikipedia articles-of-the-day, and more to your reMarkable tablet.
  • instapaper-as-pdf-to-reMarkable - Export Instapaper-Articles to PDF and send them to a connected rM tablet.
  • landscape-pdf - Utility to convert pdf documents to read in landscape mode. Useful for papers and text books.
  • morningpaper2reMarkable - A bot to sync the morning paper to a reMarkable tablet.
  • nix-remarkable - Nix expressions for the reMarkable tablet leveraging the company's toolchain.
  • paper2reMarkable - Download an academic paper or HTML article, crop it, and send it to the reMarkable with a single command.
  • mail2rm - Mail PDF documents to your reMarkable cloud using your mail transport agent e.g. postfix.
  • microSD - Tutorial for adding a microSD card reader to the reMarkable 1.
  • neofetch - A command-line system information tool written in bash 3.2+.
  • Parabola-rM - A Desktop GNU/Linux-libre replacement OS with fast partial refreshing and USB OTG.
  • pdf2rmnotebook - Creates a reMarkable Notebook from multiple PDF files.
  • pocket2rm - Synchronize articles from read-later platform pocket in PDF and epub.
  • remailable - Email PDFs directly to your reMarkable. (Free publicly-hosted version available).
  • reHackable/maxio - Companion daemon for the reMarkable paper tablet.
  • (Unmaintained) reHackable/scripts - A set of bash scripts that may enhance your reMarkable experience.
  • reMarkable CLI tooling - CLI-tooling to sync documents to a reMarkable, to clean deleted files etc. without needing cloud access
  • reMarkable-crosswords - Get crosswords freshly delivered to your Remarkable every morning.
  • reMarkable_entware - Package manager for reMarkable. Install common Unix utilities through the command line.
  • reMarkable_keyboard - Software to use rM as wireless keyboard/mouse.
  • reMarkable_mouse - Use your reMarkable as a graphics tablet.
  • remarkable_news - Use daily news/comics/images as the suspend screen.
  • reMarkable_pdflets - Dynamically updating PDFs.
  • remarkable_printer - Print from any device to reMarkable without browser extensions or reMarkable cloud.
  • reMarkable-fs - A FUSE filesystem wrapper for the reMarkable tablet.
  • reMarkable-random-screens - Change your poweroff and suspend screens every 5 minutes with random images of your choice
  • remarkable-shortcuts - Add extra 'gestures' (currently double taps) for easier navigation.
  • reMarkable-touchgestures - Touch gestures (swipe/touch) for easy page navigation.
  • (Unmaintained) reMarkable-tweak - Tweak tool for the reMarkable paper tablet. Lets you organize your templates with no fuss.
  • reMarkablePocket - Synchronize articles from read-later platform Pocket in epub format.
  • reMarkableSync - A Microsoft OneNote addin for importing notebooks from reMarkable as text or images.
  • remarks - Extract highlights, scribbles, and annotations from PDFs. Export to Markdown, PNG, and SVG.
  • reMouseable - Use your reMarkable tablet as a mouse.
  • remt - reMarkable tablet command-line tools.
  • reSnap - Take snapshots of your reMarkable screen over SSH.
  • rM-dl-annotated - Export annotated PDFs from reMarkable tablets.
  • rm-pySAS - Python wrapper for simple.
  • rmirro - A script that synchronizes PDFs of documents between a Remarkable and a computer folder that mirrors its file structure without cloud access.
  • rMsync - Synchronisation script with a local dedicated "library" folder.
  • rmTabletDriver - Application that allows you to simulate/clone rM input on your computer.
  • rmWacomToMouse - Use the wacom pen as a mouse to draw on your pc.
  • rmWebUiTools - View a file tree, see statistics and export/backup all files with some simple scripts utilizing the web ui.
  • send_by_rmapi - A Calibre plugin to send books to your reMarkable, making use of rmapi.
  • RemarkableLamyEraser - Supports Lamy Al Star stylus button to erase or undo for reMarkable tablets.
  • rm2anki - Convert reMarkable notebooks into an Anki card decks.

Screen Sharing/Streaming

  • goMarkableStream - Stream the screen of the reMarkable 2 (FW 2.5) easily (client/server in Go with no installation) along with the colors (with FW > 2.11.x).
  • pipes and paper - Stream pen strokes to browser canvas via websockets (blog post). Uses Python and SSH, nothing to compile or install on the reMarkable device.
  • pipes and paper enhanced - Share the pen strokes to a browser without installling anything on the ReMarkable (a revived fork of the previous link with pen colors and eraser support, responsive interface).
  • pipes and rust - (Made for rM2) Stream pen strokes to browser. A single executable on the reMarkable that hosts a tiny webserver in the local WLAN.
  • reStream - Stream your reMarkable screen over SSH.
  • rMview - A fast GUI to stream your reMarkable screen over vanilla-SSH or VNC.
  • rM-vnc-server - A fast & efficient damage-tracking (sending only updated regions) VNC server for streaming the reMarkable's screen.
  • srvfb - Alternative screen-streaming software. Written in Go.
  • VNSee - VNC client for the reMarkable tablet allowing you to use the device as a second screen.

Custom Templates

Template Builders

awesome-remarkable's People

Contributors

ameb avatar anytimetraveler avatar asciipip avatar barabazs avatar bruot avatar bsdz avatar camillehbp avatar ctxz avatar dps avatar edupont avatar eeems avatar evidlo avatar fsniper avatar j6k4m8 avatar kevlened avatar lapwat avatar liblor avatar linuscde avatar nov1n avatar peerdavid avatar pepikvaio avatar plan5 avatar pyrrhu5 avatar qwert2003 avatar rioam2 avatar rm-self-serve avatar robsliwi avatar rschroll avatar stachudotnet avatar themightychris avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

awesome-remarkable's Issues

Suggestion for incrementally improving the topics

Thank you; this is a great source of information and it will motivate people to create more tools.
One suggestion I'd make is that a wrapper for a specific language that calls reMarkable API would most accurately be called an "SDK", at least from a developer's perspective. An API would be if someone offered another cloud service that then talked to reMarkable's.

Any way to adjust pressure sensitivity?

Does anyone know any way to adjust the pressure sensitivity? - I find that I need to press far too hard for the ballpoint pen, I would like to increase the sensitivity.

establish a common tag/topic?

Github allows tagging projects with topics. It would be useful if we could establish a standard topic for all reMarkable related projects to differentiate them from the remarkable Markdown editor. Maybe remarkable-paper or remarkable-tablet? Would be a good start to tag all projects within this organisation accordingly.

Once this is established, maintaining the list in this repository should become somewhat easier.

remt

We might add this python library to the list, it is hosted on gitlab.

Features

remt project features are

  • reMarkable tablet operations

    • list files and directories
    • create directories
    • export a notebook as PDF file
    • export an annotated PDF document
    • import a PDF document
  • significantly smaller PDF files comparing to the ones exported by the
    reMarkable tablet

  • export supports

    • multi-page notebooks and PDF files

    • the following drawing tools

      • ballpoint (no brush supported yet)
      • fineliner
      • sharp pencil with pencil brush
      • highlighter
      • eraser
  • remt project can be used as a library for UI applications

Dark mode for reading and writing

Hello,

Do you know if there is any possibility to use a dark mode for reading and writing [white words on a black surface] for rM and rM2?

Thank you in advance

Categories are confusing

We need a better way to categorise the items on the list. Device Tools is disleading and generic, since most of the items on the list are tools to manage our reMarkable device.

I'd start by sorting out stuff that runs on the host machine and stuff that runs on the tablet. Then if they use ssh or the web interface to communicate with the device.

What do you think?

[Suggestion] Add warning about Factory Reset and root password

I suggest to add another warning that a Factory Reset will only delete /home/root/* and especially that it will generate a new root password.

For example:
Factory resetting through xochitl will generate a new root password and it will only delete the files in /home/root/. Be careful not to brick your device by removing alternative launchers this way.

Background: I've made the unpleasant experience of bricking my rM2 by running a factory reset. I thought it would be like an update, bringing the whole filesystem back to the original state.

However, rm2fb service remained enabled but the binary was deleted as it resided in /home/root/. This way, the GUI cannot boot and the password is inaccessible without the necessary hardware to access the OTG mode.

I read the warnings beforehand and this would have avoided a lot of trouble for me.

Add or replace existing plato entry?

Hi,
I recently re-ported plato to the reMarkable.

That port uses a more recent version and also has some additional finetuning that the first port didnt't have like:

  • More fine grained refreshing
  • Selection of partial refresh quality
  • Wacom Pen support
  • Selection of input type
  • All the features that were added to the official plato repo in the last 2 years.

As there is already the plato port from darvin, I'm not sure whether I should create a PR to replace the link to his repo or add a second plato entry (and how should I mark/name that?).
Personally, I don't want to remove darvins port since he was the first to do it and inspired me redo it since I wanted to see what changes came in the last 2 years and also had a great opportunity to learn more rust and probably find a UI-Base to create a Mango-Client on.

What is your opinion on this, @darvin ?

It'd help if the list indicated which levels of reMarkable could support which packages

My tablet is currently running 3.9.3.1986, and unfortunately many (most? all?) of the available packages support only 2.x versions of ReMarkable. It'd help tremendously to know what my options were at a glance, rather than having to chase into each project's docs. In particular I don't know of a launcher that is compatible with v3, and toltec officially doesn't go past v2 yet.

I'd even be willing to consider rolling the tablet back to v2 of the reMarkable package if necessary -- if there's a documented process for that and if there's a way to make sure it can't accidentally be updated into failing even if someone "helpfully" flips the Automatic Update switch.

Keyboard support?

Anyone know if someone's working on keyboard support through the microUSB port (and, I suppose, a simple text editor app)?

old os

Hello friends - I inadvertently overwrote the Remarkable Desktop app on my Mac with a version that does not run with the current OS> I'd like to go back to an odler version, but don't see any of htese archived on the remarkable website. Does anyone know where I can find old versions of the official OS?

Thanks

[Suggestion] Mention if repo is deprecated

Mention in the lists if the repo is deprecated or not.
Something like :

  • 🔴 CUPS Printing - Script to print directly to reMarkable Cloud from CUPS using rMAPI.
  • ✅ reMarkable_syncthing - Syncthing on reMarkable.

Zen mode with right button to switch from pen to eraser

Hello,

Could it be possible for left-handed player to switch from the pen to the eraser with the right button in zen mode? (since it is my free hand when I write)

Otherwise, this mode is so great! I use it all the time.
The new button to easily switch from 1 recent document to another also is very useful. Now when I read an article, I can put its notations in a notebook.

Thanks!

PS: Have you considered assigning an action to the third button in zen mode? For me it could be nice to open the "recent file" window you created. Another suggestion would be the undo button (but it would not be as useful as I can erase easily in zen mode).

Not an issue but a project you may /or not be interested in

I didnt see this depot until I looked into reading .rm files,

When remarkable software version hit 3.5 they removed the ability to upload files with the ip interface, instead requiring an app which pissed me off so i instead upladed thru ssh and modified content and metadata files, and ensured no automatic updates. Since that goes against my use of the tablet - all i care is to upload pdfs, fast. and i dont need any new user accounts -

I had to make it simpler for my kid yesterday so I built a mini project with console scripts - tested on ubuntu but i have to set it up for a mac as well

  • pdf_to_remarkable filename.pdf "visible name parent"
  • backup_remarkable local_folder
  • remrkable_file_graph local_backup_folder
    If anyone is interested
    https://github.com/xvdp/unremarkable

Contribution guidelines shouldn't apply to repo/project names

The contribution guidelines are good, but it doesn't make sense for them to apply to the repo names. In Python, modules are case sensitive and usually lowercase. This is how my projects appear on PyPi (remarkable_mouse, remarkable_keyboard, remarkable_entware, remarkable_pdflets).

It's also unclear how to apply this rule to projects like remt, rmapi, rmsync, rmtabletdriver, etc.

I recommend we restrict these guidelines to the description for each submission and let the authors decide how their project is stylized.

Add 'remouseable' to [Other]

Having verified remouseable works on the reMarkable 2 and is so easy to use, both wired and wirelessly, I thought you could add it to the 'Other' list.

The only thing you need to know for RM2 is that you will have to add this option in the command line call:
--event-file /dev/input/event1
So the whole command should look like this:
remouseable --event-file /dev/input/event1 --ssh-ip="192.168.1.XXX:22" --ssh-password="yourpassword"

The binary is in the release section, you then rename it to remouseable, and make it executable with chmod +x before going ahead with the command line call.

Link to IRC/Matrix room

It would be nice if there were a centralized place to chat about the reMarkable and reMarkable development. The reMarkable subreddit has a Discord, but that doesn't jive with FOSS.

I propose the creation of an IRC room (e.g. #remarkable on Freenode) and linking it in the readme to encourage discussion surrounding the reMarkable and reMarkable development.

Might also want to advertise it on Reddit and the reMarkable wiki.

upside down version of UI

Would any one be able to produce an upside down version of the UI ?
so we can work / draw / write with the buttons above the screen rather than under the screen right below the hand, where you don't want them ?

Question: collaborate by syncing two remarkable screens

Sorry if this isn't the right place for this, but I was wondering if anyone is working on syncing two (or more) remarkable screens across a network. The idea is to write on one remarkable and see the result on the other remarkable live, and vice versa.

As a weaker alternative, is it possible to write on a remarkable by writing on a laptop screen? e.g., draw a line on the laptop and see the result on a connected remarkable live. Using projects like @Evidlo's remarkable_mouse it is possible to write on a laptop using remarkable, but I'm looking for the inverse to this. Eventually the goal would be to connect to tools like https://excalidraw.com so multiple people can collaborate on remarkables, laptops, tablets, etc.

This would be like collaborating using a whiteboard, but remotely with each person having a remarkable.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.