From 614b8cb9371ad48b53de2344c6b0c644222ca5d7 Mon Sep 17 00:00:00 2001 From: BlueGlassBlock Date: Thu, 1 Feb 2024 18:57:10 +0800 Subject: [PATCH] docs: document missing serial mode --- README.md | 14 ++++++++++++++ README.zh.md | 14 ++++++++++++++ 2 files changed, 28 insertions(+) diff --git a/README.md b/README.md index 930badc..b756c22 100644 --- a/README.md +++ b/README.md @@ -79,6 +79,20 @@ By default, an extra 30px is added to the radius to compensate for this. You can change compensation radius with config `touch.radius_compensation`, which could be positive or negative. +### Serial Mode + +Toucca support communicating with serial port to control the game. + +You need to bind COM3 and COM5, COM4 and COM6 using [com0com](https://sourceforge.net/projects/com0com/), enabling buffer overrun at the meantime. + +Read more about configuration at the [WACVR](https://github.com/xiaopeng12138/WACVR#serial-not-recommended) project. + +To enable it, simply set `touch.enable` to `0` to disable the hook-based touch input. + +### Disable Toucca + +If you want to disable toucca, please don't set `touch.enable` to `0`, instead, set the `path` to a different file. + ## Build Yourself I have only tried building on Windows since the game is Windows only. :) diff --git a/README.zh.md b/README.zh.md index 7859a43..8528316 100644 --- a/README.zh.md +++ b/README.zh.md @@ -77,6 +77,20 @@ relative_threshold = 1 # 需要跨越的物理环数才能切换到下一个相 你可以通过 `touch.radius_compensation` 来调整这个值。 +### 串口模式 + +Toucca 支持使用串口模式与游戏通信。 + +你需要使用 [com0com](https://sourceforge.net/projects/com0com/) 绑定 COM3 和 COM5,COM4 和 COM6,并同时启用缓冲区溢出。 + +你可以在 [WACVR](https://github.com/xiaopeng12138/WACVR#serial-not-recommended) 项目中了解更多关于配置的信息。 + +将 `touch.enable` 设置为 `0` 会禁用基于钩子的触摸输入并自动启用串口输入。 + +# 禁用 Toucca + +如果你想禁用 toucca,请不要将 `touch.enable` 设置为 `0`,而是将 `touch.path` 设置为一个不同的文件。 + ## 自行构建 我只在 Windows 上进行过构建(毕竟原框体是基于 Windows 的),不过 Linux 应该也能构建。