zen-os

<div align="center">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="./icons/zen_ui_light.svg" />
    <img width="300" src="./icons/zen_ui.svg" alt="ZenOS logo" />
  </picture>

  <h1>ZenOS</h1>
  <p>A clean, minimal reading experience.</p>
  <p>
    <a href="https://zen-labs.org/zen-os">Website</a> ·
    <a href="https://github.com/xZenLabs/zen-os/releases">Releases</a> ·
    <a href="docs/installation.md">Installation guide</a> ·
    <a href="https://discord.zen-labs.org">Discord</a>
  </p>
</div>

ZenOS is a clean, minimal interface for KOReader. You get a Home page, a redesigned Library, a Controls panel, a Launcher, better reader tools, and one place for all your settings. KOReader is still there underneath.

## Philosophy

**Less is more.** Every feature either removes clutter or adds real value. Performance, stability, and ease of use come first, and everything is tuned to be easy on your battery.

## Features

### Home

Your own start page. Mix date and time, a featured book, reading stats, goals, a book strip, and quotes. Edit widgets right from Home, or save layouts as presets.

**Zen Settings > Home** · [Home guide](docs/home.md)

### Controls

Swipe down from anywhere for up to nine buttons plus brightness and warmth sliders. Toggle Wi-Fi, Bluetooth, rotation, and modes, or add buttons that run any action, plugin, or KOReader menu.

**Zen Settings > Interface > Controls** · [Controls guide](docs/controls.md)

<img src="./images/quickstart/onboarding/quicksettings.png" width="500" alt="Quick Settings">

### Library

Mosaic, list, or detailed list, set per folder. Badges, progress, rounded covers, folder covers, and automatic series folders. Hold a book to change its status, edit metadata, or pull details and covers from Hardcover, Google Books, or Open Library.

**Zen Settings > Library** · [Library guide](docs/library.md)

<img src="./images/quickstart/onboarding/library_covers_full.png" width="350" height="auto" alt="Library Covers">

<img src="./images/quickstart/onboarding/library_list_full.png" width="350" height="auto" alt="Library List">

<img src="./images/quickstart/onboarding/context_menu.png" width="350" height="auto" alt="Context Menu">

### Navbar

Up to seven tabs at the bottom of the Library: folders, favorites, authors, series, tags, stats, book statuses, or your own actions.

**Zen Settings > Interface > Navbar** · [Navbar guide](docs/navbar.md)

<img src="./images/quickstart/onboarding/navbar.png" width="500" alt="Navigation Bar">

### Launcher

A top-menu tab with your current book, a book switcher, and pages of shortcut buttons you can sort into folders.

**Zen Settings > Interface > Launcher** · [Launcher guide](docs/launcher.md)

### Reader

Swipe up for the page browser: page previews, search, TOC, bookmarks, and font settings in one view. Pin pages, use themes for light and dark mode, and set up top and bottom status bars however you like. The lookup and highlight menus show Wikipedia, X-Ray