Skip to content

Latest commit

 

History

History
90 lines (64 loc) · 3.29 KB

README.md

File metadata and controls

90 lines (64 loc) · 3.29 KB
Raw

Maintenance License: MIT Twitter: jeeanribeiro

Simple multiplayer remote pairing web app built with RobotJS for controlling mouse/keyboard and Socket.io for sharing mouse/keyboard events and signaling to start a simple-peer connection via WebRTC to stream the host screen (needs VPN or LAN to work).

🏠 Homepage

Usage

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 for more details.

Planned features

  • npx
  • Electron app with easy usability

Author

👤 Jean Ribeiro

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2020 Jean Ribeiro.
This project is MIT licensed.

This README was generated with ❤️ by readme-md-generator