Skip to content

RedTTGMoss/librm_lines

Repository files navigation

LIB rM Lines

This project is largely been made possible by all the findings made by the community. Projects like rMscene.

But the goal is not just to read these files but to also have a comprehensive library to work with them, and to be able to render them in real time.

This project will try to maintain compatibility as remarkable updates their file format.

wakatime

Development builds

This library is:

  • A .rm lines reader
  • A real time renderer
  • A .rm lines writer not yet

Dependencies

  • cmake - for building
  • gcc - for building
  • emscripten - for building the wasm variant
  • python3 - for building and running

If you have nix, run nix develop to get all of the above.

Building

The project contains a cmake file with everything preconfigured.

To build the shared library file for your operating system

cmake build --target rm_lines

To build the library for wasm / web

Make sure you have emscripten installed and configured

emcmake cmake -B build-web -S .
cmake --build build-web --target rm_lines_wasm

You can then run the small web demo, first host the root folder

python -m http.server 8000

Then open http://127.0.0.1:8000/tests/

You can also build the test executable

cmake build --target test

Testing

If you build the test executable just run it directly.

If you build the shared library file following the above steps you could now run one of the python tests in the tests folder.

Make sure that they are ran from inside the tests folder! You can install any missing packages, if you run into any other issue open it as an issue here.

Shoutouts

This project wouldn't have been possible without rMscene and the open sourced project by reMarkable themselves quill also a big shoutout to the Moss supporters too!

Some of the test files included are by my fellow testers! Shout out to them too!

Usage & Releases

You can find versionned releases of the shared library on this repo.

The shared library exposes a few basic functions to use. (docs coming soon)

You can also use wrappers:

About

A C++ Implementation of rMscene and rm_lines from the python implementations. Using custom rendering with quill

Topics

Resources

License

Stars

8 stars

Watchers

1 watching

Forks

Packages

 
 
 

Contributors