Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jeeanribeiro/simple-remote-pair
Simple multiplayer remote pairing web app
https://github.com/jeeanribeiro/simple-remote-pair
javascript nodejs robotjs socket-io webrtc
Last synced: about 2 months ago
JSON representation
Simple multiplayer remote pairing web app
- Host: GitHub
- URL: https://github.com/jeeanribeiro/simple-remote-pair
- Owner: jeeanribeiro
- License: mit
- Created: 2020-04-25T20:24:42.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-14T03:09:48.000Z (3 months ago)
- Last Synced: 2024-10-15T18:03:26.136Z (3 months ago)
- Topics: javascript, nodejs, robotjs, socket-io, webrtc
- Language: JavaScript
- Homepage: https://jeeanribeiro.github.io/simple-remote-pair/
- Size: 1.06 MB
- Stars: 20
- Watchers: 1
- Forks: 3
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> Simple multiplayer remote pairing web app built with [RobotJS](https://github.com/octalmage/robotjs) for controlling mouse/keyboard and [Socket.io](https://github.com/socketio/socket.io) for sharing mouse/keyboard events and signaling to start a [simple-peer](https://github.com/feross/simple-peer) connection via WebRTC to stream the host screen (needs VPN or LAN to work).
### 🏠 [Homepage](https://jeeanribeiro.github.io/simple-remote-pair/)
## Usage
```sh
git clone https://github.com/jean-m-ribeiro/simple-remote-pair.git
cd simple-remote-pair
npm install
npm run start
```
If you are the host access `http://localhost:3000/#host` in your browser, if not, just access by using the host IP in VPN or LAN, it will looks like `http://192.168.15.60:3000`
## Dependencies
Please ensure you have the required dependencies before installing:
* Windows
* windows-build-tools npm package (`npm install --global --production windows-build-tools` from an elevated PowerShell or CMD.exe)
* Mac
* Xcode Command Line Tools.
* Linux
* Python (v2.7 recommended, v3.x.x is not supported).
* make.
* A C/C++ compiler like GCC.
* libxtst-dev and libpng++-dev (`sudo apt-get install libxtst-dev libpng++-dev`).
Install node-gyp using npm:
```
npm install -g node-gyp
```
Then build:
```
node-gyp rebuild
```
See the [node-gyp readme](https://github.com/nodejs/node-gyp#installation) for more details.
## Planned features
- npx
- Electron app with easy usability
## Author
👤 **Jean Ribeiro**
* Website: https://jeanribeiro.dev
* Twitter: [@jeeanribeiro](https://twitter.com/jeeanribeiro)
* Github: [@jeeanribeiro](https://github.com/jeeanribeiro)
* LinkedIn: [@jeeanribeiro](https://linkedin.com/in/jeeanribeiro)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/jean-m-ribeiro/simple-pair/issues). You can also take a look at the [contributing guide](https://github.com/jean-m-ribeiro/simple-pair/blob/master/CONTRIBUTING.md).
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
Copyright © 2020 [Jean Ribeiro](https://github.com/jean-m-ribeiro).
This project is [MIT](https://github.com/jean-m-ribeiro/simple-pair/blob/master/LICENSE) licensed.
***
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_