doc(README): update README and add README-zh

README-zh.md

@@ -0,0 +1,65 @@
+# Scrcpy-mask
+
+为了实现电脑控制安卓设备，本人使用 Tarui + Vue 3 + Rust 开发了一款跨平台桌面客户端。该客户端能够提供可视化的鼠标和键盘按键映射配置。通过按键映射实现了实现类似安卓模拟器的多点触控操作，具有毫秒级响应速度。该工具可广泛用于电脑控制安卓设备玩手游等等，提供流畅的触控体验。
+
+本项目仅实现了 Scrcpy 控制协议，**不提供投屏功能**。因为投屏会存在延迟和模糊问题，本项目另辟蹊径，直接放弃投屏，而使用透明的蒙版显示窗口背后的内容（可以使用 AVD 、手机厂商提供的低延迟投屏等），从根本上杜绝了 Scrcpy 的投屏体验差的问题。
+
+## 特性
+
+- [x] 有线、无线连接安卓设备
+- [x] 启动并连接 Scrcpy 服务端
+- [x] 实现 Scrcpy 控制协议
+- [x] 鼠标和键盘按键映射
+- [x] 可视化编辑按键映射配置
+- [x] 按键映射配置的导入与导出
+- [x] 更新检查
+- [x] 在按键映射和插入文本之间切换
+- [x] 国际化
+- [ ] 手柄按键映射
+- [ ] 更好的宏
+- [ ] 通过 WebSocket 提供外部接口
+- [ ] 帮助文档
+
+## 视频演示
+
+- [M 系列 Mac 电脑玩王者，暃排位实录，使用 Android Stuido 模拟器和开源 Scrcpy Mask 按键映射工具-哔哩哔哩](https://b23.tv/q6iDW1w)
+- [自制跨平台开源项目 Scrcpy Mask ，像模拟器一样用键鼠控制任意安卓设备！以 M 系列芯片 MacBook 打王者为例-哔哩哔哩](https://b23.tv/gqmriXr)
+- [如何用 PC 控制安卓手机打王者？只要思想不滑坡，办法总比困难多！-哔哩哔哩](https://b23.tv/dmUOpff)
+- [M 芯片 Mac 怎么用 Android Studio 模拟器打王者？这是 Up 耗时数个月给出的答案-哔哩哔哩](https://b23.tv/ckJgyK5)
+
+## 截图
+
+- 设备控制
+
+![](https://pic.superbed.cc/item/6637190cf989f2fb975b6162.png)
+
+- 可视化编辑按键映射配置
+
+![](https://pic.superbed.cc/item/66371911f989f2fb975b62a3.png)
+
+- 游戏控制
+
+![](https://pic.superbed.cc/item/66373c8cf989f2fb97679dfd.png)
+
+## 基本使用
+
+1. 从 [releases](https://github.com/AkiChase/scrcpy-mask/releases) 中安装适合你系统平台的软件包
+2. 确认你的安卓设备类型
+   1. 对于手机或平板电脑等物理设备
+      1. 你需要自己解决投屏的问题。推荐使用设备品牌的官方投屏方式，这样一般延迟最小。
+      2. 通过 USB 或无线方式在设备上启用 ADB 调试，然后将其连接到电脑。
+   2. 对于模拟器，不仅不需要投屏，而且模拟器通常默认启用 ADB 有线调试。所以几乎不用操作就能获得最好的体验。
+3. 启动软件并导航到设备页面。
+   1. 在可用的设备中查找你的设备(如果未找到，请自行搜索如何为安装设备启用 ADB 调试)。
+   2. 右击你的设备并选择“获取屏幕大小”。根据获得的屏幕尺寸为参考，正确输入设备的宽度和高度。注意：如果宽度或高度不正确 (例如，在纵向和横向模式下这两个参数是颠倒的)，所有触摸操作将被忽略，但是不会有任何错误消息。
+   3. 再次右击设备并选择“控制此设备”。
+4. 导航到设置页面->蒙版设置，将蒙版的宽度和高度设置为设备大小的一定倍数，以确保蒙版大小合适。
+5. 导航到蒙版页面，你可以在其中看到一个完全透明的蒙版区域。接下来，调整并移动模拟器窗口或投屏窗口，让其内容区域与透明蒙版区域完全对齐。
+6. 导航到键映射页面，切换或编辑键映射配置。
+7. 返回到蒙版界面，开始使用吧！
+
+## 贡献
+
+如果你对这个项目感兴趣，欢迎提 PR 或 Issue。但我的时间和精力有限，所以可能无法全部及时处理。
+
+[![Star History Chart](https://api.star-history.com/svg?repos=AkiChase/scrcpy-mask&type=Date)](https://star-history.com/#AkiChase/scrcpy-mask&Date)

README.md

@@ -1,8 +1,8 @@
 # Scrcpy-mask
 
-A Scrcpy client in Rust & Tarui aimed at providing mouse and key mapping to control Android device.
+To achieve computer control of Android devices, I developed a cross-platform desktop client using Tarui + Vue 3 + Rust. This client provides visual mouse and keyboard mapping configuration, enabling multi-touch operations similar to Android emulators through key mapping, with millisecond-level response time. This tool can be widely used for controlling Android devices from computers to play mobile games, providing a smooth touch experience.
 
-Due to the delay and blurred image quality of the mirror screen. This project found another way, directly abandoned the mirror screen, and instead used a transparent mask to display the screen content behind the window, which fundamentally put an end to the delay in casting the screen.
+This project only implements the Scrcpy control protocol and **does not provide Screen mirroring**. Because screen mirroring may involve latency and blurriness issues, this project takes a different approach by directly abandoning screen mirroring and instead using a transparent mask to display the content behind the window (which can be AVD, low-latency screen mirroring provided by your phone manufacturers, etc.), Completely eliminates the problem of poor screen casting experience inherent in Scrcpy.
 
 ## Features
 
@@ -14,7 +14,7 @@ Due to the delay and blurred image quality of the mirror screen. This project fo
 - [x] Key mapping config import and export
 - [x] Update check
 - [x] Switch between key mapping and input-text box
-- [ ] Internationalization (i18n)
+- [x] Internationalization (i18n)
 - [ ] Gamepad key mapping
 - [ ] Better macro support
 - [ ] Provide external interface through websocket
@@ -45,14 +45,14 @@ Due to the delay and blurred image quality of the mirror screen. This project fo
 
 1. Install software suitable for your system platform from [releases](https://github.com/AkiChase/scrcpy-mask/releases)
 2. Identify your Android device type
-	1. For physical devices like phones or tablets
+   1. For physical devices like phones or tablets
-		1. You need to solve the problem of screen casting on your own. Recommend using the official screen mirror method of your device brand to achieve the minimum delay
+      1. You need to solve the problem of screen casting on your own. Recommend using the official screen mirror method of your device brand to achieve the minimum delay
-		2. Enable ADB debugging on your device via USB or wirelessly, then connect it to your computer.
+      2. Enable ADB debugging on your device via USB or wirelessly, then connect it to your computer.
-	2. For emulator, you don't need screen mirror, and emulator generally default to enabling ADB wired debugging. So this is the best way for game, I think.
+   2. For emulator, you don't need screen mirror, and emulator generally default to enabling ADB wired debugging. So this is the best way for game, I think.
 3. Launch the software and navigate to the Device page.
-	1. Find your device among the available devices (if not found, please search for how to enable ADB debugging for your device).
+   1. Find your device among the available devices (if not found, please search for how to enable ADB debugging for your device).
-	2. Right-click on your device and choose "Get Screen Size". Use the obtained screen size as a reference and enter the device's width and height correctly. Note: If the width or height is incorrect (for example, they are reversed in portrait and landscape modes), all touch operations will be ignored, but no error message will appear.
+   2. Right-click on your device and choose "Get Screen Size". Use the obtained screen size as a reference and enter the device's width and height correctly. Note: If the width or height is incorrect (for example, they are reversed in portrait and landscape modes), all touch operations will be ignored, but no error message will appear.
-	3. Right-click on your device again and choose "Control this device".
+   3. Right-click on your device again and choose "Control this device".
 4. Navigate to the Settings page -> Mask Settings, and set the width and height of the mask to a certain multiple of the device's size to ensure the mask size is appropriate.
 5. Navigate to the Mask page where you can see a transparent mask. Next, adjust and move your emulator window or screen mirroring window to align the displayed content area with the transparent mask area.
 6. Navigate to the Key mapping page and switch or edit the key mapping configs.
@@ -62,4 +62,4 @@ Due to the delay and blurred image quality of the mirror screen. This project fo
 
 If you are interested in this project, you are welcome to submit pull request or issue. But my time and energy is limited, so I may not be able to deal with it all.
 
-[![Star History Chart](https://api.star-history.com/svg?repos=AkiChase/scrcpy-mask&type=Date)](https://star-history.com/#AkiChase/scrcpy-mask&Date)
+[![Star History Chart](https://api.star-history.com/svg?repos=AkiChase/scrcpy-mask&type=Date)](https://star-history.com/#AkiChase/scrcpy-mask&Date)