An advanced but easy-to-use remote desktop application with cross-platform support
npm install electron-remote-control
Remote Control is a minimal remote desktop app built on top of Electron. Designed to ease things up for better and faster technical support with low effort in mind.
---
Key Features •
How To Use •
Download •
Credits •
License
_
* Instant Connection
* Control over connected devices
- Be able to control the keyboard and mouse of your connected devices.
* Device History
- Connect to known devices with one click.
* File Sharing across multiple devices
* Smart Bar with commands
- Navigate faster by typing commands in the upper smart bar.
* Device Monitoring for CPU, Memory and WLAN Usage
* Script Execution with Node.js Integration
* Script Store for non-programmers
* Dark/Light Mode
* Feedback Writing and Viewing
* Full screen mode
- Work distraction free.
* Auto Launch
- Remote Control launches automatically after you start your device.
* Auto Update
- Remote Control automatically updates when new updates are released.
* Custom WebRTC Server
- Configure Remote Control in order to use your custom WebRTC server.
* Debug Mode
- Activate debug mode to help us fix issues faster.
* Cross platform
- Windows, macOS and Linux ready.
* In-built Tutorial Page
To install this package, ensure that Node.js (which includes npm) is installed on your system. You can use either npm or yarn to install the package:
Using npm:
``bash`Initialize your project and install Remote Control
$ npm init -y
$ npm install electron-remote-control
Using yarn:
`bash`Initialize your project and install Remote Control
$ yarn init -y
$ yarn add electron-remote-control
#### Move project
Moving the project is automatically done when using other methods.
`js
const { moveProject } = require("electron-remote-control");
moveProject()
.then(({ exitCode, stdout, stderr }) => {
// handle results
})
.catch(({ exitCode, stdout, stderr }) => {
// handle error
});
`
#### Building your own client
To build and open your own installable, you'll need Python 3 installed on your computer.
During the creation of a new client, all running instances of the application are closed, the application is silently uninstalled, the previous build folder is removed, and a new build is silently created, installed, and launched, all without any user interaction required.
`js
const { buildClient } = require("electron-remote-control");
buildClient()
.then(({ exitCode, stdout, stderr }) => {
// handle results
})
.catch(({ exitCode, stdout, stderr }) => {
// handle error
});
`
#### Hosting your own server
The Remote Control server listens on port :3000.
`js
const { hostServer } = require("electron-remote-control");
hostServer()
.then(({ exitCode, stdout, stderr }) => {
// handle results
})
.catch(({ exitCode, stdout, stderr }) => {
// handle error
});
`
For more information, including deprecated methods, check our full documentation.
#### Commands in the Root Directory
| Command | Bin (npx) | Script (npm run) |
|----------------|---------------------------------|------------------------------------|
| Test | $ npx test / $ npx t | $ npm run test / $ npm run t |$ npx moveProject
| Move Project | / $ npx mp| $ npm run moveProject / $ npm run mp |$ npx buildClient
| Build Client | / $ npx bc| $ npm run buildClient / $ npm run bc |$ npx hostServer
| Host Server | / $ npx hs | $ npm run hostServer / $ npm run hs |
#### Commands in the Client Directory
Change to the client directory:
`bash`
$ cd client
| Command | Bin (npx) | Script (npm run) |
|--------------------|--------------------------------------|------------------------------------|
| Test | $ npx test / $ npx t | $ npm run test / $ npm run t |$ npx build -mwl
| Build for All (MWL) | / $ npx b -mwl | $ npm run buildMWL / $ npm run bmwl |$ npx build --win
| Build for Windows | / $ npx b --win | $ npm run buildWindows / $ npm run bw |$ npx build --mac
| Build for macOS | / $ npx b --mac | $ npm run buildMacOS / $ npm run bm |$ npx build --linux
| Build for Linux | / $ npx b --linux| $ npm run buildLinux / $ npm run bl |
> Note: macOS builds can only be generated on macOS systems.
#### Commands in the Server Directory
Change to the server directory:
`bash`
$ cd server
| Command | Bin (npx) | Script (npm run) |
|----------------|------------------------------|------------------------------------|
| Test | $ npx test / $ npx t | $ npm run test / $ npm run t |$ npx host
| Host Server | / $ npx h | $ npm run host / $ npm run h |
> Note: If you're using Linux Bash for Windows, see this guide or run node` from the command prompt.
You can download the latest installable version of Remote Control for Windows, macOS and Linux.
This software uses the following open source packages:
- Node.js
- Electron
- electron-builder
- PeerServer
- @jitsi/robotjs
- socket.io
- socket.io-client
- Express.js
- Express Docs
- Crossnote
- Express Docs - An easy-to-use documentation site creator
- Youtube Offline - A lightweight YouTube video downloader
- Appify - A tiny tool that allows you to turn your website into an app
- Meetings - A meetings app with lots of features
- DinoChess - A chess platform for chess lovers
This project is licensed under the Apache License, Version 2.0. See the LICENSE file for more details.
---
> dinoscape.com ·
> GitHub @DinoscapeProgramming ·
> Scratch @Dinoscape