Rabbit Remote Control

Author: Kang Lin kl222@126.com

---

---

🇨🇳 中文

---

• Introduction
• Build status
• Sponsorship and Donations
• Contribution
• Road map
• Download
• Development
  • Build
    • Linux
    • Windows
• Change log
• License Agreement

---

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.

Screenshot

Main window	Recent list menu	Connect

Stargazers over time

Project repository position

• Project home: https://kanglin.github.io/RabbitRemoteControl/
• Project position:
  • Main repository: https://github.com/KangLin/RabbitRemoteControl
  • Mirror repository:
    • sourceforge: https://sourceforge.net/projects/rabbitremotecontrol/
    • gitlab: https://gitlab.com/kl222/RabbitRemoteControl
    • gitee: https://gitee.com/kl222/RabbitRemoteControl

Functions

	Server	Client	Clipboard	File	Audio	P2P	Proxy	Terminal
RDP	✓	✓	⭕					❌
RFB	……	✓	⭕		❌	……	……
Spice
Scrcpy
Terminal		⭕	✓	❌	❌
TELNET		⭕	✓	❌	❌
SSH		⭕	✓		❌
FTP					❌

Legend: ✓ : completed; … : working; ⭕ : not completed; Empty: not started; ❌: not supported

Supported operating system (See: https://doc.qt.io/qt-5/supported-platforms.html)

• Windows
• Unix/Linux
• 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

• VNC (Virtual Network Computing): RFB("remote framebuffer"): https://github.com/rfbproto/rfbproto
• Remote desktop protocol: RDP: https://github.com/FreeRDP/FreeRDP/wiki/Reference-Documentation
• Spice: https://www.spice-space.org/
• SSH
• TELNET: http://www.faqs.org/rfcs/rfc855.html
• Terminal
• scrcpy: https://github.com/Genymobile/scrcpy

	Windows	Unix/linux	Android	MAC	IPHONE	WINCE
vnc	✓	✓
RDP	✓	✓
Spice
SSH		✓
Terminal		✓
TELNET		✓
Scrcpy

Legend: ✓ : completed; … : working; ⭕ : not completed; Empty: not started; ❌: not supported

Network protocols

• Custom p2p protocol
  • ICE
  • STUN
  • TURN
• Proxy
  • socks
  • http
  • Custom p2p proxy protocol: KangLin#7

	Proxy	P2P
RabbitVNC	✓	✓
TigerVNC	✓	✓
LibVNC
FreeRDP

Legend: ✓ : completed; … : working; ⭕ : not completed; Empty: not started; ❌: not supported

Build status

• 

Github actions

	master	develop
Linux
Windows
Android

Sponsorship and Donations

If this software is useful to you, or you like it, please donate and support the author. Thank you!

If it cannot be displayed, please open: https://gitee.com/kl222/RabbitCommon/raw/master/Src/Resource/image/Contribute.png

Contribution

• Mailing list
  • Developer rabbitremotecontrol-developer@lists.sourceforge.net
  • Discuss rabbitremotecontrol-discuss@lists.sourceforge.net
• Issues
• 
• Discussions
• Contributors: Thank contributors

If you're wondering how could you help, fear not, there are plenty of ways:

Some of them are:

• Donation - Provide funds and devices for this project 😄
  • The project is need server with public IP
• Spread the good word about RabbitRemoteControl to make it more popular 😄
• Have an opinion? Make sure to voice it in the Discussions that need it 😉
• Fixing easy Issues or Issues that need help. Make sure to read Contributing first though 😉
• Testing and reporting bugs
• Translating, it's easy 😄
• Reviewing and testing pull requests – you don't need to be able to code to do that 😉
• 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

Road map

• Support common existing remote control protocols
  • Client
    • Client frame
      • Remote desktop
      • Terminal（Linux implemented，but it is has a smae BUG）
    • Specific protocol support, see: Supported protocol
    • Custom point-to-point remote control protocol, see requirements for details: KangLin#7
  • Server
    • Server framework
    • Specific protocol support, see: Supported protocol
    • Custom point-to-point remote control protocol, see requirements for details: KangLin#7
• Custom point-to-point remote control protocol, see requirements for details: KangLin#7

	Server	Client	Clipboard	File	Audio	P2P	Proxy	Terminal
RabbitVNC	✓	✓	⭕		❌	⭕	⭕
TigerVNC	✓	✓	⭕		❌	⭕	⭕
LibVNCServer	✓	✓	⭕		❌
RDP	✓	✓	⭕					❌
Spice
SSH		⭕	✓		❌
Terminal		⭕	✓		❌
TELNET		⭕	✓	❌	❌
Scrcpy

Legend: ✓ : completed; … : working; ⭕ : not completed; Empty: not started; ❌: not supported

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: KangLin#7

Download

Semantic Versioning: https://semver.org/

• Latest Release:

  • 
  • 
  • 

• Current version:

  • Windows: Supported WINDOWS 7 and later version
    • Install package: RabbitRemoteControl_setup_v0.0.18.exe
      • Download from Github
      • Download from sourceforge
    • No need to install package: RabbitRemoteControl_v0.0.18.zip
      • Download from Github
      • Download from sourceforge
  • Ubuntu:

    • Ubuntu 20.04: rabbitremotecontrol_0.0.18_amd64_Ubuntu-20.04.deb

      sudo apt install ./rabbitremotecontrol_0.0.18_amd64_Ubuntu-20.04.deb
      
      # If you're on an older Linux distribution, you will need to run this instead:
      # sudo dpkg -i rabbitremotecontrol_0.0.18_amd64_Ubuntu-20.04.deb
      # sudo apt-get install -f # Install dependencies
      

      • Download from github
      • Download from sourceforge

    • Ubuntu 18.04: rabbitremotecontrol_0.0.18_amd64_Ubuntu-18.04.deb

      sudo apt install ./rabbitremotecontrol_0.0.18_amd64_Ubuntu-18.04.deb
      
      # If you're on an older Linux distribution, you will need to run this instead:
      # sudo dpkg -i rabbitremotecontrol_0.0.18_amd64_Ubuntu-18.04.deb
      # sudo apt-get install -f # Install dependencies
      

      • Download from github
      • Download from sourceforge

Development

Doxyen documentation

Dependent

Tools

• Qt
• C/C++ compiler
  • gcc/g++
  • MSVC
• CMake
• Automake、 Autoconf、 Make
• Git

Dependent libraries

• [MUST] RabbitCommon：https://github.com/KangLin/RabbitCommon
• VNC
  • [Optional] RabbitVNC: https://github.com/KangLin/RabbitVNC
  • [Optional] LibVNCServer: https://github.com/LibVNC/libvncserver
  • [Optional] TigerVNC: https://github.com/KangLin/tigervnc
• [Optional] FreeRDP: https://github.com/FreeRDP/FreeRDP
• [Optional] [SSH]
  • LIBSSH: https://www.libssh.org
  • LIBSSH2: https://www.libssh2.org/ https://github.com/libssh2/libssh2
• [Optional] QTermWidget: https://github.com/lxqt/qtermwidget
• [Optional] libtelnet: https://github.com/seanmiddleditch/libtelnet
• [Optional] scrcpy: https://github.com/Genymobile/scrcpy
• [Optional] libdatachannel: https://github.com/paullouisageneau/libdatachannel
• [OPTIONAL] QXmpp: https://github.com/qxmpp-project/qxmpp
• [Optional] QtService: https://github.com/KangLin/qt-solutions/

Build

• Linux
• Windows

License Agreement

Please abide by the License Agreement of this project and the license agreement of the dependent library, and thank the authors of dependent library and tools.