From 25be9e5cf80357d6dcc9fbb0cc01968b6fb9a9b1 Mon Sep 17 00:00:00 2001 From: Aaron Neyer Date: Mon, 9 Dec 2013 16:55:12 -0500 Subject: [PATCH] updated readme --- README.md | 48 ++++++++++++++++++++++++++++++++---------------- 1 file changed, 32 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index b0da7d05..57ac70c2 100644 --- a/README.md +++ b/README.md @@ -3,32 +3,47 @@ Limelight is an open source implementation of NVIDIA's GameStream, as used by the NVIDIA Shield. We reverse engineered the Shield streaming software, and created a version that can be run on any Android device. -In order to stream with Limelight, you need a desktop with a GTX 650 or higher GPU. The full requirements can be found [here](http://shield.nvidia.com/play-pc-games/). +Limelight will allow you to stream your full collection of Steam games from your +Windows PC to your Android device on the same network. -Limelight requires your Android device to be on the same network as your Windows PC, but can be used remotely if you -are running [Shield Proxy](http://forum.xda-developers.com/showthread.php?t=2435481). +Streaming can be done remotely using the [Shield Proxy](http://forum.xda-developers.com/showthread.php?t=2435481) +application. [Limelight-pc](https://github.com/limelight-stream/limelight-pc) is also currently in development for Windows, OSX and Linux. +##Features + +* Streams Steam and all of your games from your PC to your Android device +* Full gamepad support for MOGA, XBOX 360, PS3, OUYA, and Shield + +##Features in development + +* Use mDNS to scan for compatible GFE machines on the network +* Choose from the list of available games instead of just launching Steam +* Keyboard input ##Installation -Download Limelight for Android and install the APK to your Android device. The latest APK can be found on the -[XDA Thread](http://forum.xda-developers.com/showthread.php?t=2505510). +* Download and install Limelight for Android from +[XDA](http://forum.xda-developers.com/showthread.php?t=2505510) +* Download [GeForce Experience](http://www.geforce.com/geforce-experience) and install on your Windows PC -Download [GeForce Experience](http://www.geforce.com/geforce-experience) and install on your Windows PC. This was -most likely already installed when you installed the NVIDIA drivers. +##Requirements + +* [GFE compatible](http://shield.nvidia.com/play-pc-games/) computer with GTX 600/700 series GPU +* Android device running 4.1 (Jelly Bean) or higher +* High-end wireless router (802.11n dual-band recommended) +* Exynos/Snapdragon SoC __OR__ Quad-Core 1.4 GHz Cortex-A9 or higher (Tegra 3) ##Usage -Ensure your Android device with Limelight is on the same network as your Windows PC with GFE, or you have -[Shield Proxy](http://forum.xda-developers.com/showthread.php?t=2435481) running, and you have turned on -Shield Streaming in the GFE settings. In Limelight, enter in the IP or Hostname of your Windows PC and click -"Pair Computer". On your Windows PC, GFE should display a dialog asking to confirm pairing. Accept this and Limelight -should give you a notification. Now click "Start Streaming" and Steam will open. - -You can control Steam and play games by using a gamepad paired with your Android device. Limelight supports Xbox 360, MOGA, OUYA and PS3 -controllers although may still work with others. +* Ensure your Android device and your PC are on the same network or you're + running [Shield Proxy](http://forum.xda-developers.com/showthread.php?t=2435481). +* Turn on Shield Streaming in the GFE settings +* In Limelight, enter your PC's IP or Hostname and click "Pair". +* Accept the pairing confirmation on your PC +* In Limelight, click "Start Streaming" +* Play games! ##Contribute @@ -45,4 +60,5 @@ This project is being actively developed at [XDA](http://forum.xda-developers.co * [Aaron Neyer](https://github.com/Aaronneyer) * [Andrew Hennessy](https://github.com/yetanothername) -Limelight is the work of students at [Case Western](http://case.edu). \ No newline at end of file +Limelight is the work of students at [Case Western](http://case.edu) and was +started as a project at [MHacks](http://mhacks.org).