[!NOTE] If this project has been useful to you, I ask that you please star the repository, that way I know that the software is being used. Also, please consider sponsoring to support my open source projects, as this is something I work on in my free time. Thank you! ⭐️
KoboPatch Web UI
A web application for customising Kobo e-readers available here.
About this project
What's this about? Well, I have two resources that explain why the project was built:
-
YouTube: I have recorded a YouTube video that includes an explanation and demonstration. Also includes a demo of my custom fonts.
-
Blog: I have also written a lengthy blog post on the subject. This blog post contains more technical details than the video.
The project itself currently has a few operational modes, depending on what it is that you're trying to do. They're documented below.
Mode A: NickelMenu
This mode installs NickelMenu and, optionally, a whole selection of standalone mods and a curated configuration alongside it.
You pick and choose what to apply. On offer: home screen tweaks (via NickelHome), a preconfigured NickelMenu, some extra fonts, screensavers, NickelClock (which displays the clock while you're reading), NickelTypeFix (which repairs typesetting issues like justification and vertical text rendering), and alternative reading apps like KOReader or Cadmus if you'd like. Each is its own mod, so you only get what you select.
Works with most Kobo devices regardless of software version. If you don't like it and change your mind, you can also remove the modification using the same method.
- This is easily the safest mod to install. These modifications tend to persist with system updates as long as NickelMenu remains functional.
- Every extra mod is optional: NickelHome, NickelTypeFix, NickelClock, KOReader, and Cadmus all install through this same method.
- Recommended for everyone. Easy to uninstall, too.
Mode B: Custom Patches
This mode applies community kobopatch patches to your Kobo's system software.
You can combine this with option A, if you'd like, but this is a more involved process. This requires a supported software version and device model, which is currently limited to more recent devices.
- This is a more experimental mod: you need to choose what tweaks to apply.
- Changes made by these patches are usually reset when system updates are released. That means you must re-patch whenever your device is updated.
- Gives you a lot of customization options, but not all of them may work correctly, and not all devices are supported.
- Recommended for advanced users and those interested in more technical tweaks. For tinkerers.
Hosted version
Want to patch your device? You don't need to set this project up yourself. I'm hosting the project here: kp.nicoverbruggen.be.
Please read the instructions carefully. I've done my best to make this as user-friendly and safe as possible, but there's always a small risk when applying custom mods to your devices.
Here's the obligatory legal disclaimer:
[!NOTE] This project is not affiliated with Rakuten Kobo Inc. Patching modifies system files on your Kobo and will void your warranty. If something goes wrong, you may need to manually reset your device.
How it works
The app uses the Filesystem Access API (Chromium) to interface with connected Kobo devices, or falls back to manual model/software version selection with a downloadable ZIP on other browsers.
If you choose to apply custom patches, patching happens fully client-side — no backend needed, can be hosted as a static site. Patches are community-contributed via the MobileRead forums and need to be manually updated when new Kobo software versions come out.
Device support
If you want to install NickelMenu:
- Any Kobo released in 2025 or earlier, running software version >=4.23 and <5.0.
If you want to apply custom patches:
- Software 4.46.x: Kobo Libra Colour, Kobo Clara Colour, Kobo Clara BW
- Software 4.45.x: Kobo Libra Colour, Kobo Clara Colour, Kobo Clara BW
- Software 4.38.x: Kobo Clara 2E, Kobo Libra 2, Kobo Elipsa 2E, Kobo Sage, Kobo Elipsa
[!WARNING] Kobo software newer than 4.x is not supported yet. This includes the 5.x accessibility preview and the recently released 6.0 update. This applies to both NickelMenu and custom patches.
User flow
- Connect or download: auto-detect your Kobo via File System Access API on Chromium, or choose manual download mode (any browser)
- Choose mode: NickelMenu (install/configure/remove) or custom patches
- Configure: for NickelMenu: select what mods to install (fonts, screensaver, tab/homescreen tweaks, reading apps) or remove; for patches: enable/disable patches (or select none to restore original software)
- Backup: create or manually confirm a backup before changing NickelMenu files
- Review: confirm your selections before proceeding
- Install or remove: write directly to the device (Chromium auto mode) or download a ZIP/tgz for manual installation
Technical information
Note: This project was built with some assistance of agentic coding tools, some local and some hosted. This was carefully done, and key components have been thoroughly scrutinized.
The author strongly believes in carefully reviewing, scrutinizing and testing anything that is generated by any large language model ("AI"). There's a large suite of tests and a lot of manual testing that has gone into this project. Because the output of what needs to be written to a given device is pretty deterministic, this project is relatively easy to test.
The resulting project has been thoroughly tested by the author on various Kobo devices, including: Kobo Libra 2, Kobo Clara BW, Kobo Clara Colour, Kobo Libra Colour, Kobo Elipsa (1st generation), Kobo Aura ONE.
A comprehensive test suite (unit tests and end-to-end tests) is also included to verify everything works as expected and no regressions occur.
More relevant notes on architecture, file structure, build internals, and detailed testing notes live in PROJECT.md. Instructions for agentic coding tools live in AGENTS.md, and should be read before work on features starts.
Credits
This project stands on the work of many others. It bundles, builds on, or installs the projects listed below — each remains the property of its respective authors and is used under its own license, and my sincere thanks go to everyone who maintains them.
Some of these are bundled with the app (see installables.lock) rather than downloaded at runtime, to avoid CORS issues when fetching release assets from GitHub.
Patching & menu
- kobopatch — the patching engine, compiled to WebAssembly to patch firmware in the browser. (MIT)
- NickelMenu — the custom menu framework. (MIT)
Optional add-ons
- NickelClock — a clock on the reading screen. (MIT)
- KOReader — a feature-rich document and e-book reader. (AGPL-3.0)
- Cadmus — a reading companion app for Kobo, based on Plato. (AGPL-3.0)
Libraries & tooling
- JSZip — client-side ZIP reading and writing. (MIT or GPL-3.0)
- js-yaml — parsing kobopatch patch files. (MIT)
- Vite — JavaScript bundling and local development. (MIT)
- Go — compiles kobopatch to the WebAssembly module used by this tool. (BSD-3-Clause)
- ESLint (MIT) and Playwright (Apache-2.0) — linting and end-to-end testing.
By the author
Mods and fonts I maintain myself, installed or bundled by this tool:
- NickelHome — hides Kobo home-screen widgets (recommendations, suggestions, notices); installed when you enable a home-screen hider. (MIT)
- The curated configuration — the optional preset this tool can install NickelMenu from. (MIT)
- NickelTypeFix — fixes typesetting issues (justification, vertical text rendering, gridsetting) for all fonts; installed as part of "Better typography and fixes". (MIT)
- NickelCoverFix — keeps book covers from blanking to the title/author placeholder, and supports custom covers. (MIT)
- NickelDissolve — adds a Kindle-style directional page-turn animation (experimental). (MIT)
- The curated fonts — Readerly (OFL-1.1), Libron (OFL-1.1), and Cartisse (Bitstream Charter license) — part of the ebook-fonts collection (website), repackaged for Kobo.
Patches and discussion come from the MobileRead forums community.
License
MIT.