scrcpy/doc/windows.md
Romain Vimont f12590ed08 Rework README and documentation
The README.md page is HUGE. Split it up.

Also document audio forwarding and improve installation instructions for
each platform and user documentation.

PR #3774 <https://github.com/Genymobile/scrcpy/pull/3774>
2023-03-12 02:04:58 +01:00

2.3 KiB

On Windows

Install

Download the [latest release]:

and extract it.

Alternatively, you could install it from packages manager, like Chocolatey:

choco install scrcpy
choco install adb    # if you don't have it yet

or Scoop:

scoop install scrcpy
scoop install adb    # if you don't have it yet

See build.md to build and install the app manually.

Run

Scrcpy is a command line application: it is mainly intended to be executed from a terminal with command line arguments.

To open a terminal at the expected location, double-click on open_a_terminal_here.bat in your scrcpy directory, then type your command. For example, without arguments:

scrcpy

or with arguments (here to disable audio and record to file.mkv):

scrcpy --no-audio --record=file.mkv

Documentation for command line arguments is available:

To start scrcpy directly without opening a terminal, double-click on one of these files:

  • scrcpy-console.bat: start with a terminal open (it will close when scrcpy terminates, unless an error occurs);
  • scrcpy-noconsole.vbs: start without a terminal (but you won't see any error message).

Avoid double-clicking on scrcpy.exe directly: on error, the terminal would close immediately and you won't have time to read any error message (this executable is intended to be run from the terminal). Use scrcpy-console.bat instead.

If you plan to always use the same arguments, create a file myscrcpy.bat (enable show file extensions to avoid confusion) containing your command, For example:

scrcpy --prefer-text --turn-screen-off --stay-awake

Then just double-click on that file.

You could also edit (a copy of) scrcpy-console.bat or scrcpy-noconsole.vbs to add some arguments.