diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6f07d74 --- /dev/null +++ b/LICENSE @@ -0,0 +1,20 @@ +The MIT License (MIT) + +Copyright (c) 2023 The Continuous Desk Authors + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index c14d4eb..c113199 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,67 @@ # Continuous Desk -[Chinese](README_CN.md) / [English](README.md) - -Make works continuous +#### More than remote desktop ---- +[Chinese](README_CN.md) / [English](README.md) ![example](https://github.com/dijunkun/continuous-desk/assets/29698109/f3153e28-751e-477c-b4e3-ac2384d3370f) ----- +# Intro -Continuous Desk is a lightweight cross-platform remote desktop software. It allows multiple users to remotely control the same computer at the same time. In addition to desktop image transmission, it also supports end-to-end voice transmission, providing collaboration capabilities on the basis of remote desktop. +Continuous Desk is a lightweight cross-platform remote desktop. It allows multiple users to remotely control the same computer at the same time. In addition to desktop image transmission, it also supports end-to-end voice transmission, providing collaboration capabilities on the basis of remote desktop. -Continuous Desk is an experimental application of Projectx real-time audio and video transmission library. Projectx is a lightweight cross-platform real-time audio and video transmission library. It has basic capabilities such as network traversal ([RFC5245](https://datatracker.ietf.org/doc/html/rfc5245)), video software and hardware encoding/decoding (H264), audio encoding/decoding ([Opus](https://github.com/xiph/opus)), signaling interaction, and network congestion control ([TCP over UDP](https://libnice.freedesktop.org/)). +Continuous Desk is an experimental application of [Projectx](https://github.com/dijunkun/projectx) real-time communications library. Projectx is a lightweight cross-platform real-time communications library. It has basic capabilities such as network traversal ([RFC5245](https://datatracker.ietf.org/doc/html/rfc5245)), video softwar/hardware encoding/decoding (H264), audio encoding/decoding ([Opus](https://github.com/xiph/opus)), signaling interaction, and network congestion control ([TCP over UDP](https://libnice.freedesktop.org/)). +## Usage -Among them, video encoding/decoding supports: -- OpenH264 software encoding/decoding -- NvCodec hardware encoding/decoding -- FFmpeg software encoding/decoding +Enter the remote desktop ID in the 'REMOTE ID' field on the menu bar, and click 'Connect' button to initiate the remote connection. + +![usage1](https://github.com/dijunkun/continuous-desk/assets/29698109/80099485-f2db-4f09-9fb2-e811d87265dc) + +If the remote desktop is set with a connection password, the local end needs to enter the correct password to initiate the remote connection. If the password is incorrect, an "Incorrect password" alert will appear in the status bar. + +![incorrect password](https://github.com/dijunkun/continuous-desk/assets/29698109/0b16d21a-baa6-49c1-9d87-5e80978dd345) + +After connection successfully established, the status bar will display the message "ClientConnected." + +![success](https://github.com/dijunkun/continuous-desk/assets/29698109/9c4f6604-2b1b-47b6-9c73-21c5026d1f26) + +## How to build + +Requirements： +- [xmake](https://xmake.io/#/guide/installation) +- [cmake](https://cmake.org/download/) +- [vcpkg](https://vcpkg.io/en/getting-started) + +Following packages need to be installed on Linux： + +``` +sudo apt-get install -y nvidia-cuda-toolkit libxcb-randr0-dev libxcb-xtest0-dev libxcb-xinerama0-dev libxcb-shape0-dev libxcb-xkb-dev libxcb-xfixes0-dev libxcb-shm0-dev libxv-dev libasound2-dev libsndio-dev libasound2-dev libpulse-dev +``` + +Commands +``` +git clone https://github.com/dijunkun/continuous-desk + +cd continuous-desk + +git submodule init + +git submodule update + +xmake b remote_desk +``` +Run +``` +# Windows/MacOS +xmake r remote_desk + +# root privileges are required on Linux +./remote_desk +``` + +## LICENSE + +Continuous Desk is licenced under MIT, and some third-party libraries are distributed under their licenses. ----- diff --git a/README_CN.md b/README_CN.md index 41ac333..2c200a1 100644 --- a/README_CN.md +++ b/README_CN.md @@ -1,22 +1,67 @@ # Continuous Desk +#### 不止远程桌面 + +---- [English](README.md) / [中文](README_CN.md) -Make works continuous +![example](https://github.com/dijunkun/continuous-desk/assets/29698109/f3153e28-751e-477c-b4e3-ac2384d3370f) ----- +## 简介 -![Alt text](example.PNG) +Continuous Desk 是一个轻量级的跨平台远程桌面软件。它允许多个用户在同一时间远程操控同一台电脑。除桌面图像传输外，它还支持端到端的语音传输，在远程桌面基础上提供额外的协作能力。 ----- +Continuous Desk 是 [Projectx](https://github.com/dijunkun/projectx) 实时音视频传输库的实验性应用。Projectx 是一个轻量级的跨平台实时音视频传输库。它具有网络透传（[RFC5245](https://datatracker.ietf.org/doc/html/rfc5245)），视频软硬编解码（H264），音频编解码（[Opus](https://github.com/xiph/opus)），信令交互，网络拥塞控制（[TCP over UDP](https://libnice.freedesktop.org/)）等基础能力。 -Continuous Desk 是一个轻量化的跨平台远程桌面软件。它允许多个用户在同一时间远程操控同一台电脑。除桌面图像传输外，它还支持端到端的语音传输，在远程桌面的基础上提供协作能力。 -Continuous Desk 是 Projectx 实时音视频传输库的实验性应用。Projectx 是一个轻量化的跨平台实时音视频传输库。它具有网络透传（[RFC5245](https://datatracker.ietf.org/doc/html/rfc5245)），视频软硬编解码（H264），音频编解码（[Opus](https://github.com/xiph/opus)），信令交互，网络拥塞控制（[TCP over UDP](https://libnice.freedesktop.org/)）等基础能力。 +## 使用 -其中，视频编解码支持： -- OpenH264 软编软解 -- NvCodec 硬编硬解 -- FFmpeg 软编软解 +在菜单栏“REMOTE ID”处输入远端桌面的ID，点击“Connect”即可发起远程连接。 ----- +![usage1](https://github.com/dijunkun/continuous-desk/assets/29698109/80099485-f2db-4f09-9fb2-e811d87265dc) + +如果远端桌面设置了连接密码，则本端需填写正确的连接密码才能成功发起远程连接。密码错误时，状态栏会出现“Incorrect password”告警提示。 + +![incorrect password](https://github.com/dijunkun/continuous-desk/assets/29698109/0b16d21a-baa6-49c1-9d87-5e80978dd345) + +连接成功建立后，状态栏会有“ClientConnected”相关字样。 + +![success](https://github.com/dijunkun/continuous-desk/assets/29698109/9c4f6604-2b1b-47b6-9c73-21c5026d1f26) + +## 编译 + +依赖： +- [xmake](https://xmake.io/#/guide/installation) +- [cmake](https://cmake.org/download/) +- [vcpkg](https://vcpkg.io/en/getting-started) + +Linux环境下需安装以下包： + +``` +sudo apt-get install -y nvidia-cuda-toolkit libxcb-randr0-dev libxcb-xtest0-dev libxcb-xinerama0-dev libxcb-shape0-dev libxcb-xkb-dev libxcb-xfixes0-dev libxcb-shm0-dev libxv-dev libasound2-dev libsndio-dev libasound2-dev libpulse-dev +``` + +编译命令 +``` +git clone https://github.com/dijunkun/continuous-desk + +cd continuous-desk + +git submodule init + +git submodule update + +xmake b remote_desk +``` +运行 +``` +# Windows/MacOS +xmake r remote_desk + +# Linux下需使用root权限运行 +./remote_desk +``` + +## 许可证 + +Continuous Desk 使用 MIT 许可证，其中使用到的第三方库根据自身许可证进行分发。 \ No newline at end of file diff --git a/example.PNG b/example.PNG deleted file mode 100644 index 61c61e2..0000000 Binary files a/example.PNG and /dev/null differ