explaingit

yanllsama/neo-quicksettings-for-koreader

Analysis updated 2026-05-18

8LuaAudience · generalComplexity · 2/5Setup · easy

TLDR

A KOReader plugin that replaces the quick settings panel with a fully customizable one, complete with a visual icon picker and custom buttons.

Mindmap

mindmap
  root((Neo QuickSettings))
    What it does
      Custom quick settings panel
      Visual icon picker
      Frontlight sliders
    Tech stack
      Lua
      KOReader plugin
    Use cases
      Customize e-reader shortcuts
      Organize favorite actions
      Adjust brightness and warmth
    Audience
      KOReader users
      E-ink device owners

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Replace KOReader's default quick settings panel with a fully customizable one.

USE CASE 2

Pick icons visually for custom buttons instead of typing icon names.

USE CASE 3

Set up sliders to control frontlight brightness and warmth on an e-reader.

What is it built with?

Lua

How does it compare?

yanllsama/neo-quicksettings-for-koreaderegor-oleg/aegis-autocraftatcold/sota-models
Stars886
LanguageLuaLuaLua
Last pushed2014-11-18
MaintenanceDormant
Setup difficultyeasyhardmoderate
Complexity2/53/53/5
Audiencegeneralgeneralresearcher

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min

Requires copying the plugin folder plus a separate icon file into specific KOReader directories.

The README does not state a license for this project.

In plain English

Neo QuickSettings is a plugin for KOReader, the open source e-reader software used on devices like e-ink tablets, that replaces the standard quick settings panel with a much more customizable one. Instead of digging through menus, a reader can pull up a single panel to adjust brightness, warmth, and shortcuts, with far more control over how everything looks and behaves than the built in options allow. One of its main features is a visual icon picker, so instead of typing or guessing icon names, a user can browse through hundreds of icons across different styles and pick one just by looking at it. The plugin also lets people build their own custom buttons tied to specific actions or scripts, with a draft and discard system that lets changes be tested safely before they are made permanent. Frequently used actions can be grouped into favorite tabs to keep the panel tidy, and up to four sliders can be set up for controlling frontlight brightness and warmth, either as smooth sliders or in fixed steps. Beyond that, the plugin supports deep visual customization: buttons can be shown or hidden, labels changed, icon sizes adjusted, borders toggled, and the whole layout arranged however the user prefers. It also integrates with something called SimpleUI, letting favorite shortcuts be sent directly to that launcher. To install it, a user downloads the plugin, copies its folder into KOReader's plugins directory, and separately copies an included icon file into KOReader's own icons folder, then restarts the app. After that, the panel can be opened from KOReader's menu or triggered with a gesture, and further customized through a settings menu reached by long pressing a button or tapping the gear icon. The project builds on earlier work from other KOReader community developers, crediting the creators of an existing quicksettings plugin, an earlier UI system called Zenui, and the original patch that started the idea, and it is released as open source itself.

Copy-paste prompts

Prompt 1
Walk me through installing this KOReader plugin, including where the neo.svg icon file needs to go.
Prompt 2
Explain how the draft and discard system works when creating custom buttons in this plugin.
Prompt 3
Help me set up favorite groups to organize my most used quick settings actions.
Prompt 4
Explain what SimpleUI integration does in this plugin and how to send shortcuts to it.

Frequently asked questions

What is neo-quicksettings-for-koreader?

A KOReader plugin that replaces the quick settings panel with a fully customizable one, complete with a visual icon picker and custom buttons.

What language is neo-quicksettings-for-koreader written in?

Mainly Lua. The stack also includes Lua.

What license does neo-quicksettings-for-koreader use?

The README does not state a license for this project.

How hard is neo-quicksettings-for-koreader to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is neo-quicksettings-for-koreader for?

Mainly general.

Open on GitHub → Explain another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.