Skip to content

Installation and Setup

Babul Raj Singh edited this page Jul 26, 2026 · 1 revision

Installation & Setup

Voyager mirrors an Android phone to your Windows PC using scrcpy — over USB, or wirelessly with no cable at all. This page gets the background daemon running from source. There's no installer yet, so this assumes basic comfort with a terminal, but no prior knowledge of scrcpy, adb, or Flutter.

Prerequisites

You need three tools installed and reachable from a plain terminal:

Tool Check it works Get it
Dart SDK dart --version https://dart.dev/get-dart
Android platform-tools (adb) adb version https://developer.android.com/tools/releases/platform-tools
scrcpy scrcpy --version https://github.com/Genymobile/scrcpy

Voyager doesn't bundle these yet — that's a planned installer feature, not built yet — so all three need to already be on your system PATH before you start.

You'll also need:

  • An Android phone with USB debugging enabled: Settings → About phone → tap "Build number" 7 times to unlock Developer options → Developer options → USB debugging.
  • A USB cable.
  • For wireless testing later: either the phone's own hotspot, or the phone and PC on the same Wi-Fi network.

Clone the repo

git clone https://github.com/ba6ul/voyager.git
cd voyager

Only the main branch is public right now. It contains the background daemon (packages/daemon), the adb client (packages/core), and the daemon↔UI protocol (packages/ipc). The Flutter tray UI isn't published yet — everything on this wiki runs from a terminal only.

Install dependencies

This is a small monorepo — each package manages its own dependencies separately, so pub get needs to run once per package:

cd packages\core
dart pub get
cd ..\ipc
dart pub get
cd ..\daemon
dart pub get
cd ..\..

Run the test suite

A quick sanity check before touching a real phone — if these fail on a fresh clone, something's wrong with the code, not your phone or setup:

cd packages\core
dart test
cd ..\daemon
dart test
cd ..\..

Both should finish with every test passing.

First run

cd packages\daemon
dart run bin\daemon.dart

Expect output like:

config: C:\Users\<you>\AppData\Roaming\scrcpy_gui\config.json
adb: adb | scrcpy: scrcpy | autoLaunch: true
ipc: listening on 127.0.0.1:38765
starting adb server if needed...
adb server protocol version: 0029
watching for devices | commands: w=wireless h=handoff u=usb l=list q=quit

That last line is the entire interface for now — see the Command Reference page for what each letter does.

Configuration and the wireless-device cache both live at %APPDATA%\scrcpy_gui\. Delete that folder at any time to reset to a clean first-run state.

Plug in your phone

With the daemon running, plug the phone in via USB and accept the "Allow USB debugging" prompt on the phone if it appears. Within a couple of seconds it should be detected and a mirror window should open on its own — no commands needed for this part. Head to the Testing Guide page next to try wireless and handoff.

Clone this wiki locally