README-cn.md

iController v0.6.2

English | 简体中文

   

1 描述

一个在 Windows 或 macOS (见下方注释) 主机上运行的简易服务器，同一局域网下的手机连接后可以通过网页实现触摸板和键盘的操作。

1.1 功能

• 触摸板
• 鼠标按钮（左，右，中）
• 鼠标滚轮
• 方向键
• 键盘
• 音量滑块

2 使用方法

2.1 下载

从 Release 页面下载免安装程序。

目前程序是CLI交互的，启动时，你可以手动提供端口号，程序会自动检测确保端口可用且无冲突，启动后使用手机浏览器通过电脑的局域网IP地址和端口访问。

2.2 macOS

Important

由于 v0.6.0 开始引入了额外的功能，macOS 上通过免安装的方式难以完美支持，因此暂时不再提供 macOS 版本的打包文件。目前 v0.5.1 将会是 macOS 一个临时的最终版本，后续版本将会首先在 Windows 上推出进行测试。

从 Release v0.5.1 页面下载免安装程序。

注意：对于 macOS，由于权限问题，直接下载的 iController 无法被系统信任，目前唯一的解决方法是打开 设置 > 隐私与安全性 > 开发者工具 > 终端 这一开关。

3 开发

3.1 开发环境

• Node.js v16.20.2
• Python v3.10.10

3.2 前端

开发

npm run react

Compile

npm run build

3.3 后端

Windows

对于 Python 环境，推荐使用 ./bin/dev-pyvenv/newenv.bat 创建一个新的虚拟环境。然后运行：

venv\Scripts\activate

进入虚拟环境。或添加环境到IDE。

macOS

对于 Python 环境，推荐使用 ./bin/dev-pyvenv/newenv.sh 创建一个新的虚拟环境。然后运行：

source venv/bin/activate

进入虚拟环境。或添加环境到IDE。

3.4 编译 / 打包

推荐直接运行 ./bin/packaging/ 中的 win-onefile.bat / mac-onefile.sh 打包应用。注意，经过测试，部分 Python v3.10.x 版本可能会出现玄学报错。只有 Python v3.10.10 测试稳定。

4 使用的技术栈

• Node.js
  • React.js
    • Material UI (https://github.com/mui/material-ui)
    • Prime React (https://github.com/primefaces/primereact)
    • React Color (https://github.com/casesandberg/react-color)
  • Lodash (https://github.com/lodash/lodash)
• Python
  • (≤v0.4.5) Flask (https://github.com/pallets/flask)
  • (v0.5.0+) Quart (https://github.com/pallets/quart)
    • Hypercorn (https://github.com/pgjones/hypercorn)
  • PyAutoGUI (https://github.com/asweigart/pyautogui)
  • Pycaw (https://github.com/AndreMiras/pycaw)
  • Psutil (https://github.com/giampaolo/psutil)
  • PyInstaller (https://github.com/pyinstaller/pyinstaller)

5 许可证

MPL 2.0

Copyright © 2024-PRESENT GitHub@Mehver/iController , All Rights Reserved.