mirror of
https://github.com/moonlight-stream/moonlight-embedded.git
synced 2025-07-01 15:25:35 +00:00
204 lines
4.6 KiB
Plaintext
204 lines
4.6 KiB
Plaintext
=head1 NAME
|
|
|
|
Moonlight Embedded - Open source implementation of NVIDIA's GameStream
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
Usage: I<moonlight> E<lt>actionE<gt> [options] [host]
|
|
I<moonlight> E<lt>configfileE<gt>
|
|
|
|
=head1 ACTIONS
|
|
|
|
=over 4
|
|
|
|
=item B<pair>
|
|
|
|
Pair this computer with the host.
|
|
|
|
=item B<unpair>
|
|
|
|
Unpair this computer with the host.
|
|
|
|
=item B<stream>
|
|
|
|
Stream game from host to this computer.
|
|
|
|
=item B<list>
|
|
|
|
List all available games and application on host.
|
|
|
|
=item B<quit>
|
|
|
|
Quit the current running game or application on host.
|
|
|
|
=item B<map>
|
|
|
|
Create a mapping for the specified I<INPUT> device.
|
|
|
|
=item B<help>
|
|
|
|
Show help for all available commands.
|
|
|
|
=back
|
|
|
|
=head1 OPTIONS
|
|
|
|
=over 4
|
|
|
|
=item B<-config> [I<CONFIG>]
|
|
|
|
Load configuration file I<CONFIG>.
|
|
All options specified before B<-config> will be overwritten by the options in I<CONFIG>.
|
|
This options can be used multiple times.
|
|
|
|
=item B<-save> [I<CONFIG>]
|
|
|
|
Save the configuration provided by the options on the command line and all loaded configuration files to the file I<CONFIG>.
|
|
|
|
=item B<-720>
|
|
|
|
Use the resolution 1280x720 for streaming.
|
|
This is the default option.
|
|
|
|
=item B<-1080>
|
|
|
|
Use the resolution 1920x1080 for streaming.
|
|
|
|
=item B<-4k>
|
|
|
|
Use the resolution 3840x2160 for streaming.
|
|
|
|
=item B<-width> [I<WIDTH>]
|
|
|
|
Change the horizontal resolution to I<WIDTH>
|
|
|
|
=item B<-height> [I<HEIGHT>]
|
|
|
|
Change the vertical resolution to I<HEIGHT>
|
|
|
|
=item B<-fps> [I<FPS>]
|
|
|
|
Change the number of frame per second to I<FPS>.
|
|
Defaults to 60 FPS.
|
|
|
|
=item B<-bitrate> [I<BITRATE>]
|
|
|
|
Change bitrate to I<BITRATE> Kbps.
|
|
By default the bitrate depends on the selected resolution and FPS.
|
|
For resolution 1080p and 60 FPS and higher, 20 Mbps is used.
|
|
For resolution 1080p or 60 FPS and higher, 10 Mbps is used
|
|
For other configurations, 5 Mbps is used by default.
|
|
|
|
=item B<-packetsize> [I<PACKETSIZE>]
|
|
|
|
Change the network packetsize to I<PACKETSIZE> bytes.
|
|
The packetsize should the smaller than the MTU of the network.
|
|
This value must be a multiple of 16.
|
|
By default, 1392 is used on LAN and 1024 on WAN.
|
|
|
|
=item B<-codec> [I<CODEC>]
|
|
|
|
Select codec to use.
|
|
Can be 'auto', 'h264', 'h265', 'hevc', or 'av1'.
|
|
Not all video decoders support H.265/HEVC or AV1.
|
|
Will still use H.264 if server doesn't support HEVC or AV1.
|
|
|
|
=item B<-remote> [I<yes/no/auto>]
|
|
|
|
Enable optimizations for LAN or WAN streaming.
|
|
|
|
=item B<-app> [I<APP>]
|
|
|
|
Change the requested app to execute to I<APP>.
|
|
By default Steam is started.
|
|
|
|
=item B<-nosops>
|
|
|
|
Stop GFE from changing the graphical settings of the requested game or application.
|
|
|
|
=item B<-localaudio>
|
|
|
|
Play the audio on the host computer instead of this device.
|
|
|
|
=item B<-surround> [I<5.1/7.1>]
|
|
|
|
Enable surround sound instead of stereo.
|
|
|
|
=item B<-keydir> [I<DIRECTORY>]
|
|
|
|
Change the directory to save encryption keys to I<DIRECTORY>.
|
|
By default the encryption keys are stored in $XDG_CACHE_DIR/moonlight or ~/.cache/moonlight
|
|
|
|
=item B<-mapping> [I<MAPPING>]
|
|
|
|
Use I<MAPPING> as the mapping file for all inputs.
|
|
This mapping file should have the same format as the gamecontrollerdb.txt for SDL2.
|
|
By default the gamecontrollerdb.txt provided by Moonlight Embedded is used.
|
|
|
|
=item B<-platform> [I<PLATFORM>]
|
|
|
|
Select platform for audio and video output and input.
|
|
<PLATFORM> can be pi, imx, aml, x11, x11_vdpau, sdl or fake.
|
|
|
|
=item B<-nounsupported>
|
|
|
|
Don't stream if resolution is not officially supported by the server
|
|
|
|
=item B<-quitappafter>
|
|
|
|
Send quit app request to remote after quitting session
|
|
|
|
=item B<-viewonly>
|
|
|
|
Disable all input processing (view-only mode)
|
|
|
|
=item B<-nomouseemulation>
|
|
|
|
Disable gamepad mouse emulation (activated by long pressing Start button)
|
|
|
|
=item B<-verbose>
|
|
|
|
Enable verbose output
|
|
|
|
=item B<-debug>
|
|
|
|
Enable verbose and debug output
|
|
|
|
=item B<-input> [I<INPUT>]
|
|
|
|
Enable the I<INPUT> device.
|
|
By default all available input devices are enabled.
|
|
Only evdev devices /dev/input/event* are supported.
|
|
|
|
=item B<-audio> [I<DEVICE>]
|
|
|
|
Use <DEVICE> as audio output device.
|
|
The default value is 'sysdefault' for ALSA and 'hdmi' for OMX on the Raspberry Pi.
|
|
|
|
=item B<-windowed>
|
|
|
|
Display the stream in a window instead of fullscreen.
|
|
Only available when X11 or SDL platform is used.
|
|
|
|
=back
|
|
|
|
=head1 CONFIG FILE
|
|
|
|
Moonlight Embedded will load a confiuration file from:
|
|
|
|
$XDG_CONFIG_HOME/moonligt/moonlight.conf (fallback to ~/.config/moonligt/moonlight.conf)
|
|
|
|
If no user specified configuration file is available the configuration will be loaded from:
|
|
|
|
/etc/moonlight/moonlight.conf
|
|
|
|
A documented example configuration file can be found at /etc/moonlight/moonlight.conf.
|
|
|
|
=head1 COMMENTS
|
|
|
|
Use Ctrl+Alt+Shift+Q or Play+Back+LeftShoulder+RightShoulder to quit the streaming session.
|
|
|
|
=head1 AUTHOR
|
|
|
|
Iwan Timmer E<lt>irtimmer@gmail.comE<gt>
|