Skip to content

Commit 7291a5d

Browse files
committedOct 23, 2024
docs(README): 更新文档并优化项目结构
- 更新 README.md 中的说明,移除过于自信的描述 - 添加离线搭建 `fish-speech` 的简略教程 - 更新 API_FLAGS.txt 的配置说明 - 修正异常捕获,使用更通用的 HTTPException - 更新插件版本号至 0.2.2
1 parent 1d7b381 commit 7291a5d

File tree

3 files changed

+17
-11
lines changed

3 files changed

+17
-11
lines changed
 

‎README.md

+14-7
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ _⭐文本生成语音`tts`插件⭐_
1818
## ⭐ 介绍
1919

2020
**仅需一条5秒语音素材,就可~~完美~~优秀克隆素材本音呐!**
21-
你只需要准备好你想克隆的角色语音,并对其语音进行文件名的标注(见下文),就可以快速生成语音。或者使用官方在线api -> [fish-audio](https://fish.audio/zh-CN/)即可享受快速云端的语音生成。
21+
只需要准备好你想克隆的角色语音,并对其语音进行文件名的标注(见下文),就可以快速生成语音。
22+
23+
> 或者使用官方在线api -> [fish-audio](https://fish.audio/zh-CN/)即可享受快速云端的语音生成。
2224
2325
## 📜 免责声明
2426

@@ -90,7 +92,7 @@ ___
9092
| 配置项 | 类型 | 必填项 | 默认值 | 说明 |
9193
|:-----:|:----:|:----:|:---:|:----:|
9294
|online_authorization|str||"xxxxx"|官网api鉴权秘钥,详见[链接](https://fish.audio/zh-CN/go-api/api-keys/)|
93-
|online_model_first|bool||True|如果你想调用官方模型,通过自己的参考音频,定制角色音色,将此项设为`False`。当然,如果你没有准备参考音频,也是会调用官网已经有的音色,具体详见[链接](https://fish.audio/zh-CN/)|
95+
|online_model_first|bool||True|如果你想调用官方模型,通过自己的参考音频,定制角色音色,将此项设为`False`。当然,如果你没有准备参考音频,也会调用官网已经有的音色,具体详见[链接](https://fish.audio/zh-CN/)|
9496

9597
---
9698

@@ -126,23 +128,28 @@ ___
126128

127129
## ⭐ 额外帮助
128130

129-
### 离线搭建`fish-speech`
131+
### 离线搭建简略教程
132+
133+
**准备`fish-speech`**
130134
- 1.将`fish-speech` 仓库 `git clone` 至本地
135+
```bash
136+
137+
git clone https://github.com/fishaudio/fish-speech
138+
```
131139
- 2.运行`install_env.bat`安装虚拟环境以及所需依赖
132140
- 3.运行`start.bat`初次启动
133141
- 4.修改`API_FLAGS.txt`后再次启动即可
134142

135-
### `启动API服务`
143+
**启动API服务**
136144

137-
- 1.修改`API_FLAGS.txt`大致为,即取消`api`前面的`#`
145+
- 1.修改`API_FLAGS.txt`大致为以下内容,即取消`api`前面的`#`
138146
```
139147
# --infer
140148
--api
141149
--listen 0.0.0.0:8080 \ #监听接口
142150
...
143-
144151
```
145-
### `API_FLAGS.txt`里添加额外参数
152+
**`API_FLAGS.txt`里添加额外参数**
146153
- 1.`--complie` ->是否启动编译后的模型 (更快的生成tts,但启动较慢)
147154
- 2.`--workers 数字` ->启动`数字`个多协程 (请务必设置,因为默认一个容易阻塞)
148155
- 3.更多参考[官方文档](https://speech.fish.audio/zh)

‎nonebot_plugin_fishspeech_tts/fish_speech_api.py

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
from nonebot.log import logger
22
from pathlib import Path
3-
from httpx import TimeoutException
43
from .fish_audio_api import ChunkLength
54
from .config import config
6-
from .exception import APIException, FileHandleException
5+
from .exception import APIException, FileHandleException, HTTPException
76
from .request_params import ServeReferenceAudio, ServeTTSRequest
87
from .files import (
98
extract_text_by_filename,
@@ -90,7 +89,7 @@ async def generate_tts(self, request: ServeTTSRequest) -> bytes:
9089
timeout=120,
9190
)
9291
return response.content
93-
except TimeoutException as e:
92+
except HTTPException as e:
9493
logger.error(f"获取TTS音频失败: {e}")
9594
raise APIException("获取TTS音频超时, 你的文本太长啦!")
9695
except Exception:

‎pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "nonebot-plugin-fishspeech-tts"
3-
version = "0.2.1"
3+
version = "0.2.2"
44
description = "一个插件,通过调用在线或本地api发送TTS语音"
55
authors = ["divandia <106718176+Cvandia@users.noreply.github.com>"]
66
license = "MIT"

0 commit comments

Comments
 (0)