更新文档

This commit is contained in:
harry
2024-03-23 15:34:06 +08:00
parent 0771b3268c
commit 6a66a3a8f0

View File

@@ -5,21 +5,22 @@
## 功能特性 🎯
- [x] 完整的 **MVC架构**,代码 **结构清晰**易于维护支持API和Web界面
- [x] 支持视频文案 **AI自动生成**,也可以**自定义文案**
- [x] 支持多种 **高清视频** 尺寸
- [x] 竖屏 9:16`1080x1920`
- [x] 横屏 16:9`1920x1080`
- [x] 支持 **批量视频生成**,可以一次生成多个视频,然后选择一个最满意的
- [x] 支持 **视频片段时长**设置,方便调节素材切换频率
- [x] 支持 **中文****英文** 视频文案
- [x] 支持 **多种语音** 合成
- [x] 支持 **字幕生成**,可以调整字体、颜色、大小,同时支持字幕描边设置
- [x] 支持 **背景音乐**,随机或者指定音乐文件
- [x] 支持 **字幕生成**,可以调整 `字体``位置`、颜色`、`大小`,同时支持`字幕描边`设置
- [x] 支持 **背景音乐**,随机或者指定音乐文件,可设置`背景音乐音量`
- [x] 视频素材来源 **无版权** 问题
### 后期计划 🚀
- [ ] 完善异步API接口进度显示
- [ ] 优化语音合成,利用大模型,使其合成的声音,更加自然,情绪更加丰富
- [ ] 增加视频转场效果,使其看起来更加的流畅
- [ ] 优化字幕效果
- [ ] 优化视频素材的匹配度
## 视频演示 📺
@@ -59,20 +60,54 @@ pip install -r requirements.txt
## 快速使用 🚀
### 视频教程
- 完整的使用演示https://v.douyin.com/iFhnwsKY/
- 如何在Windows上部署https://v.douyin.com/iFyjoW3M
### 前提
> 注意,尽量不要使用 **中文路径**,避免出现一些无法预料的问题
1. 安装好 ImageMagick
- Windows:
- 下载 https://imagemagick.org/archive/binaries/ImageMagick-7.1.1-29-Q16-x64-static.exe 并安装(不要修改安装路径)
- 修改配置文件 `config.toml` 中的 `imagemagick_path` 为你的实际安装路径(如果安装的时候没有修改路径,直接取消注释即可)
- MacOS: `brew install imagemagick`
2.`config.example.toml` 文件重命名为 `config.toml`
3. 按照 `config.toml` 文件中的说明,配置好 `pexels_api_keys` 和 llm 相关的 api key
4. 如果没有OpenAI的API Key可以使用到 [月之暗面](https://platform.moonshot.cn/console/api-keys) 申请。注册就送 15元体验金可以对话1500次左右。然后设置 `llm_provider="moonshot"``moonshot_api_key`。感谢 [@jerryblues](https://github.com/harry0703/MoneyPrinterTurbo/issues/8) 的建议
- 尽量不要使用 **中文路径**,避免出现一些无法预料的问题
- 请确保你的 **网络** 是正常的,即可以正常访问境外网站
#### ① 安装好 ImageMagick
##### Windows:
- 下载 https://imagemagick.org/archive/binaries/ImageMagick-7.1.1-29-Q16-x64-static.exe
- 安装下载好的 ImageMagick注意不要修改安装路径
##### MacOS:
```shell
brew install imagemagick
````
##### Ubuntu
```shell
sudo apt-get install imagemagick
```
##### CentOS
```shell
sudo yum install ImageMagick
```
#### ② 修改配置文件
-`config.example.toml` 文件复制一份,命名为 `config.toml`
- 按照 `config.toml` 文件中的说明,配置好 `pexels_api_keys``llm_provider`,并根据 llm_provider 对应的服务商,配置相关的
API Key
- 如果是`Windows`系统,`imagemagick_path` 为你的实际安装路径(如果安装的时候没有修改路径,直接取消注释即可)
#### ③ 配置大模型(LLM)
- 如果要使用 `GPT-4.0``GPT-3.5`,需要有 `OpenAI``API Key`,如果没有,可以将 `llm_provider` 设置为 `g4f` (
一个免费使用GPT的开源库 https://github.com/xtekky/gpt4free)
- 或者可以使用到 [月之暗面](https://platform.moonshot.cn/console/api-keys) 申请。注册就送
15元体验金可以对话1500次左右。然后设置 `llm_provider="moonshot"``moonshot_api_key`
。感谢 [@jerryblues](https://github.com/harry0703/MoneyPrinterTurbo/issues/8) 的建议
### 启动Web界面
@@ -81,16 +116,20 @@ pip install -r requirements.txt
#### Windows
```bat
conda activate MoneyPrinterTurbo
webui.bat
```
#### MacOS or Linux
```shell
conda activate MoneyPrinterTurbo
sh webui.sh
```
启动后,会自动打开浏览器,效果如下图:
启动后,会自动打开浏览器
效果如下图:
![](docs/webui.jpg)
### 启动API服务
@@ -100,6 +139,8 @@ python main.py
```
启动后,可以查看 `API文档` http://127.0.0.1:8080/docs 直接在线调试接口,快速体验。
效果如下图:
![](docs/api.jpg)
## 语音合成 🗣