{"id":25864148,"url":"https://github.com/jwillikers/koreader-break-timer","last_synced_at":"2026-06-08T12:32:43.588Z","repository":{"id":279079392,"uuid":"936251014","full_name":"jwillikers/koreader-break-timer","owner":"jwillikers","description":"A break timer for KOReader","archived":false,"fork":false,"pushed_at":"2025-07-12T12:39:13.000Z","size":39,"stargazers_count":2,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-11-29T09:10:33.190Z","etag":null,"topics":["eyestrain","koreader","koreader-plugin"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jwillikers.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.adoc","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-02-20T19:16:50.000Z","updated_at":"2025-07-12T12:39:17.000Z","dependencies_parsed_at":"2025-02-23T16:57:26.569Z","dependency_job_id":"31307fa5-515e-4832-84c2-daa3d9d1995e","html_url":"https://github.com/jwillikers/koreader-break-timer","commit_stats":null,"previous_names":["jwillikers/koreader-break-timer"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jwillikers/koreader-break-timer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwillikers%2Fkoreader-break-timer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwillikers%2Fkoreader-break-timer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwillikers%2Fkoreader-break-timer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwillikers%2Fkoreader-break-timer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jwillikers","download_url":"https://codeload.github.com/jwillikers/koreader-break-timer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwillikers%2Fkoreader-break-timer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34063150,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-08T02:00:07.615Z","response_time":111,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["eyestrain","koreader","koreader-plugin"],"created_at":"2025-03-02T00:36:42.924Z","updated_at":"2026-06-08T12:32:43.569Z","avatar_url":"https://github.com/jwillikers.png","language":"Lua","funding_links":[],"categories":[],"sub_categories":[],"readme":"= KOReader Break Timer\nJordan Williams \u003cjordan@jwillikers.com\u003e\n:experimental:\n:icons: font\nifdef::env-github[]\n:tip-caption: :bulb:\n:note-caption: :information_source:\n:important-caption: :heavy_exclamation_mark:\n:caution-caption: :fire:\n:warning-caption: :warning:\nendif::[]\n:Asciidoctor_: https://asciidoctor.org/[Asciidoctor]\n:just: https://github.com/casey/just[just]\n:KOReader: https://github.com/koreader/koreader[KOReader]\n:KOReader-read-timer-plugin: https://github.com/koreader/koreader/tree/master/plugins/readtimer.koplugin[KOReader read timer plugin]\n:Linux: https://www.linuxfoundation.org/[Linux]\n:Nix: https://nixos.org/[Nix]\n:nix-direnv: https://github.com/nix-community/nix-direnv[nix-direnv]\n:Nushell: https://www.nushell.sh/[Nushell]\n\nA {KOReader} plugin for taking regular breaks.\n\n== Usage\n\nThis plugin is based on the built-in {KOReader-read-timer-plugin}.\nIt starts automatically, and allows the user to set a break interval and length.\nDuring the break, a message box overlays the screen.\nThere is no way to dismiss the break until the break time has elapsed.\nI should add an option to allow dismissing the break timer or not.\nFollow the instructions here to install the plugin to an instance of KOReader on a Kobo reader.\n\n. Clone this project's repository.\n+\n[,sh]\n----\ngit clone https://github.com/jwillikers/koreader-break-timer.git\n----\n\n. Change into the project directory.\n+\n[,sh]\n----\ncd koreader-break-timer\n----\n\n. Plug in the Kobo reader and mount its filesystem.\n\n. Copy the plugin directory to the KOReader plugins directory.\n+\n[,sh]\n----\nmkdir /run/media/$(id --name --user)/KOBOeReader/.adds/koreader/plugins/breaktimer.koplugin\ncp --recursive breaktimer.koplugin/* /run/media/$(id --name --user)/KOBOeReader/.adds/koreader/plugins/breaktimer.koplugin/\n----\n\n. Now unmount the Kobo reader's filesystem.\n. Reboot the Kobo reader.\n+\n[IMPORTANT]\n====\nAny changes to the plugin seem to require a reboot to take effect.\n====\n\n== Contributing\n\nContributions in the form of issues, feedback, and even pull requests are welcome.\nMake sure to adhere to the project's link:CODE_OF_CONDUCT.adoc[Code of Conduct].\n\n== Code of Conduct\n\nRefer to the project's link:CODE_OF_CONDUCT.adoc[Code of Conduct] for details.\n\n== License\n\nThis repository is licensed under the link:LICENSE[MIT license].\n\n© 2025 Jordan Williams\n\n== Authors\n\nmailto:{email}[{author}]\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjwillikers%2Fkoreader-break-timer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjwillikers%2Fkoreader-break-timer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjwillikers%2Fkoreader-break-timer/lists"}