README.md

Rabbit Remote Control

Author: Kang Lin kl222@126.com

---

🇨🇳 中文

---

• Introduction
  • Screenshot
    • Multiple style
  • Project repository position
• Functions
  • Supported operating system
  • Supported multiple languages
  • Supported protocols
    • Remote control protocols
    • Network protocols
  • Function list
  • Plugins
  • Full Documentation
• Status
• Sponsorship and Donations
• Contribution
• Road map
• Download
• Change log
• Development
  • Compilation
    • Compiling for Linux
    • Compiling for Windows
• License Agreement

---

Introduction

Rabbit Remote Control is a open-source, 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.

It include remote desktop, remote terminal, player etc remote control functions.

Screenshot

Main window	Recent list menu	Connect	Work

Multiple style

Default style	Black-Green style	Black style	White style

Project repository position

• Main repository: https://github.com/KangLin/RabbitRemoteControl
• Mirror repository:
  • sourceforge: https://sourceforge.net/projects/rabbitremotecontrol/
  • gitlab: https://gitlab.com/kl222/RabbitRemoteControl
  • launchpad: https://launchpad.net/rabbitremotecontrol
  • gitee: https://gitee.com/kl222/RabbitRemoteControl
  • kde: https://invent.kde.org/kanglin/RabbitRemoteControl
  • bitbucket: https://bitbucket.org/kl222/rabbitremotecontrol

Functions

Supported operating system

• Windows 7 SP1 and later
• Unix/Linux
• Android
• mac os
• IPHONE
• WINCE

See: Qt5, Qt6

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)

• Remote desktop

	Windows	Unix/linux	Android	MAC	IPHONE	WINCE
vnc	✓	✓	✓	✓
RDP	✓	✓	……	✓
Spice
Scrcpy

• Terminal

	Windows	Unix/linux	Android	MAC	IPHONE	WINCE
Terminal		✓
SSH		✓
TELNET		✓

• File Transfer

	Windows	Unix/linux	Android	MAC	IPHONE	WINCE
FTP
SFTP

• Tool

	Windows	Unix/linux	Android	MAC
Player	✓	✓	✓	✓
Wake on lan	✓	✓	✓	✓
Screenshot	✓	✓	❌	✓

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

Supported multiple languages

• English
• Chinese
  • Simplified Chinese
  • Traditional Chinese

Supported protocols

Remote control protocols

• RFB(Remote frame buffer) is also called VNC(Virtual Network Computing): https://github.com/rfbproto/rfbproto
• RDP(Remote desktop protocol): https://github.com/FreeRDP/FreeRDP/wiki/Reference-Documentation
• Spice: https://www.spice-space.org/
• SSH: https://www.rfc-editor.org/info/rfc4251
  • libssh
• TELNET: https://www.rfc-editor.org/info/rfc318
• Terminal
• scrcpy: https://github.com/Genymobile/scrcpy
• FTP(File Transfer Protocol): https://www.rfc-editor.org/info/rfc959

Network protocols

• Peer-to-Peer (P2P) protocol
  • ICE (Interactive Connectivity Establishment): RFC 8445
  • STUN: RFC 5389
  • TURN(Traversal Using Relays around NAT): RFC 5766
• Proxy
  • socks
  • http
  • Peer-to-Peer (P2P) proxy protocol: #7

Function list

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

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

	Proxy	P2P
RabbitVNC	✓	✓
TigerVNC	✓	✓
LibVNC
FreeRDP

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

Plugins

• FreeRDP
• VNC
  • RabbitVNC
  • TigerVnc
  • LibVNCServer

Full Documentation

• Development documentation online
  • sourceforge
  • github.io
• Compilation documentation

Status

Build status

master	develop

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://gitlab.com/kl222/RabbitCommon/-/raw/master/Src/Resource/image/Contribute.png
• https://sourceforge.net/p/rabbitcommon/code/ci/master/tree/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 same BUG）
    • Specific protocol support, see: Supported protocol
    • Peer-to-Peer (P2P) remote control protocol, see requirements for details: #7
  • Server
    • Server framework
    • Specific protocol support, see: Supported protocol
    • Peer-to-Peer (P2P) remote control protocol, see requirements for details: #7
• Peer-to-Peer (P2P)remote control protocol, see requirements for details: #7
• File Transfer Protocol(FTP)

	Server	Client	Desktop	Clipboard	File	Audio	Redirection	P2P	Proxy	Terminal
RabbitVNC	✓	✓	✓	✓		❌	❌	✓	✓
TigerVNC	✓	✓	✓	✓		❌	❌	✓	✓
LibVNCServer	✓	✓	✓	✓		❌	❌
RDP	✓	✓	✓	✓	……	✓	……			❌
Spice							❌
Scrcpy							❌
Terminal		⭕	❌	✓		❌	❌
SSH		⭕	❌	✓		❌	❌
TELNET		⭕	❌	✓	❌	❌	❌
FTP			❌			❌	❌
SFTP			❌			❌	❌

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

• The development of common remote control protocol clients and some servers has been completed. It has preliminary practical functions, and needs to be tried by small partners, find bugs, 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.

• Peer-to-Peer (P2P) remote control is finished. which is also a feature of this project. See requirements for details: #7

Download

• Change log
• Semantic Versioning: https://semver.org/

• Latest Release:

  • 
  • 
  • 
  • 
  • 

• Current version: v0.0.27

  • Windows: Supported WINDOWS 7 and later version
    • Win64
      • Install package: RabbitRemoteControl_v0.0.27_qt6.5.2_win64_msvc2019_64_Setup.exe
        • Download from Github
        • Download from sourceforge
      • MD5SUM file: RabbitRemoteControl_v0.0.27_qt6.5.2_win64_msvc2019_64_Setup.exe.md5sum
        • Download from Github
        • Download from sourceforge
  • Ubuntu:

    • rabbitremotecontrol_0.0.27_amd64.deb

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

      • Download from github
      • Download from sourceforge

    • MD5SUM file: rabbitremotecontrol_0.0.27_amd64.deb.md5sum

      • Download from github
      • Download from sourceforge

Development

Development documentation online

• sourceforge
• github.io

Compilation

• Compiling for Linux
• Compiling for 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.