https://github.com/jwillikers/koreader-break-timer
A break timer for KOReader
https://github.com/jwillikers/koreader-break-timer
eyestrain koreader koreader-plugin
Last synced: 27 days ago
JSON representation
A break timer for KOReader
- Host: GitHub
- URL: https://github.com/jwillikers/koreader-break-timer
- Owner: jwillikers
- License: mit
- Created: 2025-02-20T19:16:50.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-02-20T19:40:45.000Z (10 months ago)
- Last Synced: 2025-02-23T16:57:25.177Z (10 months ago)
- Topics: eyestrain, koreader, koreader-plugin
- Language: Lua
- Homepage:
- Size: 6.84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.adoc
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.adoc
Awesome Lists containing this project
README
= KOReader Break Timer
Jordan Williams
:experimental:
:icons: font
ifdef::env-github[]
:tip-caption: :bulb:
:note-caption: :information_source:
:important-caption: :heavy_exclamation_mark:
:caution-caption: :fire:
:warning-caption: :warning:
endif::[]
:Asciidoctor_: https://asciidoctor.org/[Asciidoctor]
:just: https://github.com/casey/just[just]
:KOReader: https://github.com/koreader/koreader[KOReader]
:KOReader-read-timer-plugin: https://github.com/koreader/koreader/tree/master/plugins/readtimer.koplugin[KOReader read timer plugin]
:Linux: https://www.linuxfoundation.org/[Linux]
:Nix: https://nixos.org/[Nix]
:nix-direnv: https://github.com/nix-community/nix-direnv[nix-direnv]
:Nushell: https://www.nushell.sh/[Nushell]
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.
. Clone this project's repository.
+
[,sh]
----
git clone https://github.com/jwillikers/koreader-break-timer.git
----
. Change into the project directory.
+
[,sh]
----
cd koreader-break-timer
----
. Plug in the Kobo reader and mount its filesystem.
. Copy the plugin directory to the KOReader plugins directory.
+
[,sh]
----
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/
----
. Now unmount the Kobo reader's filesystem.
. Reboot the Kobo reader.
+
[IMPORTANT]
====
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 link:CODE_OF_CONDUCT.adoc[Code of Conduct].
== Code of Conduct
Refer to the project's link:CODE_OF_CONDUCT.adoc[Code of Conduct] for details.
== License
This repository is licensed under the link:LICENSE[MIT license].
© 2025 Jordan Williams
== Authors
mailto:{email}[{author}]