diff --git a/README.md b/README.md index 7fb13ea..f762051 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Moonlight Embedded is an open source implementation of NVIDIA's GameStream, as used by the NVIDIA Shield, but built for Linux. -Moonlight Embedded allows you to stream your full collection of Steam games from +Moonlight Embedded allows you to stream your full collection of games from your powerful Windows desktop to your (embedded) Linux system, like Raspberry Pi, CuBox-i and ODROID. ## Documentation @@ -11,7 +11,7 @@ More information about installing and runnning Moonlight Embedded is available o ## Requirements -* [GFE compatible](http://shield.nvidia.com/play-pc-games/) computer with GTX 600/700/900 series GPU (for the PC you're streaming from) +* [GFE compatible](http://shield.nvidia.com/play-pc-games/) computer with GTX 600/700/900/1000 series GPU (for the PC you're streaming from) * High-end wireless router (802.11n dual-band recommended) or wired network * Geforce Experience 2.1.1 or higher diff --git a/docs/README.pod b/docs/README.pod index 31f36e3..d858601 100644 --- a/docs/README.pod +++ b/docs/README.pod @@ -84,11 +84,12 @@ This is the default configuration for 720p. =item B<-fps> [I] -Change the number of frame per second to I +Change the number of frame per second to I. +Only 30 and 60 fps are currently supported by Gamestream. =item B<-bitrate> [I] -Change bitrate to I kbps. +Change bitrate to I 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 @@ -96,8 +97,9 @@ For other configurations 5 Mbps is used by default. =item B<-packetsize> [I] -Change the network packetsize to I. +Change the network packetsize to I bytes. The packetsize should the smaller than the MTU of the network. +This value must be a multiply of 16. By default a safe value of 1024 is used. =item B<-hevc> @@ -124,7 +126,11 @@ Stop GFE from changing the graphical settings of the requested game or applicati =item B<-localaudio> -Play the audio on the host instead of this computer. +Play the audio on the host computer instead of this device. + +=item B<-surround> + +Enable 5.1 surround sound instead of stereo. =item B<-keydir> [I] @@ -134,20 +140,30 @@ By default the encryption keys are stored in $XDG_CACHE_DIR/moonlight or ~/.cach =item B<-mapping> [I] Use I as the mapping file for all inputs. -This mapping file should have the same format as the gamecontrollerdb.txt for SDL. +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<-input> [I] Enable the I device. By default all available input devices are enabled. Only evdev devices /dev/input/event* are supported. -To use a different gamepad mapping then the default the B<-mapping> should be specified before the B<-input>. =item B<-audio> [I] Use 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. + +=item B<-forcehw> + +This will enable unsupported hardware acceleration. +Currently only VDPAU when using X11 or SDL is unsupported. + =back =head1 CONFIG FILE diff --git a/src/main.c b/src/main.c index 8b79251..a349ad5 100644 --- a/src/main.c +++ b/src/main.c @@ -159,15 +159,15 @@ static void help() { printf("\t-surround\t\tStream 5.1 surround sound (requires GFE 2.7)\n"); printf("\t-keydir \tLoad encryption keys from directory\n"); printf("\t-mapping \t\tUse as gamepad mappings configuration file\n"); - #ifdef HAVE_SDL - printf("\n Video options (SDL Only)\n\n"); + #if defined(HAVE_SDL) || defined(HAVE_X11) + printf("\n Video options (SDL and X11 only)\n\n"); printf("\t-windowed\t\tDisplay screen in a window\n"); + printf("\t-forcehw \t\tTry to use video hardware acceleration\n"); #endif #ifdef HAVE_EMBEDDED - printf("\n I/O options\n\n"); + printf("\n I/O options (PI, IMX, AML and X11 only)\n\n"); printf("\t-input \t\tUse as input. Can be used multiple times\n"); printf("\t-audio \t\tUse as audio output device\n"); - printf("\t-forcehw \t\tTry to use video hardware acceleration\n"); #endif printf("\nUse Ctrl+Alt+Shift+Q to exit streaming session\n\n"); exit(0);