9b2201a438
* Added a new plugin external-keyboard. It listens to USB events. When keyboard is plugged in or plugged out, it updates device and input configuration accordingly. * Added new fake events UsbDevicePlugIn and UsbDevicePlugOut that are emitted when a device is connected to a book reader that plays the role of USB host. The usage of the existing events UsbPlugIn and UsbPlugOut has not changed - they are used when a reader is connected to a host. The koreader-base has a related PR for those events. * Did a small refactoring of initialization for the modules FocusManager and InputText. They check device keyboard capabilities on their when the module is first loaded and store it. Some of the initialization code has been extracted into functions, so that we can re-initialize them when keyboard is (dis)connected. * Initial implementation centered around text input, and tested with USB keyboards on devices with OTG support. * Said OTG shenanigans are so far supported on devices with debugfs & the chipidea driver, or sunxi devices. |
2 years ago | |
|---|---|---|
| .ci | 2 years ago | |
| .circleci | 2 years ago | |
| .github | 2 years ago | |
| base@21f4b974c7 | 2 years ago | |
| doc | 2 years ago | |
| frontend | 2 years ago | |
| l10n@734e27b3f4 | 2 years ago | |
| metadata | 2 years ago | |
| platform | 2 years ago | |
| plugins | 2 years ago | |
| resources | 2 years ago | |
| spec/unit | 2 years ago | |
| test@86eeb0b43d | 8 years ago | |
| tools | 2 years ago | |
| .busted | 9 years ago | |
| .codecov.yml | 5 years ago | |
| .editorconfig | 8 years ago | |
| .gitignore | 4 years ago | |
| .gitmodules | 3 years ago | |
| .luacheckrc | 2 years ago | |
| .luacov | 7 years ago | |
| .shellcheckrc | 4 years ago | |
| .travis.yml | 7 years ago | |
| COPYING | 10 years ago | |
| Makefile | 2 years ago | |
| README.md | 3 years ago | |
| datastorage.lua | 2 years ago | |
| defaults.lua | 2 years ago | |
| kodev | 2 years ago | |
| reader.lua | 2 years ago | |
| setupkoenv.lua | 2 years ago | |
README.md
KOReader is a document viewer primarily aimed at e-ink readers.
Download • User guide • Wiki • Developer docs
Main features
-
portable: runs on embedded devices (Cervantes, Kindle, Kobo, PocketBook, reMarkable), Android and Linux computers. Developers can run a KOReader emulator in Linux and MacOS.
-
multi-format documents: supports fixed page formats (PDF, DjVu, CBT, CBZ) and reflowable e-book formats (EPUB, FB2, Mobi, DOC, CHM, TXT). Scanned PDF/DjVu documents can also be reflowed with the built-in K2pdfopt library.
-
full-featured reading: multi-lingual user interface with a highly customizable reader view and many typesetting options. You can set arbitrary page margins, override line spacing and choose external fonts and styles. It has multi-lingual hyphenation dictionaries bundled into the application.
-
integrated with calibre (search metadata, receive ebooks wirelessly, browse library via OPDS), Wallabag, Wikipedia, Google Translate and other content providers.
-
optimized for e-ink devices: custom UI without animation, with paginated menus, adjustable text contrast, and easy zoom to fit content or page in paged media.
-
extensible: via plugins
-
fast: on some older devices, it has been measured to have less than half the page-turn delay as the built in reading software.
-
and much more: look up words with StarDict dictionaries / Wikipedia, add your own online OPDS catalogs and RSS feeds, over-the-air software updates, an FTP client, an SSH server, …
Please check the user guide and the wiki to discover more features and to help us document them.
Screenshots
Installation
Please follow the model specific steps for your device:
Android • Cervantes • Kindle • Kobo • Linux • Pocketbook • reMarkable
Development
Setting up a build environment • Collaborating with Git • Building targets • Porting • Developer docs
Support
KOReader is developed and supported by volunteers all around the world. There are many ways you can help:
- fix bugs and implement new features
- translate the program into your language or improve an existing translation
- document lesser-known features on the wiki
- help others with your knowledge on the forum
Right now we only support liberapay donations, but you can also create a bounty to motivate others to work on a specific bug or feature request.
Contributors
