diff --git a/README.md b/README.md index 0a8f43b..6ded03c 100644 --- a/README.md +++ b/README.md @@ -1,183 +1,46 @@ -#Moonlight Embedded +# Moonlight Embedded -Moonlight is an open source implementation of NVIDIA's GameStream, as used by the NVIDIA Shield, -but built for Linux/OSX/Windows. +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 -your powerful Windows desktop to your embedded system, like Raspberry Pi, CuBox-i and Hummingboard. +your powerful Windows desktop to your (embedded) Linux system, like Raspberry Pi, CuBox-i and Hummingboard. -For a demo see this [video](https://www.youtube.com/watch?v=XRW6O0bSHNw). +## Documentation -##Features +More information about installing and runnning Moonlight Embedded is available on the [wiki](https://github.com/irtimmer/moonlight-embedded/wiki). + +## Features * Streams Steam and all of your games from your PC to your embedded system. * Use mDNS to scan for compatible GeForce Experience (GFE) machines on the network. * Qwerty Keyboard, Mouse and Gamepad support -* Support Raspberry Pi and i.MX 6 devices +* Support hardware video decoding on Raspberry Pi and i.MX 6 devices -##Requirements +## 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) * High-end wireless router (802.11n dual-band recommended) or wired network * Geforce Experience 2.1.1 or higher -##Quick Start +## Quick Start -* Ensure your machine and embedded system are on the same network +* Ensure your GFE server and client are on the same network * Turn on Shield Streaming in the GFE settings -* Start Moonlight Embedded with pair +* Pair Moonlight Embedded with the GFE server * Accept the pairing confirmation on your PC -* Start Moonlight Embedded with stream +* Connect to the GFE Server with Moonlight Embedded * Play games! -##Usage +## Bugs - Usage: moonlight [options] host - - Actions: - - map Create mapping file for gamepad - pair Pair device with computer - stream Stream computer to device - list List available games and applications - quit Quit the application or game being streamed - help Show this help - - Global options: - - -config Load configuration file - -save Save configuration file - - Streaming options: - - -720 Use 1280x720 resolution (default) - -1080 Use 1920x1080 resolution - -width Horizontal resolution (default 1280) - -height Vertical resolution (default 720) - -30fps Use 30fps - -60fps Use 60fps (default) - -bitrate Specify the bitrate in Kbps - -packetsize Specify the maximum packetsize in bytes - -app Name of app to stream - -nosops Don't allow GFE to modify game settings - -localaudio Play audio locally - -keydir \tLoad encryption keys from directory - - I/O options: - -mapping Use as gamepad mapping configuration file (use before -input) - -input Use as input. Can be used multiple times - -audio Use as ALSA audio output device (default sysdefault) - - Use Ctrl+Alt+Shift+Q to exit streaming session - -## Packages -Prebuilt binary packages for Raspbian Wheezy and OSMC are available, add this line to your */etc/apt/sources.list* -``` -deb http://archive.itimmer.nl/raspbian/moonlight wheezy main -``` - -Install package using the following commands -``` -apt-get update -apt-get install moonlight-embedded -``` - -Source package for ArchLinux is available in [AUR](https://aur.archlinux.org/packages/moonlight-embedded/) - -Prebuilt binary packages for ArchLinux ARM are available, add those lines to you */etc/pacman.conf* -``` -[moonlight] -Server = http://archive.itimmer.nl/archlinux/$repo/os/$arch -SigLevel = Optional -``` - -Install package using the following command -``` -pacman -Sy moonlight-embedded -``` - -##Compile and install - -* Download and extract Moonlight Embedded from release or git clone -* Install development dependencies (see Dependencies) -* Initialize the git submodules ``git submodule update --init`` -* Build and install using the following commands - -``` -mkdir build -cd build/ -cmake ../ -make -make install -``` - -## Dependencies - -### ArchLinux -Install with -``` -pacman -S (package list) -``` -* opus -* expat -* openssl -* alsa-lib -* avahi -* libevdev -* raspberrypi-firmware-tools (Raspberry Pi) -* imx-vpu (iMX.6) - -For compilation and development you also need: -* cmake - -### Debian (Raspbian) / OSMC -Install with -``` -apt-get install (package list) -``` -* libopus0 -* libexpat1 -* libasound2 -* libudev0 -* libavahi-client3 -* libcurl3 -* libevdev2 -* rbp-userland-osmc (Raspberry Pi and OSMC) -* libraspberrypi0 (Raspberry Pi and Raspbian) - -For compilation and development you also need: -* libssl-dev -* libopus-dev -* libasound2-dev -* libudev-dev -* libavahi-client-dev -* libcurl4-openssl-dev -* libevdev-dev -* cmake -* rbp-userland-dev-osmc (Raspberry Pi and OSMC) -* libraspberrypi-dev (Raspberry Pi and Raspbian) +Bugs can be reported to the [issue tracker](https://github.com/irtimmer/moonlight-embedded/issues). ## See also [Moonlight-common-c](https://github.com/moonlight-stream/moonlight-common-c) is the shared codebase between different C implementations of Moonlight -[Moonlight-common-c](https://github.com/irtimmer/moonlight-common-c) is the used fork used by Moonlight Embedded - -[Moonlight-common](https://github.com/moonlight-stream/moonlight-common) is the shared codebase between -different Java implementations of Moonlight - -[Moonlight](https://github.com/moonlight-stream/moonlight-android) also has an Android -implementation. - -[Moonlight-pc](https://github.com/moonlight-stream/moonlight-pc) also has an Linux/OSX/Windows -implementation. - -[Moonlight iOS](https://github.com/moonlight-stream/moonlight-ios) also has an iOS -implementation. - -[Moonlight Windows](https://github.com/moonlight-stream/moonlight-windows) also has an Windows and Windows Phone -implementation. +[Moonlight-common-c](https://github.com/irtimmer/moonlight-common-c) is the fork used by Moonlight Embedded ## Discussion @@ -185,7 +48,7 @@ implementation. [Raspberry Pi Forum](http://www.raspberrypi.org/forums/viewtopic.php?f=78&t=65878) [SolidRun Community](http://www.solid-run.com/community/viewtopic.php?f=13&t=1489&p=11173) -##Contribute +## Contribute 1. Fork us 2. Write code