Skip to content

Commit a30d8fe

Browse files
committed
Refactor project structure and documentation
- Removed local scrcpy binaries from .gitignore and updated README.md to reflect that scrcpy is now bundled with the repository. - Revised CONTRIBUTING.md to clarify the usage of the bundled scrcpy binaries and updated instructions for refreshing them. - Enhanced error messaging in server.js to specify the presence of the scrcpy-win64/ folder for ADB binaries.
1 parent 48dcf1c commit a30d8fe

4 files changed

Lines changed: 8 additions & 16 deletions

File tree

.gitignore

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,6 @@ node_modules/
55
recordings/
66
screenshots/
77

8-
# Ignore local scrcpy binaries (downloaded via UI or npm run update:scrcpy)
9-
scrcpy-win64/
10-
118
# Ignore zip archives and logs
129
*.zip
1310
*.log

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ By contributing, you agree that your contributions will be licensed under the sa
4747
- Keep changes scoped — one logical change per pull request when possible.
4848
- Prefer fixing root causes over adding workarounds.
4949
- Do not commit secrets, `.env` files, local device caches, recordings, or screenshots.
50-
- Do not commit the `scrcpy-win64/` binaries — users download them through the app or `npm run update:scrcpy`.
50+
- `scrcpy-win64/` is bundled with the repo. Use `npm run update:scrcpy` to refresh binaries when needed.
5151

5252
## Brand assets
5353

README.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626

2727
## Features
2828

29-
- **One-click setup**Download and extract official scrcpy Windows binaries from the UI
29+
- **Bundled scrcpy**Official Windows scrcpy + adb binaries included in `scrcpy-win64/`
3030
- **Wireless pairing wizard** — Handles the `adb pair` handshake so you never touch a terminal
3131
- **Device discovery** — Auto-scan the network for wireless debugging endpoints + manual rescan
3232
- **Full mirroring controls** — Resolution, bitrate, FPS, stay awake, turn screen off, always on top, touch indicators, audio toggle
@@ -74,24 +74,20 @@ Open **[http://localhost:3000](http://localhost:3000)** in your browser.
7474

7575
## Usage
7676

77-
### 1. Download scrcpy
78-
79-
On first launch, click **Download Scrcpy** in the dashboard. Binaries are saved to `scrcpy-win64/` (gitignored — not committed to the repo).
80-
81-
### 2. Pair your phone (first time only)
77+
### 1. Pair your phone (first time only)
8278

8379
1. On your phone: *Wireless debugging → Pair device with pairing code*
8480
2. In Flect: open the **Pairing Wizard** tab
8581
3. Enter the IP, port, and 6-digit code shown on your phone
8682
4. Click **Pair Device**
8783

88-
### 3. Connect wirelessly
84+
### 2. Connect wirelessly
8985

9086
1. On your phone's main **Wireless debugging** screen, note the IP and port (this port differs from the pairing port)
9187
2. Enter them in the **Connect** section
9288
3. Click **Connect**
9389

94-
### 4. Start mirroring
90+
### 3. Start mirroring
9591

9692
1. Select your device in **Active ADB Devices**
9793
2. Adjust settings (quality preset, stay awake, record, etc.)
@@ -108,7 +104,6 @@ Recordings land in `./recordings`. Preview captures land in `./screenshots`.
108104
| `npm start` | Start the Flect web dashboard |
109105
| `npm run check` | Syntax-check server, client, and scripts |
110106
| `npm run update:scrcpy` | Update `scrcpy-win64/` to the latest official release |
111-
| `npm run generate:assets` | Regenerate favicons and PWA icons from `public/images/logo.png` |
112107

113108
<br>
114109

@@ -163,9 +158,9 @@ flect/
163158
│ ├── update-scrcpy.js
164159
│ └── generate-brand-assets.js
165160
├── run.bat # Windows one-click launcher
161+
├── scrcpy-win64/ # Bundled scrcpy + adb binaries
166162
├── recordings/ # Session MP4s (gitignored)
167-
├── screenshots/ # Preview PNGs (gitignored)
168-
└── scrcpy-win64/ # Downloaded binaries (gitignored)
163+
└── screenshots/ # Preview PNGs (gitignored)
169164
```
170165

171166
<br>

server.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -364,7 +364,7 @@ function runAdbCommand(args) {
364364
return new Promise((resolve, reject) => {
365365
const paths = getPaths();
366366
if (!paths.exists) {
367-
return reject(new Error('Scrcpy / ADB binaries not found. Please download them first.'));
367+
return reject(new Error('Scrcpy / ADB binaries not found. Ensure the scrcpy-win64/ folder is present.'));
368368
}
369369
const adbCmd = `"${paths.adb}" ${args}`;
370370
logMessage(`Running: adb ${args}`);

0 commit comments

Comments
 (0)