https://github.com/willnilges/inkpath

A plugin for transcribing hand-drawn notes, diagrams, and tables onto xournalpp documents
https://github.com/willnilges/inkpath

cplusplus lua opencv

Last synced: 10 days ago
JSON representation

A plugin for transcribing hand-drawn notes, diagrams, and tables onto xournalpp documents

• Host: GitHub
• URL: https://github.com/willnilges/inkpath
• Owner: WillNilges
• License: gpl-2.0
• Created: 2021-02-20T17:16:56.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-12-05T23:20:13.000Z (almost 2 years ago)
• Last Synced: 2023-04-08T08:10:49.227Z (over 1 year ago)
• Topics: cplusplus, lua, opencv
• Language: C++
• Homepage:
• Size: 46.7 MB
• Stars: 13
• Watchers: 4
• Forks: 1
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Inkpath











If you're anything like me, you're a ~~huge nerd~~ engineering major who enjoys

working out problems both on whiteboards and digitally. You might also

have six million photos of your whiteboard work trapped on your phone

or in your Google Drive with no good way to easily group them in with

your other notes.



  



Inkpath is a project designed to crunch those whiteboard photos into easily

editable [Xournal++](https://github.com/xournalpp/xournalpp) note files so that you can

drop your whiteboard scrawlings directly into your lecture notes. Convenient!

The project consists of a lua script and a shared object library written in C++

statically linked with some OpenCV utils. The project now uses OpenCV in place

of Autotrace to perform an Otsu Threshold. The thresholded image is then inverted,

and skeletonized, producing the centerline of each individual object in the image

(which at this point should be just markings). The resulting image is then scanned

for contours. These contours are pushed onto the lua stack, and passed to the 

Xournal++ API. Unlike the previous implementation, this operates purely on rasters.

## Installation and Usage

Inkpath is packaged as a statically-linked `.so` file coupled with a Lua script,

so you should be able to download the release from the [releases page](https://github.com/WillNilges/inkpath/releases)

and have it Just Work™.

_As of 2022-09-24, the API changes in Xournalpp are merged, but have not made

it into the package managers. You will probably need to [build xournalpp from source](https://github.com/xournalpp/xournalpp/blob/master/readme/LinuxBuild.md)

in order to get them._

_Inkpath is coming to a package manager near you soon™!_

## Manual Installation

### Arch

```BASH

# Install dependencies

pacman -S \

cmake gtk3 base-devel libxml2 portaudio libsndfile \

poppler-glib texlive-bin texlive-pictures gettext libzip lua53 lua53-lgi \

gtksourceview4 wget unzip git tmux

# Build openCV

./HACKING/build-opencv.sh

```

### Debian

```BASH

# Install dependencies

apt -y install \

make liblua5.3-dev build-essential pkg-config libglib2.0-dev libpng-dev \

cmake libgtk-3-dev libpoppler-glib-dev portaudio19-dev libsndfile-dev \

dvipng texlive libxml2-dev libzip-dev librsvg2-dev gettext lua-lgi \

libgtksourceview-4-dev git gdb x11-apps wget unzip

./HACKING/build-opencv.sh $NUMBER_OF_CORES_YOU_HAVE # You'll need sudo to install this

./HACKING/build-xopp.sh $NUMBER_OF_CORES_YOU_HAVE # You'll probably need sudo to install this too

make install

```