https://github.com/lxpio/omnigram

Omnigram is a Flutter-based file reader and audiobook . It accommodates EPUB and PDF and offers audiobook functionality, supporting TTS model and other AI chat technologies for enhanced reading experiences
https://github.com/lxpio/omnigram

chatbot epub flutter nas tts

Last synced: 3 months ago
JSON representation

Omnigram is a Flutter-based file reader and audiobook . It accommodates EPUB and PDF and offers audiobook functionality, supporting TTS model and other AI chat technologies for enhanced reading experiences

• Host: GitHub
• URL: https://github.com/lxpio/omnigram
• Owner: lxpio
• Created: 2023-07-26T15:03:40.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-02-21T13:27:06.000Z (4 months ago)
• Last Synced: 2024-02-21T14:36:21.962Z (4 months ago)
• Topics: chatbot, epub, flutter, nas, tts
• Language: Dart
• Homepage: https://omnigram.lxpio.com
• Size: 6.02 MB
• Stars: 24
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Lists

• awesome-stars - lxpio/omnigram - Omnigram is a Flutter-based file reader and audiobook . It accommodates EPUB and PDF and offers audiobook functionality, supporting TTS model and other AI chat technologies for enhanced reading exper (Dart)

README

        
#

  

  

  



  English | 中文



![docs action](https://github.com/lxpio/omnigram/actions/workflows/docs.yaml/badge.svg)

## About Omnigram

Omnigram is a multi-platform (iOS, Android, Web, Windows, Linux, Mac) file reading and audiobook client written in Flutter. It supports multiple formats, including EPUB and PDF. It provides audiobook functionality through TTS models and supports other AI models for assisted reading. In addition, it has local book management capabilities, allowing users to easily manage book storage on NAS. For its backend service deployment, refer to [omnigam-server](server/README.md). Or check the [official project documentation](https://omnigram.lxpio.com/).

## Features

- [x] Supports iOS and Android for EPUB ebook reading

- [x] Supports TTS text-to-speech, allows custom TTS engines

- [x] Supports local book management (NAS), including searching, reading, listening, notes, favorites, downloading, deleting books, settings, etc.

- [x] Supports conversational assistant with Markdown support, code block highlighting, conversation settings

- [x] Books support TTS reading using models

- [ ] Supports PDF, documents and other NAS content services management

- [ ] Supports Web, Windows, Linux, Mac

## Omnigram Infrastructure

![base_struct](docs/static/img/struct.svg)

## Official Documentation

You can find the official documentation (including installation manuals) at .

## Examples

TODO

## For Dev

This project uses a three-way repository including:

- [riverpod](https://docs-v2.riverpod.dev/docs)

- [objectbox](https://docs.objectbox.io/getting-started)

### build

```bash

git clone github.com/lxpio/omnigram.git

cd omnigram

flutter clean && dart run build_runner build

make

```