update readme

This commit is contained in:
harry 2024-04-03 16:01:01 +08:00
parent 08f51901db
commit f0d3d31210
2 changed files with 82 additions and 49 deletions

View File

@ -14,10 +14,17 @@
> Thanks to [RootFTW](https://github.com/Root-FTW) for the translation
Simply provide a **topic** or **keyword** for a video, and it will automatically generate the video copy, video
Simply provide a <b>topic</b> or <b>keyword</b> 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.
### WebUI
![](docs/webui-en.jpg)
### API Interface
![](docs/api.jpg)
</div>
## Special Thanks 🙏
@ -25,7 +32,7 @@ materials, video subtitles, and video background music before synthesizing a hig
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
**RecCloud (AI-Powered 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.
https://reccloud.com
@ -54,11 +61,17 @@ https://reccloud.com
### Future Plans 📅
- [ ] 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
- [ ] OLLAMA support
- [ ] Introduce support for GPT-SoVITS dubbing
- [ ] Enhance voice synthesis with large models for a more natural and emotionally resonant voice output
- [ ] Incorporate video transition effects to ensure a smoother viewing experience
- [ ] Improve the relevance of video content
- [ ] Implement OLLAMA support
- [ ] Add options for video length: short, medium, long
- [ ] Package the application into a one-click launch bundle for Windows and macOS for ease of use
- [ ] Enable the use of custom materials
- [ ] Offer voiceover and background music options with real-time preview
- [ ] Support a wider range of voice synthesis providers, such as OpenAI TTS
- [ ] Automate the upload process to the YouTube platform
## Video Demos 📺
@ -98,6 +111,53 @@ https://reccloud.com
## Installation & Deployment 📥
- Try to avoid using **Chinese paths** to prevent unpredictable issues
- Ensure your **network** is stable, meaning you can access foreign websites normally
#### ① Clone the Project
```shell
git clone https://github.com/harry0703/MoneyPrinterTurbo.git
```
#### ② 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
#### ③ 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)
### Docker Deployment 🐳
#### ① Launch the Docker Container
If you haven't installed Docker, please install it first https://www.docker.com/products/docker-desktop/
If you are using a Windows system, please refer to Microsoft's documentation:
1. https://learn.microsoft.com/en-us/windows/wsl/install
2. https://learn.microsoft.com/en-us/windows/wsl/tutorials/wsl-containers
```shell
cd MoneyPrinterTurbo
docker-compose up
```
#### ② Access the Web Interface
Open your browser and visit http://0.0.0.0:8501
#### ③ Access the API Interface
Open your browser and visit http://0.0.0.0:8080/docs Or http://0.0.0.0:8080/redoc
### Manual Deployment 📦
#### ① Create 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)
@ -109,66 +169,45 @@ conda activate MoneyPrinterTurbo
pip install -r requirements.txt
```
## Quick Start 🚀
#### ② Install ImageMagick
### 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:
###### 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
- Install the downloaded ImageMagick, **do not change the installation path**
- Modify the `config.toml` configuration file, set `imagemagick_path` to your actual installation path (if you didn't
change the path during installation, just uncomment it)
##### MacOS:
###### MacOS:
```shell
brew install imagemagick
````
##### Ubuntu
###### Ubuntu
```shell
sudo apt-get install imagemagick
```
##### CentOS
###### 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 🌐
#### ③ Launch the Web Interface 🌐
Note that you need to execute the following commands in the `root directory` of the MoneyPrinterTurbo project
#### Windows
###### Windows
```bat
conda activate MoneyPrinterTurbo
webui.bat
```
#### MacOS or Linux
###### MacOS or Linux
```shell
conda activate MoneyPrinterTurbo
@ -177,10 +216,7 @@ sh webui.sh
After launching, the browser will open automatically
The effect is shown in the following image:
![](docs/webui-en.jpg)
### Launch the API Service 🚀
#### ④ Launch the API Service 🚀
```shell
python main.py
@ -189,9 +225,6 @@ 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)

View File

@ -8,7 +8,7 @@
<a href="https://github.com/harry0703/MoneyPrinterTurbo/blob/main/LICENSE"><img src="https://img.shields.io/github/license/harry0703/MoneyPrinterTurbo.svg?style=for-the-badge" alt="License"></a>
</p>
<br>
<h3><a href="README-en.md">English</a> | 简体中文</h3>
<h3>简体中文 | <a href="README-en.md">English</a></h3>
<br>
只需提供一个视频 <b>主题</b><b>关键词</b> ,就可以全自动生成视频文案、视频素材、视频字幕、视频背景音乐,然后合成一个高清的短视频。
<br>
@ -126,7 +126,7 @@ git clone https://github.com/harry0703/MoneyPrinterTurbo.git
15元体验金可以对话1500次左右。然后设置 `llm_provider="moonshot"``moonshot_api_key`
- 也可以使用 通义千问,具体请看配置文件里面的注释说明
### Docker部署 🚀
### Docker部署 🐳
#### ① 启动Docker
@ -149,7 +149,7 @@ docker-compose up
打开浏览器,访问 http://0.0.0.0:8080/docs 或者 http://0.0.0.0:8080/redoc
### 手动部署 🚀
### 手动部署 📦
> 视频教程