mouse-vm 1.0.4 → 1.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +96 -0
  2. package/package.json +3 -2
package/README.md ADDED
@@ -0,0 +1,96 @@
1
+ # 📱 Virtual Mouse & Live Desktop Keyboard (`mouse-vm`)
2
+
3
+ Transform your smartphone or tablet into a wireless trackpad, live keyboard, file transfer hub, and desktop controller for your Windows PC over WiFi.
4
+
5
+ ![npm version](https://img.shields.io/npm/v/mouse-vm?color=brightgreen)
6
+ ![license](https://img.shields.io/npm/l/mouse-vm)
7
+ ![Platform](https://img.shields.io/badge/Platform-Windows%20PC-blue)
8
+ ![PWA Ready](https://img.shields.io/badge/PWA-Installable-cyan)
9
+ ![Tech Stack](https://img.shields.io/badge/Stack-Node.js%20|%20Express%20|%20Vanilla%20JS-green)
10
+
11
+ ---
12
+
13
+ ## ✨ Features
14
+
15
+ - 📱 **Progressive Web App (PWA)**: Installable directly onto iOS & Android home screens for a full-screen, native app feel with offline caching.
16
+ - ⌨️ **Live Keyboard & Desktop TextPad**:
17
+ - **Live Auto-Typing**: Click the single text box and type on your phone; keystrokes are transmitted in real-time to your desktop's active window.
18
+ - **Desktop TextPad**: Draft or paste full multi-line paragraphs/notes and send the entire block to your PC with one tap.
19
+ - **Quick Keycodes & Modifiers**: Dedicated buttons for `Enter ↵`, `Backspace ⌫`, `Space ␣`, `Tab ⇥`, `Esc`, navigation arrow keys (`▲`, `▼`, `◄`, `►`), and PC shortcuts (`Ctrl+A`, `Ctrl+C`, `Ctrl+V`, `Ctrl+Z`).
20
+ - 🖱️ **Ultra-Smooth Trackpad**:
21
+ - 1:1 cursor movement with Windows DPI scaling awareness.
22
+ - Multi-touch gestures (Tap to click, Drag to move, Two-finger vertical scrolling).
23
+ - Left & Right click buttons with haptic visual feedback.
24
+ - Hardware-like scroll wheel slider.
25
+ - 📁 **Bidirectional File Transfer**:
26
+ - Easily transfer files between your PC and mobile device.
27
+ - **Upload to PC**: Select files on your phone to instantly upload to your PC (up to 200MB limit).
28
+ - **Download to Mobile**: View files hosted on your PC and download them directly to your phone.
29
+ - **Terminal Shortcuts**: Manage transfers directly from the PC terminal.
30
+ - 🔑 **Secure Connections**:
31
+ - 4-digit pairing PIN authentication for secure pairing over WiFi.
32
+
33
+ ---
34
+
35
+ ## 🚀 Quick Start
36
+
37
+ ### 1. Global Installation
38
+ Install `mouse-vm` globally via npm:
39
+ ```bash
40
+ npm install -g mouse-vm
41
+ ```
42
+
43
+ ### 2. Start Desktop Server
44
+ Launch the server using `mouse-vm` (or `npx mouse-vm`):
45
+ ```bash
46
+ mouse-vm
47
+ ```
48
+
49
+ Console will display your Local IP, Web/WS port, and **Connect PIN**:
50
+ ```text
51
+ ================================================================
52
+ [+] VIRTUAL MOUSE & KEYBOARD SERVER ACTIVE
53
+ ================================================================
54
+ [+] Mobile IP (Wi-Fi): 192.168.1.15
55
+ [+] Web & WS Port: 5000
56
+ [*] CONNECT CODE (PIN): 4261
57
+ [+] File Transfer Directory: C:\project\mouseirtual\packages\vm\transfers
58
+ ================================================================
59
+ [SCAN ME] QR CODE FOR MOBILE INSTANT CONNECT:
60
+ (QR Code Image)
61
+ ================================================================
62
+ - Press Ctrl+U (or Alt+U / Cmd+U) for file selection dialog
63
+ - Press Ctrl+V (or Alt+V / Cmd+V) to paste copied file/text
64
+ - Press Ctrl+S (or Alt+S / Cmd+S) to open save folder
65
+ ================================================================
66
+ ```
67
+
68
+ ### 3. Connect from Mobile Phone
69
+ 1. Connect your phone to the same WiFi network as your PC.
70
+ 2. Scan the QR code displayed in the terminal, or open `http://<PC-IP>:5000` in your mobile browser.
71
+ 3. Your device should automatically pair using the generated PIN.
72
+
73
+ ---
74
+
75
+ ## 💻 PC Terminal Shortcuts
76
+
77
+ While the server is running, you can use the following keyboard shortcuts in your terminal:
78
+ - `Ctrl+U` (or `Alt+U`): Open a file selection dialog on your PC to choose files to send to your mobile device.
79
+ - `Ctrl+V` (or `Alt+V`): Paste files or text copied on your PC clipboard directly into the file transfer folder.
80
+ - `Ctrl+S` (or `Alt+S`): Open the file transfer directory on your PC to view or save received files.
81
+ - `q` or `Ctrl+C`: Stop the server.
82
+
83
+ ---
84
+
85
+ ## ⚙️ Advanced Usage (CLI Flags)
86
+
87
+ You can customize the server behavior using command-line arguments:
88
+ - **Custom Port**: `mouse-vm --port=8080` (Default: 5000)
89
+ - **Custom PIN**: `mouse-vm --pin=1234` (Default: Randomly generated 4-digit PIN)
90
+ - **Custom File Transfer Path**: `mouse-vm --transfer-path="C:\Users\Name\Desktop"`
91
+
92
+ ---
93
+
94
+ ## 📄 License
95
+
96
+ MIT © [abhi2007](https://github.com/ap20089p-ai/mousenpm)
package/package.json CHANGED
@@ -1,12 +1,13 @@
1
1
  {
2
2
  "name": "mouse-vm",
3
- "version": "1.0.4",
3
+ "version": "1.0.5",
4
4
  "description": "Transform your smartphone or tablet into a high-performance wireless trackpad, live keyboard, and desktop controller for Windows PC over WiFi.",
5
5
  "main": "server.js",
6
6
  "files": [
7
7
  "bin",
8
8
  "server.js",
9
- "static"
9
+ "static",
10
+ "README.md"
10
11
  ],
11
12
  "bin": {
12
13
  "vm2do": "bin/cli.js",