Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

C++ File API for the reMarkable tablet
https://github.com/ax3l/lines-are-beautiful

eink file-format remarkable-tablet tablet

Last synced: 12 days ago
JSON representation

C++ File API for the reMarkable tablet

Awesome Lists containing this project

README 

        
# Lines Are Beautiful



[![Build Status develop](https://img.shields.io/travis/ax3l/lines-are-beautiful/develop.svg?label=develop)](https://travis-ci.org/ax3l/lines-are-beautiful/branches)

[![Doxygen Docs](https://img.shields.io/badge/docs-doxygen-blue.svg)](https://ax3l.github.io/lines-are-beautiful/)

[![Manual Status](https://readthedocs.org/projects/rmlab/badge/?version=latest)](http://rmlab.readthedocs.io)

[![Language](https://img.shields.io/badge/language-C%2B%2B11-orange.svg)](https://isocpp.org)

[![License](https://img.shields.io/badge/license-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0.html)



A C++ file API for the [reMarkable e-ink tablet](https://remarkable.com).



**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+](https://github.com/pngwriter/pngwriter)

  (optional for png converts; extend environment variable `CMAKE_PREFIX_PATH` with its install location)



## Install



[![Spack Package](https://img.shields.io/badge/spack-rmlab-brightgreen.svg)](https://spack.io)

[![Conan Package](https://img.shields.io/badge/conan-notyet-yellow.svg)](https://conan.io)

[![Conda Package](https://img.shields.io/badge/conda-notyet-yellow.svg)](https://conda.io)

[![Docker Image](https://img.shields.io/badge/docker-notyet-yellow.svg)](https://docker.io)



### Spack



```bash

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:



```bash

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.



```bash

# path to the directory containing the notebook

lines2png share/rmlab/examples/aa90b0e7-5c1a-42fe-930f-dad9cf3363cc

#   creates files "test-0.png", "test-1.png", ... per page in the current directory

```



Note: this tool depends on an installed [PNGwriter](https://github.com/pngwriter/pngwriter) dependency.



### SVG renderer



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



* [x] Basic strokes.

* [x] Initial brush size.

* [x] Brush color.

* [x] Highlighter.

* [x] Normal eraser.

* [x] Region eraser.

* [x] Layers.

* [ ] Brush size variation based on pressure/tilt.

* [ ] Brush texture.



```bash

# path to the directory containing the notebook

lines2svg share/rmlab/examples/e09e6bd4-3647-41e7-98be-b9c3b53d80c8

#   creates files "test-0.svg", "test-1.svg", ... per page in the current directory

```



## Usage API



Set environment hints:

```bash

# 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`:

```cmake

# 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:

```cmake

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



target_link_libraries(YourTarget PRIVATE Rmlab::Rmlab)

```



In your C++ files (see [Doxygen](https://ax3l.github.io/lines-are-beautiful/)):

```C++

#include 

#include 



// ...



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, Talks



- [general](https://plasma.ninja/blog/devices/remarkable/2017/12/18/reMarkable-exporation.html)

- [file format](https://plasma.ninja/blog/devices/remarkable/binary/format/2017/12/26/reMarkable-lines-file-format.html)

- 5' talk at *34C3* [en]:

  - [slides](https://plasma.ninja/34c3/reMarkable_binary_format.pdf)

  - [video](https://media.ccc.de/v/34c3-9257-lightning_talks_day_3#t=1405) (around minute 23+)

- talk at *Datenspuren 2018* [de]:

  - [slides](https://plasma.ninja/ds18/reMarkable_binary_format_ds18.pdf)

  - [video](https://media.ccc.de/v/DS2018-9324-freeing_the_binary_format_of_the_remarkable_e-ink_tablet)



### Experimental Implementation in Rust



- every C++ programmer likes to learn Rust: [lines-are-rusty](https://github.com/ax3l/lines-are-rusty)



## 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.