quickmenu.koplugin

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

quickmenu.koplugin

★ 17 Open GitHub ↗

Quick Menu for settings and actions.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# quickmenu.koplugin

`quickmenu.koplugin` is a highly customizable menu plugin designed to enhance navigation and accessibility on your e-reader. By providing a centralized hub for frequently used actions, light settings, and shortcuts, it streamlines the reading experience, allowing for quick adjustments without navigating deep into system menus.

## Core Sections

* **Exit:** A dedicated exit tab provides a unified way to manage your session. 
 - **In Filemanager:** Tap to close the menu, or hold to quit KOReader.
 - **In Reader:** Tap to close the menu, or hold to quit the reader and return to the Filemanager.
 

 <img src="assets/exit1.png" width="80%" alt="Exit button" />

 
* **Actions:** This section provides quick-access toggles for essential device functions, such as Wi-Fi, orientation lock, power, and USB connection. It allows you to toggle system states instantly with a single tap.

* **Frontlight:** Easily manage your visual comfort with dedicated controls for both intensity and warmth. This section offers granular adjustments to ensure your screen brightness and color temperature are perfectly suited to your environment.

* **Shortcuts:** A customizable grid of buttons providing direct access to key features like your Library, Collections, Search, Dictionary, and Cloud services, helping you jump to your preferred areas with ease.

* **Reading:** Designed for in-reading utility, this section provides quick tools to manage your current book or document session, ensuring common reading-related tasks are always one tap away.

* **Footer:** The status bar at the bottom acts as a summary panel, displaying real-time system information including CPU usage, storage availability, current time, and battery level, keeping you informed at a glance.

## Settings
The settings interface allows users to tailor the Quick Menu to their specific workflow. You can toggle visibility for individual tabs (such as the exit tab or the main quick menu tab) and configure startup behavior to ensure the menu opens exactly how you prefer every time you access it.

The settings interface allows users to tailor the Quick Menu to their specific workflow. Every section can be easily configured by clicking the **gear icon (Settings)** directly within the Quick Menu. Any adjustments made are applied instantly, ensuring the interface updates in real-time to match your preferences. You can also toggle visibility for individual section and configure startup behavior to ensure the menu opens exactly how you prefer every time you access it.

## Custom Actions
The plugin features a robust custom actions engine. Users can define their own menu items, assign custom icons from an extensive internal library, and map specific triggers to actions like "Tap" or "Hold." This flexibility allows you to integrate plugins, system commands, or specific menu navigation directly into your personalized dashboard.

## Credits

This plugin has been built by building upon the work and ideas of several community contributors. A special thanks to:

* **[qewer33](https://github.com/qewer33)** for the original idea behind the [quick-settings patch](https://github.com/qewer33/koreader-patches).
* **[AndyHazz](https://github.com/AndyHazz)** for the icon and action selectors implemented in [bookshelf.koplugin](https://github.com/AndyHazz/bookshelf.koplugin).
* **[doctorhetfield-cmd](https://github.com/doctorhetfield-cmd)** for the power menu implementation from [simpleui.koplugin](https://github.com/doctorhetfield-cmd/simpleui.koplugin).
* **[AnthonyGress](https://github.com/AnthonyGress)** for the sliders and `touch_menu` hooks inspired by [zen_ui.koplugin](https://github.com/AnthonyGress/zen_ui.koplugin).

## Installation

1. Download the `quickmenu.koplugin.zip` from the [Releases](https://github.com/jbreizh/quickmenu.koplugin/releases) page.
2. Unzip the archive and copy the `quickmenu.koplugin` **folder** into your device's plugins directory.
3. Restart KOReader.

| Device | Plugins directory |
|--------|-------------------|
| **Kobo** | `/mnt/onboard/.adds/koreader/plugins/` |
| **Kindle** | `/mnt/base-us/koreader/plugins/` |
| **PocketBook** | `/mnt/ext1/applications/koreader/plugins/` |
| **Android** | `sdcard/koreader/plugins/` |
| **Desktop (Linux/macOS)** | `/koreader/plugins/` |

## Actions list

The following tables detail the available actions, their labels, and the functionality triggered by **Tap** or **Hold** gestures.

> **Note:** Actions requiring specific plugins (e.g., `systemstat`, `batterystat`, `opds`, `calibre`, `SSH`) will display an informational message if the corresponding plugin is not active[cite: 2].

quickmenu.koplugin

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README