moonlight-stream/moonlight-embedded
1
0
Fork 0
mirror of https://github.com/moonlight-stream/moonlight-embedded.git synced 2025-07-01 15:25:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Iwan Timmer 2017-05-28 18:34:48 +02:00
parent 51d2fe2a35
commit 26ddab2bde
3 changed files with 28 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -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

28
docs/README.pod
View File

@ -84,11 +84,12 @@ This is the default configuration for 720p.
=item B<-fps> [I<FPS>]
Change the number of frame per second to I<FPS>
Change the number of frame per second to I<FPS>.
Only 30 and 60 fps are currently supported by Gamestream.
=item B<-bitrate> [I<BITRATE>]
Change bitrate to I<BITRATE> kbps.
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
@ -96,8 +97,9 @@ For other configurations 5 Mbps is used by default.
=item B<-packetsize> [I<PACKETSIZE>]
Change the network packetsize to 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 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<DIRECTORY>]
@ -134,20 +140,30 @@ By default the encryption keys are stored in $XDG_CACHE_DIR/moonlight or ~/.cach
=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 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<INPUT>]
Enable the I<INPUT> 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<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.
=item B<-forcehw>
This will enable unsupported hardware acceleration.
Currently only VDPAU when using X11 or SDL is unsupported.
=back
=head1 CONFIG FILE

8
src/main.c
View File

@ -159,15 +159,15 @@ static void help() {
printf("\t-surround\t\tStream 5.1 surround sound (requires GFE 2.7)\n");
printf("\t-keydir <directory>\tLoad encryption keys from directory\n");
printf("\t-mapping <file>\t\tUse <file> 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 <device>\t\tUse <device> as input. Can be used multiple times\n");
printf("\t-audio <device>\t\tUse <device> 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);