Skip to content

jwillikers/koreader-break-timer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

KOReader Break Timer

A KOReader plugin for taking regular breaks.

Usage

This plugin is based on the built-in KOReader read timer plugin. It starts automatically, and allows the user to set a break interval and length. During the break, a message box overlays the screen. There is no way to dismiss the break until the break time has elapsed. I should add an option to allow dismissing the break timer or not. Follow the instructions here to install the plugin to an instance of KOReader on a Kobo reader.

  1. Clone this project’s repository.

    git clone https://github.com/jwillikers/koreader-break-timer.git
  2. Change into the project directory.

    cd koreader-break-timer
  3. Plug in the Kobo reader and mount its filesystem.

  4. Copy the plugin directory to the KOReader plugins directory.

    mkdir /run/media/$(id --name --user)/KOBOeReader/.adds/koreader/plugins/breaktimer.koplugin
    cp --recursive breaktimer.koplugin/* /run/media/$(id --name --user)/KOBOeReader/.adds/koreader/plugins/breaktimer.koplugin/
  5. Now unmount the Kobo reader’s filesystem.

  6. Reboot the Kobo reader.

    Any changes to the plugin seem to require a reboot to take effect.

Contributing

Contributions in the form of issues, feedback, and even pull requests are welcome. Make sure to adhere to the project’s Code of Conduct.

Code of Conduct

Refer to the project’s Code of Conduct for details.

License

This repository is licensed under the MIT license.

© 2025 Jordan Williams

Authors

About

A break timer for KOReader

Topics

Resources

License

Stars

Watchers

Forks

Languages