szybet / sanki Goto Github PK

View Code? Open in Web Editor NEW

40.0 3.0 1.0 46.67 MB

small anki app rewritten for e-readers, with focus on InkBox support, written in Qt5 & C++

License: GNU General Public License v3.0

C++ 85.88% QMake 2.90% Shell 5.44% C 1.50% Rust 4.29%

anki ereader kobo kobo-ereader flashcards

sanki's Introduction

sanki

small anki app rewritten for e-readers in Qt & c++ (No QML), with focus on InkBox support

0.2 version demo:

https://github.com/Szybet/sanki/raw/master/sanki-demo.mkv

Supported, tested devices:

Kobo Nia
Kobo Clara 2E - Thanks Rumpelstilzli
Kobo Clara HD - Thanks elinkser

Should work on all devices, if not, please export debug info in device settings and send me it.

Sync

To sync sanki with anki ( On Linux host ):

Setup anki connect on anki
Install rust ( The programming language )
Clone the repo, enter sanki-sync repo
Run the following command ( Make sure it's running a stable toolchain, nightly doesn't work )
```
cargo run --release -- --help
```
Adjust your command line options, then run the server, wait for it to finish getting all the decks
On the ereader, input your host IP address and port like that: <ip_address>:<port> for example 192.168.1.1:8766
Sync :)

anki-attach

This tool allows to open koreader and read books directly from sanki. Notes:

Works only on InkBox OS
Avoid using dots and command in your file names :/

Installation

For Nickel, just extract the zip to the main folder when connecting via usb - You also need Nickel Menu, Kfmon and Koreader installed ( from the one click package )
For InkBox, extract it to .apps folder

Keep in mind

The app has problems with images above 2MB. It lags and gestures freeze. The sync program at default solves the issue by resizing the images inside

Contribute

Everything really is welcome.

Building

Instructions can be found here

Thanks to

NiLuJe for providing the toolchain for kobo devices, and helping with some bugs
tux-linux for developing inkbox and helping with qt magic
Rain92 for developing the qt5-kobo-platform-plugin

Donations

If you want to support the project, or request a feature I'm not interested in implementing, please contact ;)

sanki's People

Contributors

Stargazers

Watchers

Forkers

darigovresearch

sanki's Issues

Build sanki for Kobo Clara 2E

Hi Szybet

I struggle to get sanki running on my Kobo Clara 2E.

Gerneral question, can your project run without inkbox?

Hi, i've got a kobo nia and i'm willing to try your app, could you please give me a short hint of how to build the app and install it onto de kobo nia? I already have a little knowledge about compiling linux apps so i think i can do it. Thank you so much.

[FEATURE REQUEST] Add security policy

Is your feature request related to a problem? Please describe.
There appears to be no way to understand what to do if there is a security bug

Describe the solution you'd like
Add a policy to the security tab

Describe alternatives you've considered
Can be in the readme but the security tab is probably best

Additional context
NA

[FEATURE REQUEST] Import cards from "My Words"

Kobo devices have an experimental option called "My Words" that you can enable by adding MyWords=true to the [FeatureSettings] section of /.kobo/Kobo/Kobo eReader.conf.

This feature lets you save words that you look up in the dictionary. It also enables a new section in the nickelmenu for viewing these words in a single list. You can easily scroll through each word and see it's definition and where it appears in your book collection. Unfortunately, the is no way to review these words like there is on Kindle.

I was wondering if it would be possible to add an option to Sanki to allow importing words from the "My Words" list. This way, you won't need to use a computer at all. You can simply read normally, save words as you go using "My Words", and then review the words that you've saved using Sanki.

Text coding in sanki-sync

[2024-02-12T19:12:35Z INFO  sanki_sync] Requested: "polski matura %C5%9Bw aleksy, Roland, Mistrz polikarp.apkg"
[2024-02-12T19:12:35Z ERROR sanki_sync] Requested a file that was not expected

but it worked on the device

ignore this a note for future me

[QUERY] Availability for the Open Book

New to building apps for E-readers, any chance that this app works out of the box for The Open book (https://github.com/joeycastillo/The-Open-Book)?

No touch input on Libra 2

This project looks pretty cool! I just tried to run the latest Nickel release on my Kobo Libra 2, and though the main window appears and looks normal, the app doesn't respond to touch inputs. The clock still updates, so I don't think it's a crash/hang.