Compare commits

...

4 Commits

Author SHA1 Message Date
cef7e14202 Reintroduce WinGet install note
Semantically reverts c27ab46efb.

WinGet package has been fixed by:
<https://github.com/microsoft/winget-pkgs/pull/196442>

Refs #4027 <https://github.com/Genymobile/scrcpy/issues/4027>
PR #5686 <https://github.com/Genymobile/scrcpy/pull/5686>

Signed-off-by: Romain Vimont <rom@rom1v.com>
2024-12-19 09:38:26 +01:00
1fd57ede1f Move "screen off timeout" section in documentation
Place the "screen off timeout" section right after "stay awake", as they
serve a similar purpose.
2024-12-17 13:09:24 +01:00
48fc18e380 Add must-know tips
All users should be aware of the main shortcuts and the most important
setting to improve performance.
2024-12-17 12:24:50 +01:00
ea6a94d355 Fix mouse documentation formatting
Make the format consistent with the shortcuts documentation.
2024-12-17 12:21:57 +01:00
4 changed files with 48 additions and 32 deletions

View File

@ -78,6 +78,16 @@ Note that USB debugging is not required to run scrcpy in [OTG mode](doc/otg.md).
- [macOS](doc/macos.md) - [macOS](doc/macos.md)
## Must-know tips
- [Reducing resolution](doc/video.md#size) may greatly improve performance
(`scrcpy -m1024`)
- [_Right-click_](doc/mouse.md#mouse-bindings) triggers `BACK`
- [_Middle-click_](doc/mouse.md#mouse-bindings) triggers `HOME`
- <kbd>Alt</kbd>+<kbd>f</kbd> toggles [fullscreen](doc/window.md#fullscreen)
- There are many other [shortcuts](doc/shortcuts.md)
## Usage examples ## Usage examples
There are a lot of options, [documented](#user-documentation) in separate pages. There are a lot of options, [documented](#user-documentation) in separate pages.

View File

@ -34,6 +34,31 @@ adb shell settings put global stay_on_while_plugged_in 0
``` ```
## Screen off timeout
The Android screen automatically turns off after some delay.
To change this delay while scrcpy is running:
```bash
scrcpy --screen-off-timeout=300 # 300 seconds (5 minutes)
```
The initial value is restored on exit.
It is possible to change this setting manually:
```bash
# get the current screen_off_timeout value
adb shell settings get system screen_off_timeout
# set a new value (in milliseconds)
adb shell settings put system screen_off_timeout 30000
```
Note that the Android value is in milliseconds, but the scrcpy command line
argument is in seconds.
## Turn screen off ## Turn screen off
It is possible to turn the device screen off while mirroring on start with a It is possible to turn the device screen off while mirroring on start with a
@ -71,31 +96,6 @@ adb shell cmd display power-on 0
``` ```
## Screen off timeout
The Android screen automatically turns off after some delay.
To change this delay while scrcpy is running:
```bash
scrcpy --screen-off-timeout=300 # 300 seconds (5 minutes)
```
The initial value is restored on exit.
It is possible to change this setting manually:
```bash
# get the current screen_off_timeout value
adb shell settings get system screen_off_timeout
# set a new value (in milliseconds)
adb shell settings put system screen_off_timeout 30000
```
Note that the Android value is in milliseconds, but the scrcpy command line
argument is in seconds.
## Show touches ## Show touches
For presentations, it may be useful to show physical touches (on the physical For presentations, it may be useful to show physical touches (on the physical

View File

@ -83,9 +83,9 @@ process like the _adb daemon_).
## Mouse bindings ## Mouse bindings
By default, with SDK mouse: By default, with SDK mouse:
- right-click triggers BACK (or POWER on) - right-click triggers `BACK` (or `POWER` on)
- middle-click triggers HOME - middle-click triggers `HOME`
- the 4th click triggers APP_SWITCH - the 4th click triggers `APP_SWITCH`
- the 5th click expands the notification panel - the 5th click expands the notification panel
The secondary clicks may be forwarded to the device instead by pressing the The secondary clicks may be forwarded to the device instead by pressing the
@ -121,9 +121,9 @@ Each character must be one of the following:
- `+`: forward the click to the device - `+`: forward the click to the device
- `-`: ignore the click - `-`: ignore the click
- `b`: trigger shortcut BACK (or turn screen on if off) - `b`: trigger shortcut `BACK` (or turn screen on if off)
- `h`: trigger shortcut HOME - `h`: trigger shortcut `HOME`
- `s`: trigger shortcut APP_SWITCH - `s`: trigger shortcut `APP_SWITCH`
- `n`: trigger shortcut "expand notification panel" - `n`: trigger shortcut "expand notification panel"
For example: For example:

View File

@ -20,6 +20,12 @@ and extract it.
### From a package manager ### From a package manager
From [WinGet] (ADB and other dependencies will be installed alongside scrcpy):
```bash
winget install --exact Genymobile.scrcpy
```
From [Chocolatey]: From [Chocolatey]:
```bash ```bash
@ -29,12 +35,12 @@ choco install adb # if you don't have it yet
From [Scoop]: From [Scoop]:
```bash ```bash
scoop install scrcpy scoop install scrcpy
scoop install adb # if you don't have it yet scoop install adb # if you don't have it yet
``` ```
[WinGet]: https://github.com/microsoft/winget-cli
[Chocolatey]: https://chocolatey.org/ [Chocolatey]: https://chocolatey.org/
[Scoop]: https://scoop.sh [Scoop]: https://scoop.sh