Readme Translations

[C-Loftus]

If you are a speaker of a non-English language that has a piper model and you find this repo is useful, I would love to have help translating the readme into your language.

Current Translated Languages

• Polish
• Chinese

[newptcai]

The following Chinese translation by Claude is good enough:

QuickPiperAudiobook (快速 Piper 有声书转换器)

一键将任意文本内容转换为自然音色的有声书。

• 支持转换多种格式：PDF、epub、txt、mobi、djvu、HTML、docx 等
• 完全离线转换，确保隐私安全
• 采用 Piper 语音模型，支持多国语言

在这里试听示例音频

安装步骤

1. 下载预编译的程序包

   • (或通过 go mod tidy && go build 命令从源码编译)

2. 安装 ebook-convert 工具并添加到系统 PATH 中（通常包含在 Calibre 电子书管理器 中）

[!注意]
无需单独安装 Piper，本程序会自动管理 Piper 及其语音模型

使用方法

• 生成有声书：
  • 本地文件：./QuickPiperAudiobook test.txt
  • 在线文件：直接输入URL
• 查看所有选项：
  • 输入：./QuickPiperAudiobook --help

非英语 / UTF-8 文本处理

• 从 Piper 模型库 下载所需语言的模型文件（.onnx 和 .json）
  • 示例：pl_PL-gosia-medium.onnx 及其对应的 pl_PL-gosia-medium.onnx.json（如需要可重命名）
• 将文件放入 ~/.config/QuickPiperAudiobook/ 目录
• 使用 --speak-utf-8 和 --model= 参数指定模型来处理 UTF-8 文本
  • 示例：./QuickPiperAudiobook --speak-utf-8 --model=pl_PL-gosia-medium.onnx MaszynaTuringa_Wikipedia.pdf

[!注意]
如果经常使用某个模型，建议在配置文件中将其设为默认模型

配置说明

• 程序首次运行时会自动创建配置文件：~/.config/QuickPiperAudiobook/config.yml
• 你可以在配置文件中设置：
  • 默认输出路径
  • 默认语音模型
• 支持自定义语音模型：将对应的 .onnx 和 .onnx.json 文件放入 ~/.config/QuickPiperAudiobook/ 目录即可

# 配置文件示例：`~/.config/QuickPiperAudiobook/config.yml`

# 未指定 --output 参数时的默认输出目录
output: ~/Audiobooks
# 未指定 --model 参数时的默认语音模型
model: "en_US-hfc_female-medium.onnx"

[C-Loftus]

Thanks @newptcai !

If you would like, feel free to open a PR, I will wait for one other Chinese speaker to review (just as a best practice), and then I am happy to merge. I am generally fine with machine translation as long as it is reasonably accurate.

I am working on a new feature PR so it also may be best to hold off until I am done with #16 ; I am planning to add some new features that will affect the readme. Will keep this thread updated.

Appreciate your interest on this!

[newptcai]

OK. Please let me know when you are done.

This is a very useful tool for me. I use it to convert ebooks to audiobooks so I can reduce my screen time for reading. I hope it will have more features in the future, such as chapters, allowing filtering out parts that should not be in an audio book, etc.

[C-Loftus]

I have created a new significant release v0.0.5

If you have a second @w84death would you mind updating the Polish translation?

@newptcai you can now submit a PR for the Chinese translation as things are stable and unlikely to change much for a bit.