inkwell

Project Overview

Inkwell is an Android text reader focused on reading itself, with an interface written from scratch in Jetpack Compose and no ads, accounts, or push notifications. Its layout engine is entirely custom-drawn, and reading progress is stored as a chapter plus in-chapter offset, so changing font size, family, or screen never loses your place. No third-party content or access rules are bundled by default; you import rules yourself.

Change the font size without losing your place; progress always lines up.

Key Features

• Four page-turn styles: simulated curl, cover, slide, and no animation, all finger-tracked
• Custom layout engine: canvas pagination where measurement and rendering are the same, avoiding overflow
• Reliable progress: progress as chapter plus offset returns to the same sentence after re-layout
• Multi-format import: imports txt, EPUB, and MOBI into one unified rendering
• Custom rules: imports JSON rules and is compatible with a subset of Legado text rules
• Private shelf: an optional hidden section protected by biometrics or a password
• RSS subscriptions: import feeds and browse article lists and bodies
• WebDAV sync: single-file incremental sync of shelf, progress, and settings, without uploading book files

Target Audience

• Readers who value typography and progress accuracy
• Users who need a private shelf and local reading
• Advanced users familiar with Legado rules
• Those who want progress synced between phone and web

Quick Start

1. Download the signed APK from Releases and install it
2. Open the app and import local txt, EPUB, or MOBI files
3. Choose the page-turn style, font, and light or dark theme in the reader
4. For online content, import rules from the clipboard or a URL in source management
5. Configure WebDAV in settings to sync between the device and the web version

Core Advantages

• Reliable progress: decoupled from layout, so parameter changes never lose your place
• Clean and minimal: no ads, accounts, or push notifications
• Unified rendering: multiple formats and rule content become one paragraph stream for a single engine
• Testable: core logic lives in pure JVM modules for easy verification

System Requirements

Item	Requirement
OS	Android
Build	JDK 21, Android SDK platform 36 or later
Sync	Requires your own WebDAV service

Notes

• The app bundles no rules or content by default; importing and using rules is your responsibility
• Audio, comic, and file source types are unsupported, as are some extreme script rules
• The web version requires sign-in, and its accounts are separate from the Android client