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/guide/README.md
+++ b/sites/docs/guide/README.md
@@ -1,5 +1,16 @@
 ## Installation & Deployment 📥

+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
+
+![](/webui-en.jpg)
+
+### API Interface
+
+![](/api.jpg)
+
 - Try to avoid using **Chinese paths** to prevent unpredictable issues
 - Ensure your **network** is stable, meaning you can access foreign websites normally

@@ -113,3 +124,11 @@ 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.
+
+## License 📝
+
+Click to view the [`LICENSE`](LICENSE) file
+
+## 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/guide/background-music.md
+++ b/sites/docs/guide/background-music.md
@@ -0,0 +1,5 @@
+## 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.
--- a/sites/docs/guide/faq.md
+++ b/sites/docs/guide/faq.md
@@ -0,0 +1,70 @@
+## Common Questions 🤔
+
+### ❓How to Use the Free OpenAI GPT-3.5 Model?
+
+[OpenAI has announced that ChatGPT with 3.5 is now free](https://openai.com/blog/start-using-chatgpt-instantly), and
+developers have wrapped it into an API for direct usage.
+
+**Ensure you have Docker installed and running**. Execute the following command to start the Docker service:
+
+```shell
+docker run -p 3040:3040 missuo/freegpt35
+```
+
+Once successfully started, modify the `config.toml` configuration as follows:
+
+- Set `llm_provider` to `openai`
+- Fill in `openai_api_key` with any value, for example, '123456'
+- Change `openai_base_url` to `http://localhost:3040/v1/`
+- Set `openai_model_name` to `gpt-3.5-turbo`
+
+### ❓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-30-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
--- a/sites/docs/guide/features.md
+++ b/sites/docs/guide/features.md
@@ -0,0 +1,34 @@
+## 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 **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**,
+  **qianwen**, **Google Gemini**, **Ollama** and more
+
+❓[How to Use the Free OpenAI GPT-3.5 Model?](https://github.com/harry0703/MoneyPrinterTurbo/blob/main/README-en.md#common-questions-)
+
+### Future Plans 📅
+
+- [ ] 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
+- [ ] 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, Azure TTS
+- [ ] Automate the upload process to the YouTube platform
--- a/sites/docs/guide/feedback.md
+++ b/sites/docs/guide/feedback.md
@@ -0,0 +1,4 @@
+## Feedback & Suggestions 📢
+
+- You can submit an [issue](https://github.com/harry0703/MoneyPrinterTurbo/issues) or
+  a [pull request](https://github.com/harry0703/MoneyPrinterTurbo/pulls).
--- a/sites/docs/guide/reference-project.md
+++ b/sites/docs/guide/reference-project.md
@@ -0,0 +1,4 @@
+## 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.
--- a/sites/docs/guide/speech-synthesis.md
+++ b/sites/docs/guide/speech-synthesis.md
@@ -0,0 +1,3 @@
+## Voice Synthesis 🗣
+
+A list of all supported voices can be viewed here: [Voice List](/voice-list.txt)
--- a/sites/docs/guide/subtitle-font.md
+++ b/sites/docs/guide/subtitle-font.md
@@ -0,0 +1,4 @@
+## Subtitle Fonts 🅰
+
+Fonts for rendering video subtitles are located in the project's `resource/fonts` directory, and you can also add your
+own fonts.
--- a/sites/docs/guide/subtitle-generation.md
+++ b/sites/docs/guide/subtitle-generation.md
@@ -0,0 +1,15 @@
+## 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.
--- a/sites/docs/guide/video-demonstration.md
+++ b/sites/docs/guide/video-demonstration.md
@@ -0,0 +1,35 @@
+## Video Demos 📺
+
+### Portrait 9:16
+
+<table>
+<thead>
+<tr>
+<th align="center"><g-emoji class="g-emoji" alias="arrow_forward">▶️</g-emoji> How to Add Fun to Your Life </th>
+<th align="center"><g-emoji class="g-emoji" alias="arrow_forward">▶️</g-emoji> What is the Meaning of Life</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/112c9564-d52b-4472-99ad-970b75f66476"></video></td>
+</tr>
+</tbody>
+</table>
+
+### Landscape 16:9
+
+<table>
+<thead>
+<tr>
+<th align="center"><g-emoji class="g-emoji" alias="arrow_forward">▶️</g-emoji> What is the Meaning of Life</th>
+<th align="center"><g-emoji class="g-emoji" alias="arrow_forward">▶️</g-emoji> Why Exercise</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>