Merge pull request #69 from Root-FTW/patch-1

Update README-en.md
This commit is contained in:
Harry
2024-03-27 08:00:40 +08:00
committed by GitHub

View File

@@ -1,52 +1,68 @@
# MoneyPrinterTurbo 💸
Simply provide a video **keyword**, and MoneyPrinterTurbo can automatically generate video scripts, source materials, subtitles, and background music, then compile them into a high-definition short video.
Simply provide a **topic** or **keyword** for a video, and it will automatically generate the video copy, video materials, video subtitles, and video background music before synthesizing a high-definition short video.
## Feature Highlights 🎯
![](docs/webui.jpg)
- [x] Complete **MVC architecture** with a **clear structure** for ease of maintenance, supporting both API and web interfaces.
- [x] Supports various **HD video** sizes:
## Special Thanks 🙏
Due to the **deployment** and **usage** of this project, there is a certain threshold for some beginner users. We would like to express our special thanks to
**LuKa (AI Intelligent Multimedia Service Platform)** for providing a free `AI Video Generator` service based on this project. It allows for online use without deployment, which is very convenient.
- Chinese version: https://reccloud.cn
- English version: https://reccloud.com
![](docs/reccloud.jpg)
## Features 🎯
- [x] Complete **MVC architecture**, **clearly structured** code, easy to maintain, supports both API and Web interface
- [x] Supports **AI-generated** video copy, as well as **customized copy**
- [x] Supports various **high-definition video** sizes
- [x] Portrait 9:16, `1080x1920`
- [x] Landscape 16:9, `1920x1080`
- [x] Supports video scripts in both **Chinese** and **English**.
- [x] Offers **multiple voice** synthesis options.
- [x] Provides **subtitle generation**, allowing for adjustments in font, color, size, and outline settings.
- [x] Supports **background music**, either random or specific music files.
- [x] Video materials are **free from copyright** issues.
- [x] Supports **batch video generation**, allowing the creation of multiple videos at once, then selecting the most satisfactory one
- [x] Supports setting the **duration of video clips**, facilitating adjustments to material switching frequency
- [x] Supports video copy in both **Chinese** and **English**
- [x] Supports **multiple voice** synthesis
- [x] Supports **subtitle generation**, with adjustable `font`, `position`, `color`, `size`, and also supports `subtitle outlining`
- [x] Supports **background music**, either random or specified music files, with adjustable `background music volume`
- [x] Video material sources are **high-definition** and **royalty-free**
- [x] Supports integration with various models such as **OpenAI**, **moonshot**, **Azure**, **gpt4free**, **one-api**, and more
### Future Plans 🚀
### Future Plans 📅
- [ ] Enhance asynchronous API interfaces with progress display.
- [ ] Improve voice synthesis using advanced models for more natural and emotionally rich voices.
- [ ] Add video transition effects for smoother visuals.
- [ ] Enhance subtitle effects.
- [ ] Optimize the relevance of video materials.
- [ ] Support for GPT-SoVITS dubbing
- [ ] Optimize voice synthesis using large models to make the synthesized voice sound more natural and emotionally rich
- [ ] Add video transition effects to make the viewing experience smoother
- [ ] Optimize the relevance of video materials
## Video Demonstrations 📺
## Video Demos 📺
### Portrait 9:16
▶️ "How to Add More Fun to Your Life"
▶️ How to Add Fun to Your Life
https://github.com/harry0703/MoneyPrinterTurbo/assets/4928832/a84d33d5-27a2-4aba-8fd0-9fb2bd91c6a6
▶️ "What Is the Meaning of Life?"
▶️ What is the Meaning of Life
https://github.com/harry0703/MoneyPrinterTurbo/assets/4928832/112c9564-d52b-4472-99ad-970b75f66476
### Landscape 16:9
▶️ "What Is the Meaning of Life?"
▶️ What is the Meaning of Life
https://github.com/harry0703/MoneyPrinterTurbo/assets/4928832/346ebb15-c55f-47a9-a653-114f08bb8073
▶️ "Why Exercise?"
▶️ Why Exercise
https://github.com/harry0703/MoneyPrinterTurbo/assets/4928832/271f2fae-8283-44a0-8aa0-0ed8f9a6fa87
## Installation & Setup 📥
## Installation & Deployment 📥
It is recommended to use [conda](https://conda.io/projects/conda/en/latest/user-guide/install/index.html) for creating a Python virtual environment.
It is recommended to create a Python virtual environment using [conda](https://conda.io/projects/conda/en/latest/user-guide/install/index.html)
```shell
git clone https://github.com/harry0703/MoneyPrinterTurbo.git
@@ -55,3 +71,182 @@ conda create -n MoneyPrinterTurbo python=3.10
conda activate MoneyPrinterTurbo
pip install -r requirements.txt
```
## Quick Start 🚀
### Video Tutorials
- Complete usage demonstration: https://v.douyin.com/iFhnwsKY/
- How to deploy on Windows: https://v.douyin.com/iFyjoW3M
### Prerequisites
- Try to avoid using **Chinese paths** to prevent unpredictable issues
- Ensure your **network** is stable, meaning you can access foreign websites normally
#### ① Install ImageMagick
##### Windows:
- Download https://imagemagick.org/archive/binaries/ImageMagick-7.1.1-29-Q16-x64-static.exe
- Install the downloaded ImageMagick, do not change the installation path
##### MacOS:
```shell
brew install imagemagick
````
##### Ubuntu
```shell
sudo apt-get install imagemagick
```
##### CentOS
```shell
sudo yum install ImageMagick
```
#### ② Modify the Configuration File
- Copy the `config.example.toml` file and rename it to `config.toml`
- Follow the instructions in the `config.toml` file to configure `pexels_api_keys` and `llm_provider`, and according to the llm_provider's service provider, set up the corresponding API Key
- If it's a `Windows` system, `imagemagick_path` is your actual installation path (if you didn't change the path during installation, just uncomment it)
#### ③ Configure Large Language Models (LLM)
- To use `GPT-4.0` or `GPT-3.5`, you need an `API Key` from `OpenAI`. If you don't have one, you can set `llm_provider` to `g4f` (a free-to-use GPT library https://github.com/xtekky/gpt4free)
- Alternatively, you can apply at [Moonshot](https://platform.moonshot.cn/console/api-keys). Register to get 15 yuan of trial money, which allows for about 1500 conversations. Then set `llm_provider="moonshot"` and `moonshot_api_key`. Thanks to [@jerryblues](https://github.com/harry0703/MoneyPrinterTurbo/issues/8) for the suggestion
### Launch the Web Interface 🌐
Note that you need to execute the following commands in the `root directory` of the MoneyPrinterTurbo project
#### Windows
```bat
conda activate MoneyPrinterTurbo
webui.bat
```
#### MacOS or Linux
```shell
conda activate MoneyPrinterTurbo
sh webui.sh
```
After launching, the browser will open automatically
The effect is shown in the following image:
![](docs/webui.jpg)
### Launch the API Service 🚀
```shell
python main.py
```
After launching, you can view the `API documentation` at http://127.0.0.1:8080/docs and directly test the interface online for a quick experience.
The effect is shown in the following image:
![](docs/api.jpg)
## Voice Synthesis 🗣
A list of all supported voices can be viewed here: [Voice List](./docs/voice-list.txt)
## Subtitle Generation 📜
Currently, there are 2 ways to generate subtitles:
- edge: Faster generation speed, better performance, no specific requirements for computer configuration, but the quality may be unstable
- whisper: Slower generation speed, poorer performance, specific requirements for computer configuration, but more reliable quality
You can switch between them by modifying the `subtitle_provider` in the `config.toml` configuration file
It is recommended to use `edge` mode, and switch to `whisper` mode if the quality of the subtitles generated is not satisfactory.
> If left blank, it means no subtitles will be generated.
## Background Music 🎵
Background music for videos is located in the project's `resource/songs` directory.
> The current project includes some default music from YouTube videos. If there are copyright issues, please delete them.
## Subtitle Fonts 🅰
Fonts for rendering video subtitles are located in the project's `resource/fonts` directory, and you can also add your own fonts.
## Common Questions 🤔
### ❓RuntimeError: No ffmpeg exe could be found
Normally, ffmpeg will be automatically downloaded and detected.
However, if your environment has issues preventing automatic downloads, you may encounter the following error:
```
RuntimeError: No ffmpeg exe could be found.
Install ffmpeg on your system, or set the IMAGEIO_FFMPEG_EXE environment variable.
```
In this case, you can download ffmpeg from https://www.gyan.dev/ffmpeg/builds/, unzip it, and set `ffmpeg_path` to your actual installation path.
```toml
[app]
# Please set according to your actual path, note that Windows path separators are \\
ffmpeg_path = "C:\\Users\\harry\\Downloads\\ffmpeg.exe"
```
### ❓Error generating audio or downloading videos
[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.
```
This is likely due to network issues preventing access to foreign services. Please use a VPN to resolve this.
### ❓ImageMagick is not installed on your computer
[issue 33](https://github.com/harry0703/MoneyPrinterTurbo/issues/33)
1. Follow the `example configuration` provided `download address` to install https://imagemagick.org/archive/binaries/ImageMagick-7.1.1-29-Q16-x64-static.exe, using the static library
2. Do not install in a path with Chinese characters to avoid unpredictable issues
[issue 54](https://github.com/harry0703/MoneyPrinterTurbo/issues/54#issuecomment-2017842022)
For Linux systems, you can manually install it, refer to https://cn.linux-console.net/?p=16978
Thanks to [@wangwenqiao666](https://github.com/wangwenqiao666) for their research and exploration
## Feedback & Suggestions 📢
- You can submit an [issue](https://github.com/harry0703/MoneyPrinterTurbo/issues) or a [pull request](https://github.com/harry0703/MoneyPrinterTurbo/pulls).
- You can also follow my **TikTok** or **Video Account**: `Wang Xu Harry.AI`
- I will post some **usage tutorials** and **pure technical** shares there.
- If there are updates and optimizations, I will **notify promptly** there.
- You can also **leave messages** there, and I will **reply as soon as possible**.
| TikTok | | Video Account |
|:-----------------------------------------:|:------------:|:----------------------------------------------------:|
| <img src="docs/douyin.jpg" width="180"> | | <img src="docs/shipinghao.jpg" width="200"> |
## Reference Projects 📚
This project is based on https://github.com/FujiwaraChoki/MoneyPrinter and has been refactored with a lot of optimizations and added functionalities. Thanks to the original author for their spirit of open source.
## License 📝
Click to view the [`LICENSE`](LICENSE) file