Formerly KrillinAI, VideoTranslation and Dubbing Tool for 120+ Languages. Open-source AI workspace for creators, powered by Codex. Video downloader, video translation, create videos, images, audios, and edits with Agents in one place. For your Social Media like YouTube, TikTok, Instagram, etc.
TypeScript agent-skillscodex-clideskop-appdubbingimage-generationlocalizationskillsttsvideo-editingvideo-generationvideo-transcriptionvideo-translation
docs: Update FAQ and README with new Q&A and configuration guidance
puji4810a9d0df30d098
diff --git a/README.md b/README.mdindex a231eab1..99e020b7 100644--- a/README.md+++ b/README.md@@ -1,23 +1,26 @@<div align="center"><img src="/docs/images/logo.jpg" alt="KlicStudio" height="90">- # Minimalist AI Video Translation and Dubbing Tool+# Minimalist AI Video Translation and Dubbing Tool- <a href="https://trendshift.io/repositories/13360" target="_blank"><img src="https://trendshift.io/api/badge/repositories/13360" alt="KrillinAI%2FKlicStudio | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>+<a href="https://trendshift.io/repositories/13360" target="_blank"><img src="https://trendshift.io/api/badge/repositories/13360" alt="KrillinAI%2FKlicStudio | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>- **[English](/README.md)|[简体中文](/docs/zh/README.md)|[日本語](/docs/jp/README.md)|[한국어](/docs/kr/README.md)|[Tiếng Việt](/docs/vi/README.md)|[Français](/docs/fr/README.md)|[Deutsch](/docs/de/README.md)|[Español](/docs/es/README.md)|[Português](/docs/pt/README.md)|[Русский](/docs/rus/README.md)|[اللغة العربية](/docs/ar/README.md)**+**[English](/README.md)|[简体中文](/docs/zh/README.md)|[日本語](/docs/jp/README.md)|[한국어](/docs/kr/README.md)|[Tiếng Việt](/docs/vi/README.md)|[Français](/docs/fr/README.md)|[Deutsch](/docs/de/README.md)|[Español](/docs/es/README.md)|[Português](/docs/pt/README.md)|[Русский](/docs/rus/README.md)|[اللغة العربية](/docs/ar/README.md)**[](https://x.com/KrillinAI)[](https://jq.qq.com/?_wv=1027&k=754069680)[](https://space.bilibili.com/242124650)+[](https://deepwiki.com/krillinai/KlicStudio)</div>- ## Project Introduction ([Try the online version now!](https://www.klic.studio/))+## Project Introduction ([Try the online version now!](https://www.klic.studio/))+[**Quick Start**](#-quick-start)Klic Studio is a versatile audio and video localization and enhancement solution developed by Krillin AI. This minimalist yet powerful tool integrates video translation, dubbing, and voice cloning, supporting both landscape and portrait formats to ensure perfect presentation on all major platforms (Bilibili, Xiaohongshu, Douyin, WeChat Video, Kuaishou, YouTube, TikTok, etc.). With an end-to-end workflow, you can transform raw materials into beautifully ready-to-use cross-platform content with just a few clicks.## Key Features and Functions:+🎯 **One-click Start**: No complex environment configuration required, automatic dependency installation, ready to use immediately, with a new desktop version for easier access!📥 **Video Acquisition**: Supports yt-dlp downloads or local file uploads@@ -26,7 +29,7 @@ Klic Studio is a versatile audio and video localization and enhancement solution🧠 **Intelligent Segmentation**: Subtitle segmentation and alignment using LLM-🔄 **Terminology Replacement**: One-click replacement of professional vocabulary+🔄 **Terminology Replacement**: One-click replacement of professional vocabulary🌍 **Professional Translation**: LLM translation with context to maintain natural semantics@@ -36,8 +39,8 @@ Klic Studio is a versatile audio and video localization and enhancement solution💻 **Cross-Platform**: Supports Windows, Linux, macOS, providing both desktop and server versions-## Effect Demonstration+The image below shows the effect of the subtitle file generated after importing a 46-minute local video and executing it with one click, without any manual adjustments. There are no omissions or overlaps, the segmentation is natural, and the translation quality is very high.@@ -46,16 +49,18 @@ The image below shows the effect of the subtitle file generated after importing<td width="33%">### Subtitle Translation+---+https://github.com/user-attachments/assets/bba1ac0a-fe6b-4947-b58d-ba99306d0339</td><td width="33%">--### Dubbing+---+https://github.com/user-attachments/assets/0b32fad3-c3ad-4b6a-abf0-0865f0dd2385</td>@@ -63,7 +68,9 @@ https://github.com/user-attachments/assets/0b32fad3-c3ad-4b6a-abf0-0865f0dd2385<td width="33%">### Portrait Mode+---+https://github.com/user-attachments/assets/c2c7b528-0ef8-4ba9-b8ac-f9f92f6d4e71</td>@@ -72,6 +79,7 @@ https://github.com/user-attachments/assets/c2c7b528-0ef8-4ba9-b8ac-f9f92f6d4e71</table>## 🔍 Supported Speech Recognition Services+_**All local models in the table below support automatic installation of executable files + model files; you just need to choose, and Klic will prepare everything for you.**_| Service Source | Supported Platforms | Model Options | Local/Cloud | Remarks |@@ -85,6 +93,7 @@ _**All local models in the table below support automatic installation of executa## 🚀 Large Language Model Support✅ Compatible with all cloud/local large language model services that comply with **OpenAI API specifications**, including but not limited to:+- OpenAI- Gemini- DeepSeek@@ -93,89 +102,117 @@ _**All local models in the table below support automatic installation of executa- Other API services compatible with OpenAI format## 🎤 TTS Text-to-Speech Support+- Alibaba Cloud Voice Service- OpenAI TTS## Language Support+Input languages supported: Chinese, English, Japanese, German, Turkish, Korean, Russian, Malay (continuously increasing)Translation languages supported: English, Chinese, Russian, Spanish, French, and 101 other languages## Interface Preview-+## 🚀 Quick Start++You can ask questions on the [Deepwiki of KlicStudio](https://deepwiki.com/krillinai/KlicStudio). It indexes the files in the repository, so you can find answers quickly.+### Basic Steps-First, download the executable file that matches your device system from the [Release](https://github.com/KrillinAI/KlicStudio/releases), then follow the tutorial below to choose between the desktop version or non-desktop version. Place the software download in an empty folder, as running it will generate some directories, and keeping it in an empty folder will make management easier.-【If it is the desktop version, i.e., the release file with "desktop," see here】+First, download the executable file that matches your device system from the [Release](https://github.com/KrillinAI/KlicStudio/releases), then follow the tutorial below to choose between the desktop version or non-desktop version. Place the software download in an empty folder, as running it will generate some directories, and keeping it in an empty folder will make management easier.++【If it is the desktop version, i.e., the release file with "desktop," see here】_The desktop version is newly released to address the issues of new users struggling to edit configuration files correctly, and there are some bugs that are continuously being updated._+1. Double-click the file to start using it (the desktop version also requires configuration within the software)-【If it is the non-desktop version, i.e., the release file without "desktop," see here】+【If it is the non-desktop version, i.e., the release file without "desktop," see here】_The non-desktop version is the initial version, which has a more complex configuration but is stable in functionality and suitable for server deployment, as it provides a UI in a web format._+1. Create a `config` folder within the folder, then create a `config.toml` file in the `config` folder. Copy the contents of the `config-example.toml` file from the source code's `config` directory into `config.toml`, and fill in your configuration information according to the comments.-2. Double-click or execute the executable file in the terminal to start the service+2. Double-click or execute the executable file in the terminal to start the service3. Open your browser and enter `http://127.0.0.1:8888` to start using it (replace 8888 with the port you specified in the configuration file)### To: macOS Users-【If it is the desktop version, i.e., the release file with "desktop," see here】++【If it is the desktop version, i.e., the release file with "desktop," see here】Due to signing issues, the desktop version currently cannot be double-clicked to run or installed via dmg; you need to manually trust the application. The method is as follows:+1. Open the terminal in the directory where the executable file (assuming the file name is KlicStudio_1.0.0_desktop_macOS_arm64) is located2. Execute the following commands in order:+```sudo xattr -cr ./KlicStudio_1.0.0_desktop_macOS_arm64sudo chmod +x ./KlicStudio_1.0.0_desktop_macOS_arm64./KlicStudio_1.0.0_desktop_macOS_arm64```-【If it is the non-desktop version, i.e., the release file without "desktop," see here】+【If it is the non-desktop version, i.e., the release file without "desktop," see here】This software is not signed, so when running on macOS, after completing the file configuration in the "Basic Steps," you also need to manually trust the application. The method is as follows:+1. Open the terminal in the directory where the executable file (assuming the file name is KlicStudio_1.0.0_macOS_arm64) is located2. Execute the following commands in order:```- sudo xattr -rd com.apple.quarantine ./KlicStudio_1.0.0_macOS_arm64+ sudo xattr -rd com.apple.quarantine ./KlicStudio_1.0.0_macOS_arm64sudo chmod +x ./KlicStudio_1.0.0_macOS_arm64./KlicStudio_1.0.0_macOS_arm64- ```- This will start the service+ ```++ This will start the service### Docker Deployment+This project supports Docker deployment; please refer to the [Docker Deployment Instructions](./docker.md)-### Cookie Configuration Instructions (Optional)+Based on the provided configuration file, here is the updated "Configuration Help (Must Read)" section for your README file:-If you encounter issues with video downloads+### Configuration Help (Must Read)-Please refer to the [Cookie Configuration Instructions](./get_cookies.md) to configure your Cookie information.+The configuration file is divided into several sections: `[app]`, `[server]`, `[llm]`, `[transcribe]`, and `[tts]`. A task is composed of speech recognition (`transcribe`) + large model translation (`llm`) + optional voice services (`tts`). Understanding this will help you better grasp the configuration file.-### Configuration Help (Must Read)-The quickest and easiest configuration method:-* Fill in `transcribe.provider.name` with `openai`, so you only need to fill in the `transcribe.openai` block and the large model configuration in the `llm` block to perform subtitle translation. (`app.proxy`, `model`, and `openai.base_url` can be filled in as needed)+**Easiest and Quickest Configuration:**++**For Subtitle Translation Only:**+ * In the `[transcribe]` section, set `provider.name` to `openai`.+ * You will then only need to fill in your OpenAI API key in the `[llm]` block to start performing subtitle translations. The `app.proxy`, `model`, and `openai.base_url` can be filled in as needed.++**Balanced Cost, Speed, and Quality (Using Local Speech Recognition):**-Using a local speech recognition model configuration method (balancing cost, speed, and quality):-* Fill in `transcribe.provider.name` with `fasterwhisper`, `transcribe.fasterwhisper.model` with `large-v2`, and then fill in the `llm` block with the large model configuration to perform subtitle translation. The local model will be automatically downloaded and installed. (`app.proxy` and `openai.base_url` are the same as above)+* In the `[transcribe]` section, set `provider.name` to `fasterwhisper`.+* Set `transcribe.fasterwhisper.model` to `large-v2`.+* Fill in your large language model configuration in the `[llm]` block.+* The required local model will be automatically downloaded and installed.-Text-to-speech (TTS) is optional; the configuration logic is the same as above. Fill in `tts.provider.name`, and then fill in the corresponding configuration block under `tts`. The voice codes in the UI should be filled in according to the documentation of the selected provider (the documentation address is in the common questions section below). Filling in Alibaba Cloud's AccessKey, Bucket, AppKey, etc., may be repetitive to ensure a clear configuration structure.-Note: If using voice cloning, `tts` only supports selecting `aliyun`.+**Text-to-Speech (TTS) Configuration (Optional):**-**For obtaining Alibaba Cloud AccessKey, Bucket, and AppKey, please read**: [Alibaba Cloud Configuration Instructions](./aliyun.md)+* TTS configuration is optional.+* First, set the `provider.name` under the `[tts]` section (e.g., `aliyun` or `openai`).+* Then, fill in the corresponding configuration block for the selected provider. For example, if you choose `aliyun`, you must fill in the `[tts.aliyun]` section.+* Voice codes in the user interface should be chosen based on the selected provider's documentation.+* **Note:** If you plan to use the voice cloning feature, you must select `aliyun` as the TTS provider.-Please understand that the task = speech recognition + large model translation + voice service (TTS, etc., optional), which will help you understand the configuration file better.+**Alibaba Cloud Configuration:**++* For details on obtaining the necessary `AccessKey`, `Bucket`, and `AppKey` for Alibaba Cloud services, please refer to the [Alibaba Cloud Configuration Instructions](https://www.google.com/search?q=./aliyun.md). The repeated fields for AccessKey, etc., are designed to maintain a clear configuration structure.## Frequently Asked QuestionsPlease visit [Frequently Asked Questions](./faq.md)## Contribution Guidelines+1. Do not submit useless files, such as .vscode, .idea, etc.; please use .gitignore to filter them out.2. Do not submit config.toml; instead, submit config-example.toml.## Contact Us+1. Join our QQ group for questions: 7540696802. Follow our social media accounts, [Bilibili](https://space.bilibili.com/242124650), where we share quality content in the AI technology field every day.## Star History-[](https://star-history.com/#KrillinAI/KlicStudio&Date)\ No newline at end of file+[](https://star-history.com/#KrillinAI/KlicStudio&Date)+diff --git a/faq.md b/faq.mdindex 9f031a30..a7b71545 100644--- a/faq.md+++ b/faq.md@@ -36,4 +36,8 @@ Most of this is due to missing Chinese fonts on Linux. Please download the [Micr### 6. How to fill in the voice synthesis tone code?Please refer to the documentation of the voice service provider. The following are related to this project:[OpenAI TTS Documentation](https://platform.openai.com/docs/guides/text-to-speech/api-reference), located in Voice options-[Alibaba Cloud Intelligent Voice Interaction Documentation](https://help.aliyun.com/zh/isi/developer-reference/overview-of-speech-synthesis), located in Tone List - voice parameter values\ No newline at end of file+[Alibaba Cloud Intelligent Voice Interaction Documentation](https://help.aliyun.com/zh/isi/developer-reference/overview-of-speech-synthesis), located in Tone List - voice parameter values++### 7. The progress bar isn't moving. Is it working?+Yes.(If you don't see the error message)+The progress bar updates only after a part of task is fully completed. Time-consuming operations like Whisper transcription or FFmpeg processing can cause it to pause for extended periods. Please wait for the task to finish.\ No newline at end of file