Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
Update readme.md
  • Loading branch information
H1DDENADM1N committed Feb 27, 2024
1 parent fd22946 commit 578eedd
Showing 1 changed file with 31 additions and 10 deletions.
41 changes: 31 additions & 10 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 😘 CapsWriter-Offline 图形界面包分支 ( 仅 🪟Windows
# 😘 CapsWriter-Offline 图形界面包分支 ( 仅 🪟Windows 10 +

![start_server_or_client_in_tray](assets/start_server_or_client_in_tray.gif)

Expand All @@ -14,6 +14,15 @@

4. 将音视频文件拖动到客户端 `start_client_gui.exe` 打开,即可转录生成 srt 字幕

# 📙 目录

- [✨ 特性](#-特性)
- [⬇️ 下载地址](#-下载地址)
- [❗ 注意事项](#-注意事项)
- [🤓 源码运行](#-源码运行)
- [🔧 修改配置](#-修改配置)
- [🪳 提交 Bug ](https://github.com/H1DDENADM1N/CapsWriter-Offline/issues)

# ✨ 特性

1. 基于 [PySide6](https://pypi.org/project/PySide6/) 的 GUI,服务端 `start_server_gui.exe` 默认使用 [Qt-Material](https://github.com/UN-GCPDS/qt-material) dark_yellow 主题,客户端 `start_client_gui.exe` 默认使用 [Qt-Material](https://github.com/UN-GCPDS/qt-material) dark_teal 主题;基于 [PyStand](https://github.com/skywind3000/PyStand) 绿化便携 `exe`
Expand Down Expand Up @@ -62,23 +71,35 @@

# ❗ 注意事项

1. 存在杀毒误报,建议关闭杀毒软件和防火墙,再解压
1. 存在杀毒误报,建议关闭杀毒软件和防火墙,再解压

2. 建议先不要修改默认配置,测试能否正常运行

3. 音视频文件转录功能依赖于 `FFmpeg`,打包版本已内置 `FFmpeg`

4. 默认的快捷键是 `caps lock`,你可以打开 `core_client.py` 进行修改

5. 使用翻译功能输入结束时,先松开 `CapsLock` 键,待输入完成,再松开 `Left Shift``Right Shift`

6. 输入状态提示功能由 [AutoHotKeyV2](https://www.autohotkey.com/download/) `hint_while_recording.exe` 实现,修改 `config.py` 默认快捷键并**不会**改变提示的按键设置,需要编辑 `hint_while_recording.ahk` 并自行编译替换 `hint_while_recording.exe`

7. 在线翻译基于 [DeepLX](https://github.com/OwO-Network/DeepLX) ,过于频繁的请求可能导致 IP 被封,如果出现 429 错误,则表示你的 IP 被 DeepL 暂时屏蔽了,请不要在短时间内频繁请求

2. 建议先不要修改默认配置,测试能否正常运行
8. 当某程序以管理员权限运行,可能会出现有识别结果但是却无法在那个程序输入文字的状况,例如:`Listary``PixPin` 等。这是因为 `start_client_gui.exe` 默认以用户权限运行客户端,运行在用户权限的程序无法控制管理员权限的程序。你可以关闭用户权限运行的客户端,尝试使用 `start_client_gui_admin.exe` 以管理员权限运行客户端

3. 音视频文件转录功能依赖于 `FFmpeg`,打包版本已内置 `FFmpeg`
9. 添加开机自启动的方法:

4. 默认的快捷键是 `caps lock`,你可以打开 `core_client.py` 进行修改
9.1 如果你未更改默认配置( `In_the_meantime_start_the_client = True` 表示一键启动功能 生效,服务端会自动启动客户端),只用新建 `start_server_gui.exe` 的快捷方式,将服务端的快捷方式放到 `shell:startup` 目录下即可在开机时自动启动服务端和客户端。服务端会自动启动客户端。不要添加客户端的快捷方式。

5. 使用翻译功能输入结束时,先松开 `CapsLock` 键,待输入完成,再松开 `Left Shift``Right Shift`
9.1.1 如果你未更改默认配置( `In_the_meantime_start_the_client_as_admin = True` ),启动服务端会自动以管理员权限启动客户端。

6. 输入状态提示功能由 [AutoHotKeyV2](https://www.autohotkey.com/download/) `hint_while_recording.exe` 实现,修改 `config.py` 默认快捷键并**不会**改变提示的按键设置,需要编辑 `hint_while_recording.ahk` 并自行编译替换 `hint_while_recording.exe`
9.1.2 如果你更改了默认配置( `In_the_meantime_start_the_client_as_admin = False` ),启动服务端会自动以用户权限启动客户端。

7. 在线翻译基于 [DeepLX](https://github.com/OwO-Network/DeepLX) ,过于频繁的请求可能导致 IP 被封,如果出现 429 错误,则表示你的 IP 被 DeepL 暂时屏蔽了,请不要在短时间内频繁请求
9.2 如果你更改了默认配置( `In_the_meantime_start_the_client = False` 表示一键启动功能 禁用,启动服务端不会启动客户端),新建 `start_server_gui.exe` 的快捷方式,将服务端的快捷方式放到 `shell:startup` 目录下只会在开机时自动启动服务端。客户端不会被启动。

8. 当某程序以管理员权限运行,可能会出现有识别结果但是却无法在那个程序输入文字的状况,例如:`Listary``PixPin` 等。这是因为 `start_client_gui.exe` 默认以用户权限运行客户端,运行在用户权限的程序无法控制管理员权限的程序。你可以关闭用户权限运行的客户端,尝试使用 `start_client_gui_admin.exe` 以管理员权限运行客户端
9.3 如果你更改了默认配置( `In_the_meantime_start_the_client = False` ),新建 `start_client_gui.exe` 的快捷方式,将客户端的快捷方式放到 `shell:startup` 目录下只会在开机时自动启动客户端。服务端不会被启动。不要再添加客户端 `start_client_gui_admin.exe` 的快捷方式。

9. 添加开机自启动的方法:新建 `start_server_gui.exe``start_client_gui.exe` 的快捷方式(如果你希望开机自启动时以管理员权限运行客户端,创建 `start_client_gui_admin.exe` 的快捷方式),将他们的快捷方式放到 `shell:startup` 目录下即可
9.4 如果你更改了默认配置( `In_the_meantime_start_the_client = False` ),新建 `start_client_gui_admin.exe` 的快捷方式,将客户端的快捷方式放到 `shell:startup` 目录下只会在开机时自动以管理员权限启动客户端。服务端不会被启动。不要再添加客户端 `start_client_gui.exe` 的快捷方式。

# 🤓 源码运行

Expand Down

0 comments on commit 578eedd

Please sign in to comment.