doc: sites

2024-04-19 14:22:45 +08:00
parent ee4337e847
commit 259b3e94fc
40 changed files with 1477 additions and 11 deletions
--- a/sites/docs/zh/guide/README.md
+++ b/sites/docs/zh/guide/README.md
@@ -1,5 +1,17 @@
 ## 快速开始 🚀

+<br>
+只需提供一个视频 <b>主题</b> 或 <b>关键词</b> ，就可以全自动生成视频文案、视频素材、视频字幕、视频背景音乐，然后合成一个高清的短视频。
+<br>
+
+<h4>Web界面</h4>
+
+![](/webui.jpg)
+
+<h4>API界面</h4>
+
+![](/api.jpg)
+
 下载一键启动包，解压直接使用

 ### Windows
@@ -135,3 +147,11 @@ python main.py
 ```

 启动后，可以查看 `API文档` http://127.0.0.1:8080/docs 或者 http://127.0.0.1:8080/redoc 直接在线调试接口，快速体验。
+
+## 许可证 📝
+
+点击查看 [`LICENSE`](LICENSE) 文件
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=harry0703/MoneyPrinterTurbo&type=Date)](https://star-history.com/#harry0703/MoneyPrinterTurbo&Date)
--- a/sites/docs/zh/guide/background-music.md
+++ b/sites/docs/zh/guide/background-music.md
@@ -0,0 +1,4 @@
+## 背景音乐 🎵
+
+用于视频的背景音乐，位于项目的 `resource/songs` 目录下。
+> 当前项目里面放了一些默认的音乐，来自于 YouTube 视频，如有侵权，请删除。
--- a/sites/docs/zh/guide/configuration-requirements.md
+++ b/sites/docs/zh/guide/configuration-requirements.md
@@ -0,0 +1,4 @@
+## 配置要求 📦
+
+- 建议最低 CPU 4核或以上，内存 8G 或以上，显卡非必须
+- Windows 10 或 MacOS 11.0 以上系统
--- a/sites/docs/zh/guide/faq.md
+++ b/sites/docs/zh/guide/faq.md
@@ -0,0 +1,123 @@
+## 常见问题 🤔
+
+### ❓如何使用免费的OpenAI GPT-3.5模型?
+
+[OpenAI宣布ChatGPT里面3.5已经免费了](https://openai.com/blog/start-using-chatgpt-instantly)，有开发者将其封装成了API，可以直接调用
+
+**确保你安装和启动了docker服务**，执行以下命令启动docker服务
+
+```shell
+docker run -p 3040:3040 missuo/freegpt35
+```
+
+启动成功后，修改 `config.toml` 中的配置
+
+- `llm_provider` 设置为 `openai`
+- `openai_api_key` 随便填写一个即可，比如 '123456'
+- `openai_base_url` 改为 `http://localhost:3040/v1/`
+- `openai_model_name` 改为 `gpt-3.5-turbo`
+
+### ❓AttributeError: 'str' object has no attribute 'choices'`
+
+这个问题是由于 OpenAI 或者其他 LLM，没有返回正确的回复导致的。
+
+大概率是网络原因， 使用 **VPN**，或者设置 `openai_base_url` 为你的代理 ，应该就可以解决了。
+
+### ❓RuntimeError: No ffmpeg exe could be found
+
+通常情况下，ffmpeg 会被自动下载，并且会被自动检测到。
+但是如果你的环境有问题，无法自动下载，可能会遇到如下错误：
+
+```
+RuntimeError: No ffmpeg exe could be found.
+Install ffmpeg on your system, or set the IMAGEIO_FFMPEG_EXE environment variable.
+```
+
+此时你可以从 https://www.gyan.dev/ffmpeg/builds/ 下载ffmpeg，解压后，设置 `ffmpeg_path` 为你的实际安装路径即可。
+
+```toml
+[app]
+# 请根据你的实际路径设置，注意 Windows 路径分隔符为 \\
+ffmpeg_path = "C:\\Users\\harry\\Downloads\\ffmpeg.exe"
+```
+
+### ❓生成音频时报错或下载视频报错
+
+[issue 56](https://github.com/harry0703/MoneyPrinterTurbo/issues/56)
+
+```
+failed to generate audio, maybe the network is not available. 
+if you are in China, please use a VPN.
+```
+
+[issue 44](https://github.com/harry0703/MoneyPrinterTurbo/issues/44)
+
+```
+failed to download videos, maybe the network is not available. 
+if you are in China, please use a VPN.
+```
+
+这个大概率是网络原因，无法访问境外的服务，请使用VPN解决。
+
+### ❓ImageMagick is not installed on your computer
+
+[issue 33](https://github.com/harry0703/MoneyPrinterTurbo/issues/33)
+
+1. 按照 `示例配置` 里面提供的 `下载地址`
+   ，安装 https://imagemagick.org/archive/binaries/ImageMagick-7.1.1-29-Q16-x64-static.exe, 用静态库
+2. 不要安装在中文路径里面，避免出现一些无法预料的问题
+
+[issue 54](https://github.com/harry0703/MoneyPrinterTurbo/issues/54#issuecomment-2017842022)
+
+如果是linux系统，可以手动安装，参考 https://cn.linux-console.net/?p=16978
+
+感谢 [@wangwenqiao666](https://github.com/wangwenqiao666)的研究探索
+
+### ❓ImageMagick的安全策略阻止了与临时文件@/tmp/tmpur5hyyto.txt相关的操作
+
+[issue 92](https://github.com/harry0703/MoneyPrinterTurbo/issues/92)
+
+可以在ImageMagick的配置文件policy.xml中找到这些策略。
+这个文件通常位于 /etc/ImageMagick-`X`/ 或 ImageMagick 安装目录的类似位置。
+修改包含`pattern="@"`的条目，将`rights="none"`更改为`rights="read|write"`以允许对文件的读写操作。
+
+感谢 [@chenhengzh](https://github.com/chenhengzh)的研究探索
+
+### ❓OSError: [Errno 24] Too many open files
+
+[issue 100](https://github.com/harry0703/MoneyPrinterTurbo/issues/100)
+
+这个问题是由于系统打开文件数限制导致的，可以通过修改系统的文件打开数限制来解决。
+
+查看当前限制
+
+```shell
+ulimit -n
+```
+
+如果过低，可以调高一些，比如
+
+```shell
+ulimit -n 10240
+```
+
+### ❓AttributeError: module 'PIL.Image' has no attribute 'ANTIALIAS'
+
+[issue 101](https://github.com/harry0703/MoneyPrinterTurbo/issues/101),
+[issue 83](https://github.com/harry0703/MoneyPrinterTurbo/issues/83),
+[issue 70](https://github.com/harry0703/MoneyPrinterTurbo/issues/70)
+
+先看下当前的 Pillow 版本是多少
+
+```shell
+pip list |grep Pillow
+```
+
+如果是 10.x 的版本，可以尝试下降级看看，有用户反馈降级后正常
+
+```shell
+pip uninstall Pillow
+pip install Pillow==9.5.0
+# 或者降级到 8.4.0
+pip install Pillow==8.4.0
+```
--- a/sites/docs/zh/guide/features.md
+++ b/sites/docs/zh/guide/features.md
@@ -0,0 +1,31 @@
+## 功能特性 🎯
+
+- [x] 完整的 **MVC架构**，代码 **结构清晰**，易于维护，支持 `API` 和 `Web界面`
+- [x] 支持视频文案 **AI自动生成**，也可以**自定义文案**
+- [x] 支持多种 **高清视频** 尺寸
+    - [x] 竖屏 9:16，`1080x1920`
+    - [x] 横屏 16:9，`1920x1080`
+- [x] 支持 **批量视频生成**，可以一次生成多个视频，然后选择一个最满意的
+- [x] 支持 **视频片段时长**设置，方便调节素材切换频率
+- [x] 支持 **中文** 和 **英文** 视频文案
+- [x] 支持 **多种语音** 合成
+- [x] 支持 **字幕生成**，可以调整 `字体`、`位置`、`颜色`、`大小`，同时支持`字幕描边`设置
+- [x] 支持 **背景音乐**，随机或者指定音乐文件，可设置`背景音乐音量`
+- [x] 视频素材来源 **高清**，而且 **无版权**
+- [x] 支持 **OpenAI**、**moonshot**、**Azure**、**gpt4free**、**one-api**、**通义千问**、**Google Gemini**、**Ollama** 等多种模型接入
+
+  ❓[如何使用免费的 **OpenAI GPT-3.5
+  ** 模型?](https://github.com/harry0703/MoneyPrinterTurbo?tab=readme-ov-file#%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98-)
+
+  ### 后期计划 📅
+
+- [ ] GPT-SoVITS 配音支持
+- [ ] 优化语音合成，利用大模型，使其合成的声音，更加自然，情绪更加丰富
+- [ ] 增加视频转场效果，使其看起来更加的流畅
+- [ ] 增加更多视频素材来源，优化视频素材和文案的匹配度
+- [ ] 增加视频长度选项：短、中、长
+- [ ] 增加免费网络代理，让访问OpenAI和素材下载不再受限
+- [ ] 可以使用自己的素材
+- [ ] 朗读声音和背景音乐，提供实时试听
+- [ ] 支持更多的语音合成服务商，比如 OpenAI TTS
+- [ ] 自动上传到YouTube平台
--- a/sites/docs/zh/guide/feedback.md
+++ b/sites/docs/zh/guide/feedback.md
@@ -0,0 +1,4 @@
+## 反馈建议 📢
+
+- 可以提交 [issue](https://github.com/harry0703/MoneyPrinterTurbo/issues)
+  或者 [pull request](https://github.com/harry0703/MoneyPrinterTurbo/pulls)。
--- a/sites/docs/zh/guide/reference-project.md
+++ b/sites/docs/zh/guide/reference-project.md
@@ -0,0 +1,4 @@
+## 参考项目 📚
+
+该项目基于 https://github.com/FujiwaraChoki/MoneyPrinter 重构而来，做了大量的优化，增加了更多的功能。
+感谢原作者的开源精神。
--- a/sites/docs/zh/guide/special-thanks.md
+++ b/sites/docs/zh/guide/special-thanks.md
@@ -0,0 +1,9 @@
+## 特别感谢 🙏
+
+由于该项目的 **部署** 和 **使用**，对于一些小白用户来说，还是 **有一定的门槛**，在此特别感谢
+**录咖（AI智能 多媒体服务平台）** 网站基于该项目，提供的免费`AI视频生成器`服务，可以不用部署，直接在线使用，非常方便。
+
+- 中文版：https://reccloud.cn
+- 英文版：https://reccloud.com
+
+![](/reccloud.cn.jpg)
--- a/sites/docs/zh/guide/speech-synthesis.md
+++ b/sites/docs/zh/guide/speech-synthesis.md
@@ -0,0 +1,5 @@
+## 语音合成 🗣
+
+所有支持的声音列表，可以查看：[声音列表](/voice-list.txt)
+
+2024-04-16 v1.1.2 新增了9种Azure的语音合成声音，需要配置API KEY，该声音合成的更加真实。
--- a/sites/docs/zh/guide/subtitle-font.md
+++ b/sites/docs/zh/guide/subtitle-font.md
@@ -0,0 +1,3 @@
+## 字幕字体 🅰
+
+用于视频字幕的渲染，位于项目的 `resource/fonts` 目录下，你也可以放进去自己的字体。
--- a/sites/docs/zh/guide/subtitle-generation.md
+++ b/sites/docs/zh/guide/subtitle-generation.md
@@ -0,0 +1,36 @@
+## 字幕生成 📜
+
+当前支持2种字幕生成方式：
+
+- **edge**: 生成`速度快`，性能更好，对电脑配置没有要求，但是质量可能不稳定
+- **whisper**: 生成`速度慢`，性能较差，对电脑配置有一定要求，但是`质量更可靠`。
+
+可以修改 `config.toml` 配置文件中的 `subtitle_provider` 进行切换
+
+建议使用 `edge` 模式，如果生成的字幕质量不好，再切换到 `whisper` 模式
+
+> 注意：
+
+1. whisper 模式下需要到 HuggingFace 下载一个模型文件，大约 3GB 左右，请确保网络通畅
+2. 如果留空，表示不生成字幕。
+
+> 由于国内无法访问 HuggingFace，可以使用以下方法下载 `whisper-large-v3` 的模型文件
+
+下载地址：
+
+- 百度网盘: https://pan.baidu.com/s/11h3Q6tsDtjQKTjUu3sc5cA?pwd=xjs9
+- 夸克网盘：https://pan.quark.cn/s/3ee3d991d64b
+
+模型下载后解压，整个目录放到 `.\MoneyPrinterTurbo\models` 里面，
+最终的文件路径应该是这样: `.\MoneyPrinterTurbo\models\whisper-large-v3`
+
+```
+MoneyPrinterTurbo  
+  ├─models
+  │   └─whisper-large-v3
+  │          config.json
+  │          model.bin
+  │          preprocessor_config.json
+  │          tokenizer.json
+  │          vocabulary.json
+```
--- a/sites/docs/zh/guide/thanks-for-sponsoring.md
+++ b/sites/docs/zh/guide/thanks-for-sponsoring.md
@@ -0,0 +1,7 @@
+## 感谢赞助 🙏
+
+感谢佐糖 https://picwish.cn 对该项目的支持和赞助，使得该项目能够持续的更新和维护。
+
+佐糖专注于**图像处理领域**，提供丰富的**图像处理工具**，将复杂操作极致简化，真正实现让图像处理更简单。
+
+![picwish.jpg](/picwish.jpg)
--- a/sites/docs/zh/guide/video-demonstration.md
+++ b/sites/docs/zh/guide/video-demonstration.md
@@ -0,0 +1,37 @@
+## 视频演示 📺
+
+### 竖屏 9:16
+
+<table>
+<thead>
+<tr>
+<th align="center"><g-emoji class="g-emoji" alias="arrow_forward">▶️</g-emoji> 《如何增加生活的乐趣》</th>
+<th align="center"><g-emoji class="g-emoji" alias="arrow_forward">▶️</g-emoji> 《金钱的作用》<br>更真实的合成声音</th>
+<th align="center"><g-emoji class="g-emoji" alias="arrow_forward">▶️</g-emoji> 《生命的意义是什么》</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td align="center"><video src="https://github.com/harry0703/MoneyPrinterTurbo/assets/4928832/a84d33d5-27a2-4aba-8fd0-9fb2bd91c6a6"></video></td>
+<td align="center"><video src="https://github.com/harry0703/MoneyPrinterTurbo/assets/4928832/af2f3b0b-002e-49fe-b161-18ba91c055e8"></video></td>
+<td align="center"><video src="https://github.com/harry0703/MoneyPrinterTurbo/assets/4928832/112c9564-d52b-4472-99ad-970b75f66476"></video></td>
+</tr>
+</tbody>
+</table>
+
+### 横屏 16:9
+
+<table>
+<thead>
+<tr>
+<th align="center"><g-emoji class="g-emoji" alias="arrow_forward">▶️</g-emoji>《生命的意义是什么》</th>
+<th align="center"><g-emoji class="g-emoji" alias="arrow_forward">▶️</g-emoji>《为什么要运动》</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td align="center"><video src="https://github.com/harry0703/MoneyPrinterTurbo/assets/4928832/346ebb15-c55f-47a9-a653-114f08bb8073"></video></td>
+<td align="center"><video src="https://github.com/harry0703/MoneyPrinterTurbo/assets/4928832/271f2fae-8283-44a0-8aa0-0ed8f9a6fa87"></video></td>
+</tr>
+</tbody>
+</table>