moon

Project Overview

moon is a Lua plugin (book.koplugin) for the KOReader reading system, aimed at e-reader users. It brings cloud sync, a local bookshelf, and an AI assistant inside the reader. It follows a local-first design: books and reading progress are kept on the device by default, and sync and AI features are enabled on demand, so reading data does not have to leave the device.

Item	Value
Platform	KOReader (Android and other e-reading platforms)
Language	Lua (KOReader plugin API)
License	Open source (within the KOReader ecosystem)
Distribution	Plugin source from the GitHub repository

A plugin that packs multi-source sync, local-first reading, and an AI assistant into KOReader.

Key Features

• Multi-source sync: supports several cloud storage and download channels as book sources, enabled on demand
• Local-first: book files and reading progress stay on the device by default, no forced cloud upload
• AI assistant: invokes a large language model from the reading view to help with content
• Lock screen and remote management: manage reader state through a lock screen and remote commands
• Download channels: multiple built-in sources for filtering and fetching books
• Plugin structure: standard book.koplugin form that loads directly into KOReader

Target Audience

• KOReader e-reader users
• Users who want one place to manage many book sources
• Users who keep reading data local
• Users who want an AI assistant inside the reader
• Users who enjoy customizing with plugins

Quick Start

1. Install KOReader and confirm it supports plugins
2. Get the moon plugin files from the repository
3. Place the plugin in the KOReader plugin directory
4. Restart KOReader and enable moon in the plugin manager

Core Advantages

• Local-first: reading data stays on the device by default, so privacy is in your hands
• Multi-source in one: scattered sync channels managed through a single plugin
• Non-invasive: loads as a standard plugin without touching the KOReader core

System Requirements

Item	Requirement
Runtime	Android and other platforms supported by KOReader
Language	Lua
Dependency	KOReader plugin API

Notes

• Version fit: the plugin API can change with KOReader updates, so use the matching plugin version
• Channel compliance: some download and AI channels rely on external services; evaluate their use and availability yourself
• Local data: verify network and account settings before enabling sync or remote features