An open-source, Qt-based eBook reader for Kobos (and other devices).
Find a file
2022-07-15 23:58:05 -04:00
resources Local library: Bugfixes 2022-06-27 18:14:20 -04:00
.gitignore Update .gitignore 2022-07-15 20:38:52 -04:00
alert.cpp Improve logging; timezone fix 2022-04-15 20:27:58 -04:00
alert.h Miscellanous (and nonsensical) fixes 2022-04-05 01:37:04 -04:00
alert.ui UI fixes 2021-04-06 21:29:33 -04:00
apps.cpp GUI user applications: Design improvements 2022-06-24 09:35:50 -04:00
apps.h GUI user applications: More improvements 2022-06-19 00:14:42 -04:00
apps.ui GUI user applications: Design improvements 2022-06-24 09:35:50 -04:00
AUTHORS Update AUTHORS 2021-06-30 19:19:33 -04:00
bookinfodialog.cpp Implement local book info dialog 2022-07-12 12:34:36 -04:00
bookinfodialog.h Implement local book info dialog 2022-07-12 12:34:36 -04:00
bookinfodialog.ui Implement local book info dialog 2022-07-12 12:34:36 -04:00
bookoptionsdialog.cpp bookID fix in bookOptionsDialog 2022-07-15 23:58:05 -04:00
bookoptionsdialog.h bookID fix in bookOptionsDialog 2022-07-15 23:58:05 -04:00
bookoptionsdialog.ui localLibraryWidget: Implement book options dialog (WIP) 2022-07-06 14:24:23 -04:00
brightnessdialog.cpp Kindle Touch (KT) support 2022-05-22 15:38:02 -04:00
brightnessdialog.h Implement logger; design language fixes 2022-04-05 00:47:15 -04:00
brightnessdialog.ui Brightness dialog: set lighting warmth option 2021-07-16 16:41:36 -04:00
calendarapp.cpp Design improvements 2022-04-03 23:26:15 -04:00
calendarapp.h Implement logger; design language fixes 2022-04-05 00:47:15 -04:00
calendarapp.ui InkBox v1.0 Release Commit 2021-03-25 08:00:19 -04:00
def.h InkBox v1.0 Release Commit 2021-03-25 08:00:19 -04:00
dictionarywidget.cpp Improve logging; timezone fix 2022-04-15 20:27:58 -04:00
dictionarywidget.h Implement logger; design language fixes 2022-04-05 00:47:15 -04:00
dictionarywidget.ui Set definition QTextEdit to NoTextInteractionFlags 2021-07-06 20:12:10 -04:00
eink.qrc Local library: Bugfixes 2022-06-27 18:14:20 -04:00
encryptionmanager.cpp Improve testPing; support landscape PDFs 2022-04-16 19:40:30 -04:00
encryptionmanager.h Implement logger; design language fixes 2022-04-05 00:47:15 -04:00
encryptionmanager.ui Implement logger; design language fixes 2022-04-05 00:47:15 -04:00
functions.h Implement local book info dialog 2022-07-12 12:34:36 -04:00
generaldialog.cpp Various fixes; compress RecentBooks.db 2022-07-01 18:56:34 -04:00
generaldialog.h GUI user applications: improvements 2022-06-18 09:26:52 -04:00
generaldialog.ui Small bugfixes 2022-03-03 22:52:29 -05:00
homepagewidget.cpp localLibraryWidget: Implement book options dialog (WIP) 2022-07-06 14:24:23 -04:00
homepagewidget.h Implement 'Generating database' toast; various improvements 2022-06-30 09:52:48 -04:00
homepagewidget.ui Home page: Implement QToolTipLabel and book titles 2022-06-29 13:11:11 -04:00
hourglassanimationwidget.cpp Reduce waiting hourglass size 2021-11-09 08:52:57 -05:00
hourglassanimationwidget.h Implement logger; design language fixes 2022-04-05 00:47:15 -04:00
hourglassanimationwidget.ui Basic encryption setup working & hourglass animation 2021-10-09 11:07:10 -04:00
inkbox.pro localLibraryWidget: Implement book options dialog (WIP) 2022-07-06 14:24:23 -04:00
koboxappsdialog.cpp koboxAppsDialog: Small fix in logger 2022-06-07 17:03:28 -04:00
koboxappsdialog.h Implement logger; design language fixes 2022-04-05 00:47:15 -04:00
koboxappsdialog.ui KoBox Apps dialog can scan through the extensions list 2021-04-30 12:49:33 -04:00
koboxsettings.cpp KT: Make USBMS work 2022-05-23 15:24:21 -04:00
koboxsettings.h Implement logger; design language fixes 2022-04-05 00:47:15 -04:00
koboxsettings.ui Improve Univers/U001 font integration; generalDialog fixes 2022-03-03 22:03:20 -05:00
LEGAL.md Add legal information 2022-04-20 20:53:51 -04:00
librarywidget.cpp Local library: Bugfixes 2022-06-27 18:14:20 -04:00
librarywidget.h Implement logger; design language fixes 2022-04-05 00:47:15 -04:00
librarywidget.ui Local library: Bugfixes 2022-06-27 18:14:20 -04:00
LICENSE Initial commit 2021-03-25 07:48:20 -04:00
locallibrarywidget.cpp bookID fix in bookOptionsDialog 2022-07-15 23:58:05 -04:00
locallibrarywidget.h bookID fix in bookOptionsDialog 2022-07-15 23:58:05 -04:00
locallibrarywidget.ui Various fixes; compress RecentBooks.db 2022-07-01 18:56:34 -04:00
main.cpp GUI user applications: SupportedDevices is now an array 2022-06-20 18:12:20 -04:00
mainwindow.cpp Basic home screen + other improvements 2022-06-29 02:15:13 -04:00
mainwindow.h Basic home screen + other improvements 2022-06-29 02:15:13 -04:00
mainwindow.ui Home page: Implement QToolTipLabel and book titles 2022-06-29 13:11:11 -04:00
otamanager.cpp Local library: Bugfixes 2022-06-27 18:14:20 -04:00
otamanager.h Implement logger; design language fixes 2022-04-05 00:47:15 -04:00
otamanager.ui Entire otaManager tested and working! 2021-08-25 13:16:41 -04:00
qclickablelabel.cpp localLibraryWidget: Implement book options dialog (WIP) 2022-07-06 14:24:23 -04:00
qclickablelabel.h localLibraryWidget: Implement book options dialog (WIP) 2022-07-06 14:24:23 -04:00
qtooltiplabel.cpp Various fixes; compress RecentBooks.db 2022-07-01 18:56:34 -04:00
qtooltiplabel.h Home page: Implement QToolTipLabel and book titles 2022-06-29 13:11:11 -04:00
quit.cpp GUI user applications: improvements 2022-06-18 09:26:52 -04:00
quit.h Implement logger; design language fixes 2022-04-05 00:47:15 -04:00
quit.ui InkBox v1.0 Release Commit 2021-03-25 08:00:19 -04:00
reader.cpp Various fixes; compress RecentBooks.db 2022-07-01 18:56:34 -04:00
reader.h Basic home screen + other improvements 2022-06-29 02:15:13 -04:00
reader.ui Improve logging; add 'Univers (u001)' font in Reader 2022-04-10 21:37:33 -04:00
README.md README.md: Wording change 2022-05-03 22:45:00 -04:00
resources.qrc InkBox v1.0 Release Commit 2021-03-25 08:00:19 -04:00
savedwords.cpp Improve logging; various fixes 2022-04-16 23:20:24 -04:00
savedwords.h Implement logger; design language fixes 2022-04-05 00:47:15 -04:00
savedwords.ui InkBox v1.0 Release Commit 2021-03-25 08:00:19 -04:00
searchresultswidget.cpp Various fixes and improvements; add special characters to virtual keyboard 2022-04-02 14:30:07 -04:00
searchresultswidget.h Implement logger; design language fixes 2022-04-05 00:47:15 -04:00
searchresultswidget.ui Progress in implementing "Open" function from search 2021-09-04 23:46:47 -04:00
settings.cpp Implement local book info dialog 2022-07-12 12:34:36 -04:00
settings.h Improve logging in KoBox and InkBox settings 2022-04-17 22:25:29 -04:00
settings.ui Improve logging; timezone fix 2022-04-15 20:27:58 -04:00
settingschooser.cpp Kindle Touch (KT) support 2022-05-22 15:38:02 -04:00
settingschooser.h Implement logger; design language fixes 2022-04-05 00:47:15 -04:00
settingschooser.ui Finalized working tab switcher 2021-04-24 12:44:57 -04:00
textwidget.cpp Design improvements 2022-04-03 23:26:15 -04:00
textwidget.h Implement logger; design language fixes 2022-04-05 00:47:15 -04:00
textwidget.ui Correct layout 2021-06-20 17:32:25 -04:00
toast.cpp Fix Wi-Fi interface bug when no networks are found 2022-04-18 14:30:12 -04:00
toast.h Implement logger; design language fixes 2022-04-05 00:47:15 -04:00
toast.ui Toast messages; Wi-Fi dialog improvements 2021-07-14 01:24:30 -04:00
usbms_splash.cpp Local library: Bugfixes 2022-06-27 18:14:20 -04:00
usbms_splash.h KT: Make USBMS work 2022-05-23 15:24:21 -04:00
usbms_splash.ui InkBox v1.0 Release Commit 2021-03-25 08:00:19 -04:00
userapps.cpp localLibraryWidget: Implement book options dialog (WIP) 2022-07-06 14:24:23 -04:00
userapps.h Half-working setup 2022-06-17 23:59:21 -04:00
userapps.ui GUI user applications: More improvements 2022-06-19 00:14:42 -04:00
virtualkeyboard.cpp Miscellanous (and nonsensical) fixes 2022-04-05 01:37:04 -04:00
virtualkeyboard.h Implement logger; design language fixes 2022-04-05 00:47:15 -04:00
virtualkeyboard.ui Virtual keyboard! 2021-07-05 16:01:32 -04:00
virtualkeypad.cpp Improve Univers/U001 font integration; generalDialog fixes 2022-03-03 22:03:20 -05:00
virtualkeypad.h Implement logger; design language fixes 2022-04-05 00:47:15 -04:00
virtualkeypad.ui Implemented "Go to page" dialog and function. 2021-07-05 13:45:35 -04:00
wifidialog.cpp Fix Wi-Fi interface bug when no networks are found 2022-04-18 14:30:12 -04:00
wifidialog.h Implement logger; design language fixes 2022-04-05 00:47:15 -04:00
wifidialog.ui Wi-Fi dialog bugfixes 2022-03-03 23:21:17 -05:00

InkBox

About InkBox

InkBox is an open-source, Qt-based eBook reader for Kobo devices. It also comes as an entire native open-source OS and provides support for a number of devices.
InkBox features:

  • Full integrated KoBox X11 subsystem
  • ePUB, PDF, pictures and plain text display support
  • Versatile configuration options for reading
  • muPDF rendering engine for ePUBs and PDFs
  • Wi-Fi support and web browser (NetSurf)
  • Encrypted storage with EncFS
  • Fast dictionary & local storage search
  • Dark mode
  • Strict security policy ensuring that only signed software can be run on the device (this, however, can be adapted to your needs by recompiling the kernel)
  • Full factory reset option if needed
  • Seamless update process
  • VNC viewer app
  • Search function
  • 10 built-in fonts
  • Auto-suspend
  • Lock screen/passcode option
  • User-friendly experience

How do I install InkBox?

You can download precompiled OS/binaries here and standard Nickel add-ons (outdated, unmaintained) are available here, although support for them has been stopped until further notice. Huge thanks to @fermino for providing free hosting.

On Windows, use balenaEtcher to flash the InkBox image file to the Kobo's SD card.

On Linux and MacOS, balenaEtcher is the easiest option for command-line-reluctant users. Alternatively, you can also open a terminal and check the device node of the Kobo's SD card with fdisk -l. Then dd the image to the SD card like this:

xzcat inkbox.xz | dd of=/dev/mmcblk0

IMPORTANT: InkBox OS does NOT provide ANY WARRANTY at all and we are not responsible if you brick your device with one of the factory images or update bundles available online. See legal information for more details.

How do I upgrade InkBox?

To upgrade InkBox, go to http://23.163.0.39/bundles/inkbox/native/update/ and copy the files for your device onto the .inkbox folder in the USB storage partition.

Note: Prior to version 1.6, InkBox had to be upgraded one version at a time. If your device's factory image ships with version 1.5, you need to closely follow the upgrade instructions here.

If you install the Nickel add-on, unpack the 'base' archive in the root of the onboard storage, not in any subfolder inside it.

I want to learn more about this!

I suggest you visit the wiki. The General information page is a pretty good place to start. Feel free to contribute if you think you have something valuable to add.

How can I contribute?

If you like this project and want to improve it in some way, feel free to fork this repository or one of the subprojects this organization hosts, then make a pull request. I'll be happy to review it when I have time. You can also join the official Discord server if you'd like to chat a bit.

On the other hand, if you don't have the appropriate coding skills or just want to help in some way, feel free to make a donation at my PayPal account or on LiberaPay. I'm a student and motivation has been the only thing that has helped me maintain this project for the last months. Developing an entire operating system on my own was not an easy task. I have time, but I like to spend it wisely.