Skip to content

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.

update readme (#83)

Maranelloacdb5207a846
diff --git a/README.md b/README.md
index 56ae2023..d671a56d 100644
--- a/README.md
+++ b/README.md
@@ -4,12 +4,13 @@
# AI Audio&Video Translation and Dubbing Tool
- **[English](./README.md) | [简体中文](./docs/README_zh.md) |[日本語](./docs/README_jp.md)|[Русский](./docs/README_rus.md)**
+<a href="https://trendshift.io/repositories/13360" target="_blank"><img src="https://trendshift.io/api/badge/repositories/13360" alt="krillinai%2FKrillinAI | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
+
+ **[English](./README.md) | [简体中文](./docs/README_zh.md) |[日本語](./docs/README_jp.md)|[한국어](./docs/README_kr.md)|[Русский](./docs/README_rus.md)**
- [![Discord](https://img.shields.io/badge/Discord-KrillinAI-blue)](https://discord.gg/7RUa4WuW)
[![Twitter](https://img.shields.io/badge/Twitter-KrillinAI-orange?logo=twitter)](https://x.com/KrillinAI)
-[![哔哩哔哩](https://img.shields.io/badge/哔哩哔哩-KrillinAI-red?logo=bilibili)](https://space.bilibili.com/242124650)
- [![QQ 群](https://img.shields.io/badge/QQ%20群-754069680-green?logo=tencent-qq)](https://jq.qq.com/?_wv=1027&k=754069680)
+[![Bilibili](https://img.shields.io/badge/dynamic/json?label=Bilibili&query=%24.data.follower&suffix=%20followers&url=https%3A%2F%2Fapi.bilibili.com%2Fx%2Frelation%2Fstat%3Fvmid%3D242124650&logo=bilibili&color=00A1D6&labelColor=FE7398&logoColor=FFFFFF)](https://space.bilibili.com/242124650)
+[![QQ 群](https://img.shields.io/badge/QQ%20群-754069680-green?logo=tencent-qq)](https://jq.qq.com/?_wv=1027&k=754069680)
</div>
@@ -20,7 +21,7 @@
Krillin AI is an all-in-one solution for effortless video localization and enhancement. This minimalist yet powerful tool handles everything from translation, dubbing to voice cloning,formatting—seamlessly converting videos between landscape and portrait modes for optimal display across all content platforms(YouTube, TikTok, Bilibili, Douyin, WeChat Channel, RedNote, Kuaishou). With its end-to-end workflow, Krillin AI transforms raw footage into polished, platform-ready content in just a few clicks.
## Key Features:
-🎯 **One-Click Start** - Launch your workflow instantly
+🎯 **One-Click Start** - Launch your workflow instantly,New desktop version available—easier to use!
📥 **Video download** - yt-dlp and local file uploading supported
@@ -42,20 +43,29 @@ The following picture demonstrates the effect after the subtitle file, which was
<table>
<tr>
-<td width="50%">
+<td width="33%">
### Subtitle Translation
---
https://github.com/user-attachments/assets/bba1ac0a-fe6b-4947-b58d-ba99306d0339
</td>
-<td width="50%">
+<td width="33%">
### Dubbing
---
https://github.com/user-attachments/assets/0b32fad3-c3ad-4b6a-abf0-0865f0dd2385
</td>
+
+<td width="33%">
+
+### Portrait
+---
+https://github.com/user-attachments/assets/c2c7b528-0ef8-4ba9-b8ac-f9f92f6d4e71
+
+</td>
+
</tr>
</table>
@@ -68,12 +78,27 @@ Translation languages: 56 languages supported, including English, Chinese, Russi
## 🚀 Quick Start
### Basic Steps
-1. Download the executable file that matches your device system from the release and place it in an empty folder.
-2. Create a `config` folder inside the folder, then create a `config.toml` file in the `config` folder. Copy the content from the `config-example.toml` file in the source code's `config` directory into `config.toml` and fill in your configuration information accordingly.
-3. Double-click the executable file to start the service.
-4. Open a browser and enter `http://127.0.0.1:8888` to start using it (replace 8888 with the port you configured in the `config.toml` file).
+First, download the Release executable file that matches your device's system. Follow the instructions below to choose between the desktop or non-desktop version, then place the software in an empty folder. Running the program will generate some directories, so keeping it in an empty folder makes management easier.
+
+[For the desktop version (release files with "desktop" in the name), refer here]
+_The desktop version is newly released to address the difficulty beginners face in editing configuration files correctly. It still has some bugs and is being continuously updated._
+
+Double-click the file to start using it.
+
+[For the non-desktop version (release files without "desktop" in the name), refer here]
+_The non-desktop version is the original release, with more complex configuration but stable functionality. It is also suitable for server deployment, as it provides a web-based UI._
+
+Create a `config` folder in the directory, then create a `config.toml` file inside it. Copy the contents of the `config-example.toml` file from the source code's `config` directory into your `config.toml` and fill in your configuration details. (If you want to use OpenAI models but don’t know how to get a key, you can join the group for free trial access.)
+
+Double-click the executable or run it in the terminal to start the service.
+
+Open your browser and enter http://127.0.0.1:8888 to begin using it. (Replace 8888 with the port number you specified in the config file.)
### To: macOS Users
+[For the desktop version, i.e., release files with "desktop" in the name, refer here]
+There is currently an issue with the packaging method for the desktop version. After downloading, try renaming the file to "KrillinAI" and then double-click to run. This problem is being fixed.
+
+[For the non-desktop version, i.e., release files without "desktop" in the name, refer here]
This software is not signed, so after completing the file configuration in the "Basic Steps," you will need to manually trust the application on macOS. Follow these steps:
1. Open the terminal and navigate to the directory where the executable file (assuming the file name is `KrillinAI_1.0.0_macOS_arm64`) is located.
2. Execute the following commands in sequence:
diff --git a/docs/README_jp.md b/docs/README_jp.md
index a97faad6..1283871c 100644
--- a/docs/README_jp.md
+++ b/docs/README_jp.md
@@ -2,12 +2,13 @@
<img src="./images/logo.png" alt="KrillinAI" height="100">
# AI動画翻訳・吹き替えツール(簡単デプロイ)
+
+ <a href="https://trendshift.io/repositories/13360" target="_blank"><img src="https://trendshift.io/api/badge/repositories/13360" alt="krillinai%2FKrillinAI | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
-**[English](../README.md) |[简体中文](../docs/README_zh.md)|[日本語](../docs/README_jp.md)|[Русский](../docs/README_rus.md)**
+**[English](../README.md) |[简体中文](../docs/README_zh.md)|[日本語](../docs/README_jp.md)|[한국어](../docs/README_kr.md)|[Русский](../docs/README_rus.md)**
- [![Discord](https://img.shields.io/badge/Discord-KrillinAI-blue)](https://discord.gg/7RUa4WuW)
[![Twitter](https://img.shields.io/badge/Twitter-KrillinAI-orange?logo=twitter)](https://x.com/KrillinAI)
-[![哔哩哔哩](https://img.shields.io/badge/哔哩哔哩-KrillinAI-red?logo=bilibili)](https://space.bilibili.com/242124650)
+[![Bilibili](https://img.shields.io/badge/dynamic/json?label=Bilibili&query=%24.data.follower&suffix=%20フォロワー&url=https%3A%2F%2Fapi.bilibili.com%2Fx%2Frelation%2Fstat%3Fvmid%3D242124650&logo=bilibili&color=00A1D6&labelColor=FE7398&logoColor=FFFFFF)](https://space.bilibili.com/242124650)
</div>
@@ -31,14 +32,14 @@
<table>
<tr>
-<td width="50%">
+<td width="33%">
### 字幕翻訳
---
https://github.com/user-attachments/assets/bba1ac0a-fe6b-4947-b58d-ba99306d0339
</td>
-<td width="50%">
+<td width="33%">
@@ -46,6 +47,14 @@ https://github.com/user-attachments/assets/bba1ac0a-fe6b-4947-b58d-ba99306d0339
---
https://github.com/user-attachments/assets/0b32fad3-c3ad-4b6a-abf0-0865f0dd2385
+</td>
+
+<td width="33%">
+
+### 縦画面
+---
+https://github.com/user-attachments/assets/c2c7b528-0ef8-4ba9-b8ac-f9f92f6d4e71
+
</td>
</tr>
</table>
@@ -56,8 +65,7 @@ https://github.com/user-attachments/assets/0b32fad3-c3ad-4b6a-abf0-0865f0dd2385
翻訳言語対応:英語、中国語、ロシア語、スペイン語、フランス語など56言語
## インターフェースプレビュー
-![インターフェースプレビュー](./images/ui.jpg)
-
+![インターフェースプレビュー](./images/ui_desktop.png)
## クイックスタート
diff --git a/docs/README_rus.md b/docs/README_rus.md
index d4448ec7..741675ed 100644
--- a/docs/README_rus.md
+++ b/docs/README_rus.md
@@ -3,12 +3,12 @@
# AI инструмент для перевода и озвучки аудио и видео
- **[English](../README.md) | [简体中文](../docs/README_zh.md) | [日本語](../docs/README_jp.md)|[Русский](../docs/README_rus.md)**
+ <a href="https://trendshift.io/repositories/13360" target="_blank"><img src="https://trendshift.io/api/badge/repositories/13360" alt="krillinai%2FKrillinAI | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
+
+ **[English](../README.md) | [简体中文](../docs/README_zh.md) |[日本語](../docs/README_jp.md)|[한국어](../docs/README_kr.md)|[Русский](../docs/README_rus.md)**
- [![Discord](https://img.shields.io/badge/Discord-KrillinAI-blue)](https://discord.gg/7RUa4WuW)
[![Twitter](https://img.shields.io/badge/Twitter-KrillinAI-orange?logo=twitter)](https://x.com/KrillinAI)
-[![哔哩哔哩](https://img.shields.io/badge/哔哩哔哩-KrillinAI-red?logo=bilibili)](https://space.bilibili.com/242124650)
- [![QQ 群](https://img.shields.io/badge/QQ%20群-754069680-green?logo=tencent-qq)](https://jq.qq.com/?_wv=1027&k=754069680)
+[![Bilibili](https://img.shields.io/badge/dynamic/json?label=Bilibili&query=%24.data.follower&suffix=%20подписчиков&url=https%3A%2F%2Fapi.bilibili.com%2Fx%2Frelation%2Fstat%3Fvmid%3D242124650&logo=bilibili&color=00A1D6&labelColor=FE7398&logoColor=FFFFFF)](https://space.bilibili.com/242124650)
</div>
@@ -39,19 +39,27 @@ Krillin AI — это универсальное решение для прос
<table>
<tr>
-<td width="50%">
+<td width="33%">
### Перевод субтитров
---
https://github.com/user-attachments/assets/bba1ac0a-fe6b-4947-b58d-ba99306d0339
</td>
-<td width="50%">
+<td width="33%">
### Озвучка
---
https://github.com/user-attachments/assets/0b32fad3-c3ad-4b6a-abf0-0865f0dd2385
+</td>
+
+<td width="33%">
+
+### портретный режим
+---
+https://github.com/user-attachments/assets/c2c7b528-0ef8-4ba9-b8ac-f9f92f6d4e71
+
</td>
</tr>
</table>
@@ -61,7 +69,8 @@ https://github.com/user-attachments/assets/0b32fad3-c3ad-4b6a-abf0-0865f0dd2385
Языки перевода: 56 языков, включая английский, китайский, русский, испанский, французский и др.
## Предпросмотр интерфейса
-![ui preview](./docs/images/ui.jpg)
+![Предпросмотр интерфейса](../docs/images/ui_desktop.png)
+
## 🚀 Быстрый старт
### Основные шаги
diff --git a/docs/README_zh.md b/docs/README_zh.md
index 05aecd6d..27361162 100644
--- a/docs/README_zh.md
+++ b/docs/README_zh.md
@@ -3,21 +3,23 @@
# 极简部署AI视频翻译配音工具
- **[English](../README.md)|[简体中文](../docs/README_zh.md)|[日本語](../docs/README_jp.md)|[Русский](./docs/README_rus.md)**
+ <a href="https://trendshift.io/repositories/13360" target="_blank"><img src="https://trendshift.io/api/badge/repositories/13360" alt="krillinai%2FKrillinAI | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
+
+ **[English](../README.md)|[简体中文](../docs/README_zh.md)|[日本語](../docs/README_jp.md)|[한국어](../docs/README_kr.md)|[Русский](../docs/README_rus.md)**
[![QQ 群](https://img.shields.io/badge/QQ%20群-754069680-green?logo=tencent-qq)](https://jq.qq.com/?_wv=1027&k=754069680)
-[![哔哩哔哩](https://img.shields.io/badge/哔哩哔哩-KrillinAI-red?logo=bilibili)](https://space.bilibili.com/242124650)
+[![Bilibili](https://img.shields.io/badge/dynamic/json?label=Bilibili&query=%24.data.follower&suffix=粉丝&url=https%3A%2F%2Fapi.bilibili.com%2Fx%2Frelation%2Fstat%3Fvmid%3D242124650&logo=bilibili&color=00A1D6&labelColor=FE7398&logoColor=FFFFFF)](https://space.bilibili.com/242124650)
</div>
-### 📢win&mac桌面端新发布 欢迎测试反馈
+### 📢win&mac桌面端新发布 欢迎测试反馈[文档有点落后,持续更新中]
## 项目简介
Krillin AI 是一款全能型音视频本地化与增强解决方案。这款简约而强大的工具,集音视频翻译、配音、语音克隆于一身,支持横竖屏格式输出,确保在所有主流平台(哔哩哔哩,小红书,抖音,视频号,快手,YouTube,TikTok等)都能完美呈现。通过端到端的工作流程,Krillin AI 仅需点击几次,就能将原始素材转化为精美即用的跨平台内容。
## 主要特点与功能:
-🎯 **一键启动**:无需复杂的环境配置,自动安装依赖,立即投入使用
+🎯 **一键启动**:无需复杂的环境配置,自动安装依赖,立即投入使用,新增桌面版本,使用更便捷!
📥 **视频获取**:支持yt-dlp下载或本地文件上传
@@ -40,14 +42,14 @@ Krillin AI 是一款全能型音视频本地化与增强解决方案。这款简
<table>
<tr>
-<td width="50%">
+<td width="33%">
### 字幕翻译
---
https://github.com/user-attachments/assets/bba1ac0a-fe6b-4947-b58d-ba99306d0339
</td>
-<td width="50%">
+<td width="33%">
@@ -56,6 +58,15 @@ https://github.com/user-attachments/assets/bba1ac0a-fe6b-4947-b58d-ba99306d0339
https://github.com/user-attachments/assets/0b32fad3-c3ad-4b6a-abf0-0865f0dd2385
</td>
+
+<td width="33%">
+
+### 竖屏
+---
+https://github.com/user-attachments/assets/c2c7b528-0ef8-4ba9-b8ac-f9f92f6d4e71
+
+</td>
+
</tr>
</table>
@@ -66,17 +77,28 @@ https://github.com/user-attachments/assets/0b32fad3-c3ad-4b6a-abf0-0865f0dd2385
翻译语言支持:英文,中文,俄语,西班牙语,法语等56种语言
## 界面预览
-![界面预览](./images/ui_desktop.png)
+![界面预览](../docs/images/ui_desktop.png)
## 🚀 快速开始
### 基本步骤
-1. 下载[Release](https://github.com/krillinai/KrillinAI/releases)中与你设备系统匹配的可执行文件,放入空文件夹
-2. 在文件夹内创建`config`文件夹,然后在`config`文件夹创建`config.toml`文件,复制源代码`config`目录下的`config-example.toml`文件的内容填入`config.toml`,并对照填写你的配置信息。(想用openai模型但不会获取key的可以加群免费试用)
-3. 双击,或在终端执行可执行文件,启动服务
-4. 打开浏览器,输入`http://127.0.0.1:8888`,开始使用 (8888替换成你在配置文件中填写的端口)
+首先下载[Release](https://github.com/krillinai/KrillinAI/releases)中与你设备系统匹配的可执行文件,按照下面的教程选择桌面版还是非桌面版,然后放入空文件夹,把软件下载到一个空文件夹,因为运行之后会生成一些目录,放到空文件夹会好管理一些。
+
+【如果是桌面版,即release文件带desktop的看此处】
+_桌面版是新发布的,为了解决新手用户难以正确编辑配置文件的问题,还有不少bug,持续更新中_
+1. 双击文件即可开始使用
+
+【如果是非桌面版,即release文件不带desktop的看此处】
+_非桌面版是一开始的版本,配置比较复杂,但是功能稳定,同时适合服务器部署,因为会以web的方式提供ui_
+1. 在文件夹内创建`config`文件夹,然后在`config`文件夹创建`config.toml`文件,复制源代码`config`目录下的`config-example.toml`文件的内容填入`config.toml`,并对照填写你的配置信息。(想用openai模型但不会获取key的可以加群免费试用)
+2. 双击,或在终端执行可执行文件,启动服务
+3. 打开浏览器,输入`http://127.0.0.1:8888`,开始使用 (8888替换成你在配置文件中填写的端口)
### To: macOS用户
+【如果是桌面版,即release文件带desktop的看此处】
+桌面端目前打包方式有点问题,尝试下载好之后把文件名改成KrillinAI之后双击试试,此问题正在修复中。
+
+【如果是非桌面版,即release文件不带desktop的看此处】
本软件没有做签名,因此在macOS上运行时,在完成“基本步骤”中的文件配置后,还需要手动信任应用,方法如下:
1. 在终端打开可执行文件(假设文件名是KrillinAI_1.0.0_macOS_arm64)所在目录
2. 依次执行以下命令:
diff --git a/docs/faq.md b/docs/faq.md
index 3f913dd1..25d3f49c 100644
--- a/docs/faq.md
+++ b/docs/faq.md
@@ -1,7 +1,7 @@
### 1. 看不到`app.log`配置文件,无法知道报错内容
Windows用户请将本软件的工作目录放在非C盘的文件夹。
-### 2. 明明创建了配置文件,但还是报错“找不到配置文件”
+### 2. 非桌面版明明创建了配置文件,但还是报错“找不到配置文件”
确保配置文件名是`config.toml`,而不是`config.toml.txt`或其它。
配置完成后,本软件的工作文件夹的结构应该是这样的:
```
@@ -9,4 +9,7 @@ Windows用户请将本软件的工作目录放在非C盘的文件夹。
│ └── config.toml
├── cookies.txt (<- 可选的cookies.txt文件)
└── krillinai.exe
-```
\ No newline at end of file
+```
+
+### 3. 填写了大模型配置,但是报错“xxxxx需要配置xxxxx API Key”
+模型服务和语音服务虽然可以都用openai的服务,但是也有大模型单独使用非openai的场景,因此这两块配置是分开的,除了大模型配置,请往配置下方找whisper配置填写对应的密钥等信息。
\ No newline at end of file