更新README
This commit is contained in:
37
README.md
37
README.md
@@ -12,7 +12,7 @@ Demo: http://cc-web-edit.liulikeji.cn
|
||||
|
||||
- **远程文件管理**:实时浏览、编辑和管理 CC:Tweaked 计算机中的文件
|
||||
- **Monaco 编辑器**:基于 VS Code 的 Monaco 编辑器,提供专业的代码编辑体验
|
||||
- **HTTP 通信**:基于 HTTP 协议的可靠通信
|
||||
- **低延迟通信**:基于 HTTP 长轮询 + 请求挂起机制,模拟 WebSocket 的低延迟传输
|
||||
|
||||
### 文件操作
|
||||
|
||||
@@ -27,7 +27,7 @@ Demo: http://cc-web-edit.liulikeji.cn
|
||||
- **自动命令生成**:根据 URL 参数自动生成连接命令
|
||||
- **一键复制**:点击即可复制连接命令到剪贴板
|
||||
- **房间管理**:支持创建和加入房间
|
||||
- **轮询机制**:HTTP 轮询确保连接稳定性
|
||||
- **实时通信**:高效的请求挂起机制确保接近实时的响应
|
||||
|
||||
## 🚀 快速开始
|
||||
|
||||
@@ -127,7 +127,7 @@ cp -r dist/* ../PyServer/static/
|
||||
- **二进制文件**:非文本文件会显示为 `[binary]`,无法在线编辑
|
||||
- **单客户端**:目前主要支持一个网页端和一个 CC 客户端的配对使用
|
||||
- **文件大小**:上传文件限制为 1MB
|
||||
- **轮询延迟**:HTTP 轮询机制可能有轻微延迟(默认 2 秒)
|
||||
- **低延迟**:HTTP 长轮询机制提供接近实时的响应体验
|
||||
|
||||
### 计划功能
|
||||
|
||||
@@ -140,9 +140,17 @@ cp -r dist/* ../PyServer/static/
|
||||
|
||||
- `POST /api/room` - 创建房间
|
||||
- `POST /api/frontend/send` - 前端发送消息到客户端
|
||||
- `POST /api/frontend/receive` - 前端接收来自客户端的消息
|
||||
- `POST /api/frontend/receive` - 前端接收来自客户端的消息(长轮询)
|
||||
- `POST /api/client/send` - 客户端发送消息到前端
|
||||
- `POST /api/client/receive` - 客户端接收来自前端的消息
|
||||
- `POST /api/client/receive` - 客户端接收来自前端的消息(长轮询)
|
||||
|
||||
### 通信机制
|
||||
|
||||
**长轮询 + 请求挂起**:
|
||||
|
||||
- 客户端请求挂起最长达 295 秒,直到有消息到达
|
||||
- 当有新消息时立即响应,实现低延迟传输
|
||||
- 服务器端控制请求超时,避免不必要的轮询
|
||||
|
||||
### 消息类型
|
||||
|
||||
@@ -186,27 +194,24 @@ A: 确保 CC 客户端已成功连接,然后刷新文件列表
|
||||
**Q: 文件上传失败**
|
||||
A: 检查文件大小是否超过 1MB 限制
|
||||
|
||||
**Q: 操作响应较慢**
|
||||
A: 默认轮询间隔为 1 秒,可通过调整代码中的轮询间隔改善
|
||||
**Q: 消息传输延迟**
|
||||
A: 服务器使用长轮询机制,响应通常在毫秒级别
|
||||
|
||||
## 📄 技术说明
|
||||
|
||||
- **后端**:Python + HTTP Server
|
||||
- **后端**:Python + HTTP Server + 长轮询机制
|
||||
- **前端**:Vue 3 + TypeScript + Monaco Editor
|
||||
- **通信**:HTTP 轮询机制实现双向通信
|
||||
- **通信**:HTTP 长轮询 + 请求挂起实现低延迟通信
|
||||
- **客户端**:CC:Tweaked + HTTP
|
||||
|
||||
## 🤝 开发说明
|
||||
|
||||
<<<<<<< HEAD
|
||||
该项目目前主要支持远程代码编辑功能,使用 HTTP 协议替代 WebSocket,提高了兼容性和部署便利性。远程控制台功能计划在后续版本中开发。
|
||||
=======
|
||||
该项目目前主要支持远程代码编辑功能,远程控制台功能计划在后续版本中开发。
|
||||
该项目使用创新的 HTTP 长轮询 + 请求挂起机制来模拟 WebSocket 的低延迟传输特性,为远程代码编辑提供了近乎实时的响应体验。
|
||||
|
||||
远程控制台功能计划在后续版本中开发。
|
||||
|
||||
## 贡献
|
||||
|
||||
你可以制作适配不同平台的客户端然后共享其代码
|
||||
|
||||
欢迎提交issues
|
||||
|
||||
>>>>>>> d3faa4b74bc0eeac9a272c4d8a348d98a48dad7e
|
||||
欢迎提交 issues
|
||||
|
||||
Reference in New Issue
Block a user