Metadata-Version: 2.1
Name: echo-client
Version: 0.2.2b2
Summary: 
Author: Rickyxrc
Author-email: rickyxrc@outlook.com
Requires-Python: >=3.9,<4
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: prompt-toolkit (>=3.0.43,<4.0.0)
Requires-Dist: pypinyin (>=0.50.0,<0.51.0)
Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
Requires-Dist: rich (>=13.7.0,<14.0.0)
Requires-Dist: websockets (>=12.0,<13.0)
Description-Content-Type: text/markdown

## 简介

Echo-client 是一个为无声系虚拟主播设计的命令行终端，不过也可以用于快速制作视频中的字幕

注意：本项目仍在活跃开发中，下方的所有信息可能会发生改变，请以代码为准。

## 安装

首先您需要正确地在 OBS 中安装 Echo-live。

然后定位到 `config.js` 的 websocket 这部分，将 `websocket_enable` 改为 `true`。

下方的 `websocket_url` 中请填写服务端的 ip 地址与端口号。（如果您在一台电脑上同时运行 OBS 和本程序则 ip 可以写 `127.0.0.1`）

```js
        // 启用 WebSocket
        // * 如果没人要求您这么做，请不要动它。
        // * 广播模式下启用 WebSocket 可连接至服务器以从第三方软件获取消息。
        // * 可从服务器接收的消息和广播消息一致，发送的消息须使用类似于 JSON.stringify 的方法序列化。
        // * 详见：https://sheep-realms.github.io/Echo-Live-Doc/dev/broadcast/
        websocket_enable: true,
        // WebSocket 连接地址
        // websocket_url: 'ws://192.168.1.12:3000', // iPad
        websocket_url: 'ws://127.0.0.1:3000',
```

如果您在两台设备上分别运行 OBS 和本程序，请务必将 `server.py` 的 `host = "127.0.0.1"` 修改为 `host = "0.0.0.0"`（监听局域网）。

如果您有 python 环境，请使用如下命令安装（不推荐，还在开发）

```sh
pip install echo-client
```

## 使用

您需要正确完成“安装”章节。

正确运行程序，控制台输出应该类似这样（有颜色）：

```
已经在 127.0.0.1:3000 监听 websocket 请求，等待 echo 客户端接入...
tips: 如果没有看到成功的连接请求，可以尝试刷新一下客户端
用户输入模块加载成功，您现在可以开始输入命令了，客户端连接后会自动执行！
请输入命令:
```

然后刷新 OBS 中的预览窗口，您应该可以看见 websocket 连接成功的提示。

命令应该怎么写呢？

请看项目根目录下的 message_sample.txt，这是一个包含了目前可以使用的所有格式的示例文件。

有关该文件的更多信息请点开查看。

## 配置

还没写。


