{"id":47282283,"url":"https://github.com/doctorhetfield-cmd/simpleui.koplugin","last_synced_at":"2026-05-02T13:03:53.908Z","repository":{"id":344181216,"uuid":"1180804216","full_name":"doctorhetfield-cmd/simpleui.koplugin","owner":"doctorhetfield-cmd","description":"A highly customizable UI plugin for KOReader that features a home screen, bottom navigation bar, top bar and desktop modules/widgets. ","archived":false,"fork":false,"pushed_at":"2026-04-24T10:42:18.000Z","size":1308,"stargazers_count":651,"open_issues_count":49,"forks_count":62,"subscribers_count":7,"default_branch":"main","last_synced_at":"2026-04-24T11:36:04.039Z","etag":null,"topics":["ebook","kindle","kobo","koreader","lua","plugin","reader"],"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/doctorhetfield-cmd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"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},"funding":{"ko_fi":"doctorhetfield"}},"created_at":"2026-03-13T12:34:19.000Z","updated_at":"2026-04-24T10:42:22.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/doctorhetfield-cmd/simpleui.koplugin","commit_stats":null,"previous_names":["doctorhetfield-cmd/simpleui.koplugin"],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/doctorhetfield-cmd/simpleui.koplugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doctorhetfield-cmd%2Fsimpleui.koplugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doctorhetfield-cmd%2Fsimpleui.koplugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doctorhetfield-cmd%2Fsimpleui.koplugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doctorhetfield-cmd%2Fsimpleui.koplugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/doctorhetfield-cmd","download_url":"https://codeload.github.com/doctorhetfield-cmd/simpleui.koplugin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doctorhetfield-cmd%2Fsimpleui.koplugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32534975,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-02T12:25:33.646Z","status":"ssl_error","status_checked_at":"2026-05-02T12:24:51.733Z","response_time":132,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["ebook","kindle","kobo","koreader","lua","plugin","reader"],"created_at":"2026-03-16T02:02:26.471Z","updated_at":"2026-05-02T13:03:53.902Z","avatar_url":"https://github.com/doctorhetfield-cmd.png","language":"Lua","funding_links":["https://ko-fi.com/doctorhetfield"],"categories":[],"sub_categories":[],"readme":"# SimpleUI for KOReader\n\nA clean, distraction-free UI plugin for KOReader that transforms your reading experience. SimpleUI adds a **dedicated Home Screen**, a customisable bottom navigation bar, a top status bar, and a reworked library title bar, giving you instant access to your library, history, collections, and reading stats without navigating through nested menus.\n\n\u003cdiv style=\"display: flex; flex-direction: row; flex-wrap: wrap; gap: 10px; max-width: 1000px; justify-content: center;\"\u003e\n\u003cimg src=\"https://github.com/user-attachments/assets/4ea92760-c2bf-488b-9f5a-1f663157c97f\" width=\"240\" height=\"324\" alt=\"simpleUI1\" style=\"object-fit: contain;\" /\u003e\n\u003cimg src=\"https://github.com/user-attachments/assets/a1a7a2c7-6c0f-484e-b6fa-c78474661480\" width=\"240\" height=\"324\" alt=\"simpleUI2\" style=\"object-fit: contain;\" /\u003e\n\u003cimg src=\"https://github.com/user-attachments/assets/1707f5c2-e367-47b8-90a9-9a9549bd9e67\" width=\"240\" height=\"324\" alt=\"simpleUI3\" style=\"object-fit: contain;\" /\u003e\n\u003cimg src=\"https://github.com/user-attachments/assets/fd443a96-e12c-4dc7-9e69-103c444458af\" width=\"240\" height=\"324\" alt=\"simpleUI4\" style=\"object-fit: contain;\" /\u003e\n\u003c/div\u003e\n---\n\n## Features\n\n### Home Screen\n\nThe centrepiece of SimpleUI. A home screen that gives you everything at a glance:\n\n- **Clock \u0026 Date** — a large, readable clock with full date display\n- **Currently Reading** — your active book with cover art, title, author, progress bar, percentage read, and estimated time left\n- **Recent Books** — a row of up to 5 recent books with cover thumbnails and progress indicators; tap any to resume reading\n- **Collections** — your KOReader collections displayed as tappable cover cards, right on the home screen\n- **Reading Goals** — visual progress tracker for your annual and daily reading goals, including physical books read\n- **Reading Stats** — compact stat cards showing today's reading time, pages, streaks, and all-time totals\n- **Quick Actions** — up to 3 customisable rows of shortcut buttons (Library, History, Wi-Fi toggle, Brightness, Stats, and more)\n- **New Books** — a row of up to 5 recently added books sorted by file date; unread books are labelled \"New\" and started books show their read percentage; opt-in via Arrange Modules\n- **Quote of the Day** — optional literary header, randomly picked from a curated list of 100+ quotes; can also show your own highlights\n- **Module ordering** — rearrange Home Screen modules in any order to match your workflow\n- **Per-module scaling** — resize each module independently, or lock all scales together for uniform adjustments\n- **Start with Home Screen** — set the Home Screen as the first screen KOReader opens every time you pick up your device\n\n### Bottom Navigation Bar\n\nA persistent tab bar at the bottom of the screen for one-tap navigation:\n\n- Up to **5 fully customisable tabs**: Library, History, Collections, Favourites, Continue Reading, Home Screen, Wi-Fi Toggle, Brightness, Stats, Bookmark Browser, and custom folder or collection shortcuts\n- **3 display modes**: icons only, text only, or icons + text\n- **Navpager mode** — replaces the pagination bar with Prev/Next arrows at the edges of the bottom bar; arrows dim when there is no previous or next page\n- **Hold anywhere on the bar** to instantly open navigation settings\n\n### Top Status Bar\n\nA slim status bar always visible at the top of the screen:\n\n- Displays **clock, battery level, Wi-Fi status, frontlight brightness, disk usage, and RAM** all configurable\n- Each item can be placed on the **left or right** side independently\n\n### Custom Title Bar\n\nA reworked title bar for the Library, History, Collections, and other full-screen views:\n\n- **Back button** — replaces KOReader's default navigation with a cleaner chevron; hides automatically at the root folder, and also hides when the Library's *Lock Home Folder* setting is active and you are already at the home folder\n- **Search button** — quick access to file search, compacts into the freed slot when the back button is hidden\n- **Menu button** — opens the KOReader main menu\n- **Page number in title** — shows \"Page X of Y\" in the subtitle when browsing multi-page views (enabled automatically by Navpager)\n- **Button size** — three sizes (Compact, Default, Large) for the title bar buttons\n- **Separate layouts** — Library buttons and sub-page buttons (History, Collections, etc.) can be configured independently\n\n### Folder Covers\n\nCustom cover art for folders in the Library mosaic view:\n\n- Automatically uses the **first book cover** found inside a folder\n- Supports a **`.cover.*` image file** placed manually in the folder for full control\n- **Long-press any folder** and tap *Set folder cover…* to pick a specific book's cover as the folder's cover, only visible when Folder Covers is enabled\n- Optional **folder name label** with configurable position (top, centre, bottom) and style (solid or transparent background)\n- Optional **item count badge** with configurable position\n- **Hide selection underline** for a cleaner look\n\n### Quick Actions\n\nShortcut buttons configurable both on the Home Screen and in the bottom bar:\n\n- Assign any action to a **custom folder**, **collection**, or **KOReader plugin**\n- Quick **Wi-Fi toggle** and **frontlight control**\n- **Power menu** (Restart, Quit) accessible as a tab\n- **Bookmark Browser** — browse your highlights and bookmarks across all books\n\n### Settings\n\nAll features are accessible via **Menu → Tools → SimpleUI**\n\n---\n\n## Installation\n\n1. Download this repository as a ZIP — click **Code → Download ZIP**\n2. Extract the folder and confirm it is named `simpleui.koplugin`\n3. Copy the folder to the `plugins/` directory on your KOReader device\n4. Restart KOReader\n5. Go to **Menu → Tools → SimpleUI** to enable and configure the plugin\n\n\u003e **Tip:** After enabling the plugin, tap the **Home Screen** tab in the bottom bar to open your new home screen.\n\n\u003e **Tip:** To make the Home Screen your default start screen, go to **Menu → Tools → SimpleUI → Home Screen → Start with Home Screen**. From then on, KOReader opens directly to your home screen every time you turn on your device.\n\n---\n\n## 🌍 Translations\n\nSimpleUI has full translation support. The UI language is detected automatically from your KOReader language setting — no configuration needed.\n\n### Included languages\n\n| Language | File | Status |\n|---|---|---|\n| English | *(built-in)* | Complete |\n| Português (Brasil) | `locale/pt_BR.po` | Complete |\n| Português (Portugal) | `locale/pt_PT.po` | Complete |\n| Français (French) | `locale/fr.po` | Partial (99.3% — 3 missing) |\n| Bulgară (Bulgarian) | `locale/bg.po` | Partial (88.6% — 46 missing) |\n| Čeština (Czech) | `locale/cs.po` | Partial (88.3% — 47 missing) |\n| Türkçe (Turkish) | `locale/tr.po` | Partial (88.3% — 47 missing) |\n| Українська (Ukrainian) | `locale/uk.po` | Partial (88.3% — 47 missing) |\n| Tiếng Việt (Vietnamese) | `locale/vi.po` | Partial (88.3% — 47 missing) |\n| 简体中文 (Chinese Simplified) | `locale/zh_CN.po` | Partial (88.3% — 47 missing) |\n| Polski (Polish) | `locale/pl.po` | Partial (87.8% — 49 missing) |\n| Română (Romanian) | `locale/ro.po` | Partial (83.9% — 65 missing) |\n| Română (Moldova) | `locale/ro_MD.po` | Partial (83.9% — 65 missing) |\n| 繁體中文 (Chinese Traditional) | `locale/zh_TW.po` | Partial (83.9% — 65 missing) |\n| Русский (Russian) | `locale/ru.po` | Partial (80.4% — 79 missing) |\n| Español | `locale/es.po` | Partial (78.4% — 87 missing) |\n| Italiano (Italian) | `locale/it_IT.po` | Partial (78.2% — 88 missing) |\n| Svenska (Swedish) | `locale/sv.po` | Partial (77.2% — 92 missing) |\n| Deutsch (German) | `locale/de.po` | Partial (69.2% — 124 missing) |\n\n### Adding a new language\n\nAll 403 strings in the plugin are translatable. To add a new language:\n\n1. Copy `locale/simpleui.pot` to `locale/\u003clang\u003e.po`, using the standard locale code for your language (examples: `de`, `fr`, `it`, `ja`)\n2. Open the file in any text editor or a dedicated PO editor such as [Poedit](https://poedit.net/)\n3. For each entry, fill in the `msgstr` field with your translation:\n\n```po\nmsgid \"Currently Reading\"\nmsgstr \"Aktuell gelesen\"\n```\n\n4. Save the file inside the `locale/` folder — no code changes needed\n5. Restart KOReader; the plugin picks up the new language automatically\n\nThe plugin first tries an exact match for the locale code (e.g. `pt_PT.po`), then falls back to the language prefix (e.g. `pt.po`), then falls back to English.\n\n### Notes for translators\n\n- Placeholders like `%d`, `%s`, and `%%` must be kept in your translation exactly as they appear in the `msgid` — you can reorder them if your language requires it, but not remove them\n- `\\n` is a line break — keep it in the same position\n- Never modify the `msgid` line — only edit `msgstr`\n- If a `msgstr` is left empty (`\"\"`), the English original is shown as a fallback\n- Submitting your translation as a Pull Request is very welcome — see [CONTRIBUTING.md](CONTRIBUTING.md)\n\n---\n\n## 🔧 Customising Quotes\n\nTo add, remove or edit the Quote of the Day pool, open `desktop_modules/quotes.lua` inside the plugin folder. Each entry follows this format:\n\n```lua\n{ q = \"Quote text.\", a = \"Author Name\", b = \"Book Title (optional)\" }\n```\n\nChanges take effect the next time the Home Screen is opened.\n\n---\n\n## Contributing\n\nContributions are welcome — bug fixes, new features, translations, and documentation improvements. See [CONTRIBUTING.md](CONTRIBUTING.md) for how to get started.\n\nTo report a bug, open an **Issue** and include your KOReader version and device model.\n\n---\n\n## 📄 License\n\nMIT — see [LICENSE](LICENSE) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoctorhetfield-cmd%2Fsimpleui.koplugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdoctorhetfield-cmd%2Fsimpleui.koplugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoctorhetfield-cmd%2Fsimpleui.koplugin/lists"}