# RabbitRemoteControl
**Repository Path**: ayrz2010/RabbitRemoteControl
## Basic Information
- **Project Name**: RabbitRemoteControl
- **Description**: 支持多操作系统，跨平台，跨协议，跨互联网的远程控制软件。此库仅为GITHUB库的镜像。
- **Primary Language**: C++
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: https://github.com/KangLin/RabbitRemoteControl
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 48
- **Created**: 2021-11-04
- **Last Updated**: 2024-06-13
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# 
[Rabbit Remote Control](https://github.com/KangLin/RabbitRemoteControl)
Author: Kang Lin
-----------------------------------------------------------------------
- Project home: https://kanglin.github.io/RabbitRemoteControl/
- Project position:
- Main repository: https://github.com/KangLin/RabbitRemoteControl
- Mirror repository: https://gitlab.com/kl222/RabbitRemoteControl
- Language
- [:cn: 中文](README_zh_CN.md)
- [Status](#Status)
- [Introduction](#Introduction)
- [Sponsorship and Donations](#Sponsorship-and-Donations)
- [Contribution](#Contribution)
- [Download](#Download)
- [Development](#Development)
+ [Build](#Build)
- [Linux](docs/Compile/BuildLinux.md)
- [Windows](docs/Compile/BuildWindows.md)
- [Change log](ChangeLog.md)
- [License Agreement](#License-Agreement)
-----------------------------------------------------------------------
### Status
[](https://github.com/KangLin/RabbitRemoteControl/stars)
[](https://github.com/KangLin/RabbitRemoteControl/forks)
[](https://github.com/KangLin/RabbitRemoteControl/issues)
[](https://github.com/KangLin/RabbitRemoteControl/releases)
[](https://github.com/KangLin/RabbitRemoteControl/releases)
- [](https://ci.appveyor.com/project/KangLin/rabbitremotecontrol)
#### Github actions
| | master | develop |
|:---:|:-----------:|:------------:|
|Linux|[](https://github.com/kanglin/rabbitremotecontrol/actions)|[](https://github.com/kanglin/rabbitremotecontrol/actions)
|Windows|[](https://github.com/kanglin/rabbitremotecontrol/actions)|[](https://github.com/kanglin/rabbitremotecontrol/actions)
|Android|[](https://github.com/kanglin/rabbitremotecontrol/actions)|[](https://github.com/kanglin/rabbitremotecontrol/actions)
### Introduction
Rabbit Remote Control is a cross-platform, multi-protocol remote control software.
**Allows you to use any device and system in anywhere and remotely manage any device and system in any way**.
#### Supported operating system (See: [https://doc.qt.io/qt-5/supported-platforms.html](https://doc.qt.io/qt-5/supported-platforms.html))
- [x] Windows
- [x] Unix/Linux
- [x] Android
- [ ] mac os
- [ ] IPHONE
- [ ] WINCE
I have no devices so I did not compile and test. Please test by yourself if you have devices.
Interested and capable friends are welcome to participate in the development of the project.
If you want to donate the developed devices for me, please contact: (email: kl222@126.com)
#### Supported protocols
##### Remote control protocols
- [x] VNC (Virtual Network Computing): [RFB("remote framebuffer"): https://github.com/rfbproto/rfbproto](https://github.com/rfbproto/rfbproto)
- [x] Remote desktop protocol: [RDP: https://github.com/FreeRDP/FreeRDP/wiki/Reference-Documentation](https://github.com/FreeRDP/FreeRDP/wiki/Reference-Documentation)
- [ ] [Spice: https://www.spice-space.org/](https://www.spice-space.org/)
- [x] [SSH]()
- [x] [TELNET: http://www.faqs.org/rfcs/rfc855.html](http://www.faqs.org/rfcs/rfc855.html)
- [x] Terminal
- [ ] scrcpy: [https://github.com/Genymobile/scrcpy](https://github.com/Genymobile/scrcpy)
| |Windows |Unix/linux |Android |MAC |IPHONE |WINCE |
|--------|------------------|------------------|------------------|------------------|------------------|------------------|
|vnc |:heavy_check_mark:|:heavy_check_mark:| | | | |
|RDP |:heavy_check_mark:|:heavy_check_mark:| | | | |
|Spice | | | | | | |
|SSH | |:heavy_check_mark:| | | | |
|Terminal| |:heavy_check_mark:| | | | |
|TELNET | |:heavy_check_mark:| | | | |
|P2P | | | | | | |
|Scrcpy | | | | | | |
##### Network protocols
- [ ] Custom p2p protocol
- [x] Proxy
+ [x] socks
+ [ ] http
+ [x] Custom p2p proxy protocol: [https://github.com/KangLin/RabbitRemoteControl/issues/7](https://github.com/KangLin/RabbitRemoteControl/issues/7)
| | Proxy | P2P |
|-------------|------------------|------------------|
|TigerVnc |:heavy_check_mark:| |
|LibVNC | | |
|FreeRDP | | |
### Sponsorship and Donations
If this software is useful to you, or you like it, please donate and support the author. Thank you!
[](https://github.com/KangLin/RabbitCommon/raw/master/Src/Resource/image/Contribute.png "donation")
If it cannot be displayed, please open:
https://gitee.com/kl222/RabbitCommon/raw/master/Src/Resource/image/Contribute.png
### Contribution
- [Discussions](https://github.com/KangLin/RabbitRemoteControl/discussions)
- [Issues](https://github.com/KangLin/RabbitRemoteControl/issues)
- [Contributors](https://github.com/KangLin/RabbitRemoteControl/graphs/contributors)
If you're wondering how could you help, fear not, there are plenty of ways:
Some of them are:
* [Donation](#Donation) - Provide funds and devices for this project :smile:
* Spread the good word about [RabbitRemoteControl](https://github.com/KangLin/RabbitRemoteControl) to make it more popular :smile:
* Have an opinion? Make sure to voice it in the [Discussions](https://github.com/KangLin/RabbitRemoteControl/discussions) that need it :wink:
* Fixing easy [Issues](https://github.com/KangLin/RabbitRemoteControl/issues) or [Issues](https://github.com/KangLin/RabbitRemoteControl/issues) that need help. Make sure to read
[Contributing](#Contribution) first though :wink:
* Testing and [reporting bugs](https://github.com/KangLin/RabbitRemoteControl/issues)
* Translating, it's easy :smile:
* Reviewing and testing pull requests – you don't need to be able to code to
do that :wink:
* Distribute this program to various operating systems
- Linux
+ Ubuntu, Debian
+ Redhat
+ openSUSE
+ FreeBSD
+ CentOS
+ Arch Linux
- Unix
- Windows 10 mall
- Android
* Be finished [unsupported protocols](#Supported-protocols)
### Download
Release: [https://github.com/KangLin/RabbitRemoteControl/releases](https://github.com/KangLin/RabbitRemoteControl/releases)
- Windows: Supported WINDOWS 7 and later version
+ Install package: [RabbitRemoteControl-Setup-v0.0.8.exe](https://github.com/KangLin/RabbitRemoteControl/releases/download/v0.0.8/RabbitRemoteControl-Setup-v0.0.8.exe)
+ No need to install package: [RabbitRemoteControl_v0.0.8.zip](https://github.com/KangLin/RabbitRemoteControl/releases/download/v0.0.8/RabbitRemoteControl_v0.0.8.zip)
- Ubuntu:
+ Ubuntu 20.04: [rabbitremotecontrol_0.0.8_amd64_Ubuntu-20.04.deb](https://github.com/KangLin/RabbitRemoteControl/releases/download/v0.0.8/rabbitremotecontrol_0.0.8_amd64_Ubuntu-20.04.deb)
+ Ubuntu 18.04: [rabbitremotecontrol_0.0.8_amd64_Ubuntu-18.04.deb](https://github.com/KangLin/RabbitRemoteControl/releases/download/v0.0.8/rabbitremotecontrol_0.0.8_amd64_Ubuntu-18.04.deb)
### Road map
- [x] Support common existing remote control protocols
- [x] Client
- [x] Client frame
- [x] Remote desktop
- [x] Terminal（Linux implemented，but it is has a smae BUG）
- [x] Specific protocol support, see: [Supported protocol](#Supported-protocols)
- [x] Server
- [x] Server framework
- [x] Specific protocol support, see: [Supported protocol](#Supported-protocols)
- [ ] Custom point-to-point remote control protocol, see requirements for details: https://github.com/KangLin/RabbitRemoteControl/issues/7
At present, the development of common remote control protocol client has been completed,
and it has preliminary practical functions.
It is necessary for small partners to try it out, find BUG,
and put forward suggestions that can be more convenient to use in practical applications.
For terminal remote control, because qtermwidget only supports LINUX/UNIX, it needs to support other platforms.
The next level of work is to solve point-to-point remote control,
which is also a feature of this project.
See requirements for details: https://github.com/KangLin/RabbitRemoteControl/issues/7
### Development
#### Dependent
##### Tools
- [Qt](qt.io)
- C/C++ compiler
+ gcc/g++
+ MSVC
- [CMake](https://cmake.org/)
- Automake、Autoconf、Make
- Git
##### Dependent libraries
- [x] [MUST] RabbitCommon：https://github.com/KangLin/RabbitCommon
- [x] VNC
+ [x] [Optional] LibVNCServer: https://github.com/LibVNC/libvncserver
+ [x] [Optional] TigerVNC: https://github.com/KangLin/tigervnc
- [x] [Optional] FreeRDP: https://github.com/FreeRDP/FreeRDP
- [x] [Optional] [SSH]
+ [x] LIBSSH: https://www.libssh.org
+ [ ] LIBSSH2: https://www.libssh2.org/ https://github.com/libssh2/libssh2
- [x] [Optional] QTermWidget: https://github.com/lxqt/qtermwidget
- [x] [Optional] libtelnet: https://github.com/seanmiddleditch/libtelnet
- [ ] [Optional] scrcpy: [https://github.com/Genymobile/scrcpy](https://github.com/Genymobile/scrcpy)
- [x] [Optional] libdatachannel: [https://github.com/paullouisageneau/libdatachannel](https://github.com/paullouisageneau/libdatachannel)
- [x] [OPTIONAL] QXmpp: https://github.com/qxmpp-project/qxmpp
- [x] [Optional] QtService: https://github.com/KangLin/qt-solutions/
#### Build
- [Linux](docs/Compile/BuildLinux.md)
- [Windows](docs/Compile/BuildWindows.md)
### [License Agreement](License.md "License.md")
Please abide by this agreement and the license agreement of [dependent library](#Dependent-libraries),
and thank the author of [dependent library](#Dependent-libraries) and [tools](#Tools).