C++ File API for the reMarkable tablet
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
include/rmlab
share/rmlab/examples
.gitignore
.travis.yml
CMakeLists.txt
Doxyfile
LICENSE
README.md
RmlabConfig.cmake.in

README.md

Lines Are Beautiful

Build Status develop Doxygen Docs Manual Status Language License

A C++ file API for the reMarkable e-ink tablet.

Warning: The libraries and tools in this project are not (yet) hardened for malicious input. Only process files that you can trust with it!

Dependencies

  • A C++11 capable compiler such as
    • GCC 4.8+ (tested)
    • Clang 3.9+ (tested)
  • CMake 3.7+
  • PNGwriter 0.7.0+ (optional for png converts; extend environment variable CMAKE_PREFIX_PATH with its install location)

Install

Spack Package Conan Package Conda Package Docker Image

Spack

spack install rmlab
spack load rmlab

From Source

If one of the popular user-level package managers above is not already satisfying your needs, install from source via:

git clone https://github.com/ax3l/lines-are-beautiful.git

mkdir lines-are-beautiful/build
cd lines-are-beautiful/build

# for own install prefix append: -DCMAKE_INSTALL_PREFIX=$HOME/somepath
cmake ..

make -j

# optional
make test

# sudo is only required for system paths
sudo make install

Usage CLI

Lines Are Beautiful comes with several tools to handle files produced by the tablet. Try them on your own files inside $HOME/.local/share/remarkable/xochitl/ :-)

PNG renderer

This is a small example implementing a renderer for PNG while changing the brush type.

# without the ".lines" file ending!
lines2png share/rmlab/examples/aa90b0e7-5c1a-42fe-930f-dad9cf3363cc
#   creates file "test.png" in the current directory

Note: this tool depends on an installed PNGwriter dependency.

SVG renderer

This notebook renderer creates a set of SVG files, one for each page. Implementation status:

  • Basic strokes.
  • Initial brush size.
  • Brush color.
  • Highlighter.
  • Normal eraser.
  • Region eraser.
  • Layers.
  • Brush size variation based on pressure/tilt.
  • Brush texture.
# without the ".lines" file ending!
lines2svg share/rmlab/examples/e09e6bd4-3647-41e7-98be-b9c3b53d80c8
#   creates files "test-0.svg", "test-1.svg", ... in the current directory

Usage API

Set environment hints:

# optional: only needed if installed outside of system paths
export CMAKE_PREFIX_PATH=/your/path/to/installed/path:$CMAKE_PREFIX_PATH

Add to your CMakeLists.txt:

# supports:                     COMPONENTS PNG
find_package(Rmlab 0.1.0 CONFIG)

target_link_libraries(YourTarget PRIVATE Rmlab::Rmlab)

Alternatively, add whole repository directly to your project and add it via:

add_subdirectory("path/to/source/of/lines-are-beautiful")

target_link_libraries(YourTarget PRIVATE Rmlab::Rmlab)

In your C++ files (see Doxygen):

#include <rmlab/rmlab.hpp>
#include <iostream>

// ...

rmlab::Notebook myNotebook("share/rmlab/examples/aa90b0e7-5c1a-42fe-930f-dad9cf3363cc");

for( auto & page : myNotebook.pages )
    for( auto & layer : page.layers )
        for( auto & line : layer.lines )
            for( auto & point : line.points )
                std::cout << point.x << " " << point.y << std::endl;

Resources

Blog articles

Disclaimer

This is a hobby project.

The author(s) and contributor(s) are not associated with reMarkable AS, Norway. reMarkable is a registered trademark of reMarkable AS in some countries. Please see https://remarkable.com for their product.