General Introduction
QuickPiperAudiobook is an open source project designed to convert various text formats (e.g. epub, mobi, txt, PDF, HTML, etc.) into natural-sounding audiobooks with one simple command. The tool uses the Piper model for conversion and manages the installation of Piper and related models. All conversion processes are done locally to ensure user privacy.
Function List
- Support multiple input formats: epub, mobi, txt, PDF, HTML, etc.
- High-quality audio conversion using the Piper model
- Managing Piper Installations and Associated Models
- Support for fetching and transforming content from remote URLs
- Offline conversion to ensure user privacy
- Automatic generation of configuration files to simplify the process
Using Help
Installation process
- Download pre-built releases (or use
go mod tidy && go build
(Build from source). - downloading
ebook-convert
and make sure it's in your PATH (usually bundled with Calibre). - You don't need to pre-install Piper, the program manages Piper and related models automatically.
Usage
- Generate audiobooks using local files or remote URLs as input:
. /QuickPiperAudiobook test.txt
- View all options:
. /QuickPiperAudiobook--help
configuration file
- The program will automatically add a new value to the
~/.config/QuickPiperAudiobook/config.yml
Generate a configuration file. - You can set the default model and output path in the configuration file to simplify subsequent operations.
typical example
- The default output example can be found in the
examples
folder to find it. - Other examples of pre-trained models can be found in the Piper Samples Found in.
caveat
- Piper does not currently support progress output.
- Longer books (600 pages or more) may take longer (30 minutes or more) to generate audio because all calculations are done locally.