An open API service indexing awesome lists of open source software.

https://github.com/ireaderorg/ireader

Free and open source novel reader for Android and Desktop.
https://github.com/ireaderorg/ireader

android compose hacktoberfest ireader kotlin light-novels novel novel-reader reader webnovel webnovels

Last synced: 23 days ago
JSON representation

Free and open source novel reader for Android and Desktop.

Awesome Lists containing this project

README

          

# πŸ“– IReader

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
[![GitHub release](https://img.shields.io/github/v/release/IReaderorg/IReader)](https://github.com/IReaderorg/IReader/releases)

**A free and open-source novel reader for Android and Desktop**

[Download](https://github.com/IReaderorg/IReader/releases) β€’ [Documentation](docs/README.md) β€’ [Wiki](https://codewiki.google/github.com/ireaderorg/ireader) β€’ [δΈ­ζ–‡](README_zh.md)

A cross-platform novel reader with support for multiple sources through extensions and JavaScript plugins. Read your favorite web novels offline with a customizable reading experience.

## ✨ Features

- πŸ“± Android and Desktop support
- πŸ“š Multiple sources via extensions and JavaScript plugins
- πŸ“₯ Offline reading with chapter downloads
- πŸ” Search across multiple sources
- πŸ“– Library management with categories and filters
- πŸŒ™ Dark mode and customizable themes
- πŸ”Š AI Text-to-Speech (Desktop)
- πŸ“¦ Import Legado/ι˜…θ―» book sources
- 🚫 No ads or tracking

## πŸ“² Installation

### Android
Download the latest APK from [GitHub Releases](https://github.com/IReaderorg/IReader/releases)

**Requirements:** Android 7.0 or higher

### Desktop
Download the latest release from [GitHub Releases](https://github.com/IReaderorg/IReader/releases)

**Supported:** Windows, macOS, Linux

## πŸš€ Quick Start

### Using LNReader Sources (Recommended)

IReader now supports LNReader sources! Follow these steps:

1. **Add LNReader Repository**
- Go to **Settings β†’ Repository**
- Tap the **Add icon (+)**
- Select **Quick Add Popular Repo**
- Choose **LNReader**
- Save and refresh remote sources in the Source screen

2. **Storage Permissions (Optional)**
- By default, LNReader sources are saved to app cache (no permissions needed)
- To save sources to external storage for easier access, disable **"Saved Sources to Cache"** in Settings β†’ General
- If using external storage, grant storage permissions when prompted

3. **Start Reading**
- Browse sources to find novels
- Add books to your library
- Download chapters for offline reading

> **Note:** IReader no longer supports the in-app default repository. You must add repositories manually in Settings.

### Using Legado Sources

IReader supports importing book sources from [Legado/ι˜…θ―»](https://github.com/gedoor/legado), a popular Chinese novel reader:

1. Go to **More β†’ Community β†’ Legado Sources**
2. Enter a Legado source URL or paste JSON directly
3. Select sources to import and tap **Import**

Imported sources appear immediately in your sources list.

## πŸ“– Documentation

- **[πŸ“š Full Documentation Index](docs/README.md)** - Start here for all guides
- [Text-to-Speech Guide](docs/guides/tts.md)
- [Sources & Extensions](docs/guides/sources.md)
- [Sync & Backup](docs/guides/sync_backup.md)
- [Developer Documentation](docs/developer/README.md)

## 🌍 Contributing

Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.

- Translations: [Weblate](https://hosted.weblate.org/projects/ireader/ireader/)
- Extensions: [IReader Extensions](https://github.com/IReaderorg/IReader-extensions)

### 🍎 iOS Developer Needed

We're looking for a developer to help wire the iOS module to the main app. All the groundwork is done β€” the iOS module exists and the core components are ready β€” but the final integration work remains. @kazemcodes is unable to continue this work due to not having access to a Mac.

The app can also leverage IReader's existing sources since they are compiled to Native/JS, making the integration straightforward.

If you have iOS/macOS development experience and want to help bring IReader to iOS, please reach out!

## πŸ“„ License

Licensed under [Apache 2.0 License](LICENSE)

## πŸ™ Acknowledgments

- [LNReader](https://github.com/LNReader/lnreader) – Thank you for maintaing the plugins
- [Tachiyomi](https://github.com/tachiyomiorg/tachiyomi) – Architecture inspiration
- [Piper TTS](https://github.com/rhasspy/piper) – Text-to-speech engine
- All our [contributors](https://github.com/IReaderorg/IReader/graphs/contributors)

## Screenshots

| Library | Book Detail | Reader |
| ------- | ----------- | ------ |
| ![library](screenshots/library-screen.jpg) | ![book](screenshots/book-screen.jpg) | ![reader](screenshots/reader-screen.jpg) |

| Settings | Theme | TTS |
| -------- | ----- | --- |
| ![settings](screenshots/settting-screen.jpg) | ![theme](screenshots/theme-screen.jpg) | ![tts](screenshots/tts-screen.jpg) |

| Statistics | Leaderboard | Translation |
| ---------- | ----------- | ----------- |
| ![statistics](screenshots/static-screen.jpg) | ![leaderboard](screenshots/leaderboard-screen.jpg) | ![translation](screenshots/translation.jpg) |