moonlight-stream/moonlight-docs
1
0
Fork 0
mirror of https://github.com/moonlight-stream/moonlight-docs.git synced 2025-06-30 23:05:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Migrate Moonlight Android wiki

Cameron Gutman 2016-05-29 14:30:08 -05:00
parent 7638ddbf13
commit 17c81fac81
7 changed files with 243 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Get-In-Touch.md Normal file

@ -0,0 +1,15 @@
**Talk to Us!**
**[XDA Forum](http://forum.xda-developers.com/showthread.php?t=2505510)**: Keep up with Moonlight developments and get in touch with the developer and other users.
**Email**: info@moonlight-stream.com
We receive a lot of mail and can't respond to all of it, so please research your question on this wiki first.
**Report bugs**: If you have a Github account, please open issues on the Issues page of the corresponding project.
- [Report Moonlight Android Issues](https://github.com/moonlight-stream/moonlight-android/issues)
- [Report Moonlight iOS Issues](https://github.com/moonlight-stream/moonlight-ios/issues)
- [Report Moonlight PC Issues](https://github.com/moonlight-stream/moonlight-pc/issues)
![](https://github.com/moonlight-stream/moonlight-android/blob/master/app/src/main/res/drawable-xhdpi/ic_launcher.png)
This page is under construction.

18
Home.md

@ -1 +1,17 @@
Welcome to the moonlight-docs wiki!
![](https://github.com/moonlight-stream/moonlight-android/blob/master/app/src/main/res/drawable-xhdpi/ic_launcher.png)
## Introduction
Welcome to **Moonlight** - the open source implementation of NVIDIA Gamestream that allows you to to stream your collection of Steam games from your PC to another device.
**Disclaimer: This app is not affiliated with NVIDIA Corporation. Please do not contact them for support. **
This wiki is open to contributions from our community. Thanks for making Moonlight easier to use!
## Navigation
| **[Moonlight Overview](https://github.com/moonlight-stream/moonlight-android/wiki/Moonlight-Overview)** | **[Setup Guide](https://github.com/moonlight-stream/moonlight-android/wiki/Setup-Guide)** | **[Troubleshooting](https://github.com/moonlight-stream/moonlight-android/wiki/Troubleshooting)**|**[Project and Community](https://github.com/moonlight-stream/moonlight-android/wiki/Project-and-Community)**|
|:-----:|:-----:|:-----:|:-----:|
| Introducing Moonlight - what it does and where it came from. | Step-by-step guide on how to get started with Moonlight. | Guide to troubleshooting Moonlight issues. | About the developers, community, and how to contribute. |
## Questions? Comments? Bugs?
If you can't find your answer in any of the other wiki pages, check out our [Get In Touch](https://github.com/moonlight-stream/moonlight-android/wiki/Get-In-Touch) page.
***

10
Moonlight-Overview.md Normal file

@ -0,0 +1,10 @@
## App Description
**Introducing Moonlight:** Moonlight allows you to stream your apps and games to another client device on your network or the Internet. You can play your favorite games on your PC, phone, tablet, or TV with Moonlight.
**What it does** This app streams games from a GameStream-compatible PC on your local network or the Internet. After initial pairing, Moonlight will show a list of apps to stream from your PC. You can add any other apps to this list through GeForce Experience. Mouse, keyboard, and controller input is sent from the Moonlight client to the PC.
To have a good experience, you need a mid to high-end wireless router with a good wireless connection to your Moonlight client device (5 GHz highly recommended) and a good connection from your PC to your router (Ethernet highly recommended).
***
This page under construction

20
Project-and-Community.md Normal file

@ -0,0 +1,20 @@
## Meet the Developers
Moonlight was created by [Case Western Reserve University](http://case.edu) students as a project at the [MHacks](http://mhacks.org) hackathon in 2013 and further developed at MHacks and [HackCWRU](http://www.hackcwru.com) in 2014. It's hard to put a cool project down after a hackathon, so we continue to develop Moonlight today.
Who we are:
* [Cameron Gutman](https://github.com/cgutman)
* [Diego Waxemberg](https://github.com/dwaxemberg)
* [Aaron Neyer](https://github.com/aaronneyer)
* [Michelle Bergeron](https://github.com/mrb113)
* [Andrew Hennessy](https://github.com/yetanothername)
Email any of us at our firstname@moonlight-stream.com or all of us at info@moonlight-stream.com. We do receive a lot of mail, so please check if your answer is described in this wiki first.
## Contribute
This project is being actively developed at [XDA Developers](http://forum.xda-developers.com/showthread.php?t=2505510). We welcome code contributions - here's how in three easy steps.
1. Fork us
2. Write code
3. Send Pull Requests
Additionally, you can provide more information on this community-curated wiki for others to use.

124
Setup-Guide.md Normal file

@ -0,0 +1,124 @@
In this guide:
* [Prerequisites](https://github.com/moonlight-stream/moonlight-docs/wiki/Setup-Guide#prerequisites)
* [Quick Setup Instructions](https://github.com/moonlight-stream/moonlight-docs/wiki/Setup-Guide#quick-setup-instructions)
* [Touchscreen Controls for Android or iOS](https://github.com/moonlight-stream/moonlight-docs/wiki/Setup-Guide#touchscreen-controls-for-android-or-iOS)
* [Streaming over the Internet](https://github.com/moonlight-stream/moonlight-docs/wiki/Setup-Guide#streaming-over-the-internet)
* [Using a gamepad connected to the PC instead of the streaming device](https://github.com/moonlight-stream/moonlight-docs/wiki/Setup-Guide#using-a-gamepad-connected-to-the-pc-instead-of-the-streaming-device)
* [Adding custom programs that are not automatically found](https://github.com/moonlight-stream/moonlight-docs/wiki/Setup-Guide#adding-custom-programs-that-are-not-automatically-found)
* [Using Moonlight to stream your entire desktop](https://github.com/moonlight-stream/moonlight-docs/wiki/Setup-Guide#using-moonlight-to-stream-your-entire-desktop)
***
##Prerequisites
**PC Requirements**
* NVIDIA GeForce GTX 600/700/800/900 series or GTX 600M/700M/800M series GPU (GT-series GPUs won't work)
* NVIDIA GeForce Experience (GFE) 2.1.1 or higher
In addition, nVidia suggests the following for your PC server (http://www.geforce.com/geforce-experience/system-requirements)
* Operating System: Windows Vista or newer, with DirectX 11 or newer installed
* A CPU of reasonable newness (Intel Pentium G Series, Core 2 Duo, Quad Core i3, i5, i7, or an AMD Phenom II, Athlon II, Phenom X4, FX, or any newer, higher speed processor from either of those manufacturers)
* At least 2GB RAM, more preferred
* 20 MB of hard disk space for GeForce Experience, plus whatever additional hard disk space requirements are needed for the streamed game or game platform client, like Steam or Desura.
* A display that can handle at least 1024x768 resolution.
**Client Requirements**
* Android: An Android device running Android 4.1 (Jelly Bean) or newer. Newer and "flagship" devices with higher processor speeds are more likely to be able to handle Moonlight well by using the hardware video system on the device to produce smooth streaming without video stuttering or freezing. (For the really geeky, if the system on a chip can decode h.264 High Profile in hardware, Moonlight will work well on the device.)
* iOS: An iProduct running iOS 8.0 or later.
* PC: The PC client is currently in a beta status, and can't yet take advantage of the ability to process the video using the video card's hardware, so the requirements for the PC client are currently pretty stiff. A computer of comparable power to the server is probably a good starting point.
**Internet and Network Requirements**
To have a good experience, you need a mid to high-end wireless router with a good wireless connection to your client device (5 Gigahertz (GHz) highly recommended, Wireless-N (802.11n) or better strongly recommended) and a good connection from your PC server to your router (Ethernet/wired connections highly recommended).
**Controller**
Most controllers will work just fine, but the following have been tested:
* Xbox 360 wired/wireless
* Xbox One wired (with Moonlight's built-in driver)
* PS3 wired (with Sixaxis Enabler app) or wireless (with SixAxis Controller app)
* PS4 wired via USB
* MOGA controller (see note below)
* Amazon Fire Game Controller
* Shield integrated controller
_MOGA controller users_:
If your controller has a switch with A and B, it must be switched to B to be used for streaming. If you have no switch, use the MOGA Universal Driver app.
_SixAxis controller users_:
Use SixAxis in "Native Gamepad" mode. The default button mapping needs to be adjusted to match the standard controller layout for streaming.
**External Mouse and Keyboard**
Using an external mouse as a relative input on Android requires a rooted device. If you want to use an external mouse on your rooted device, you should download "Moonlight for Rooted Devices" on the Play Store or app-root-release.apk from releases.
##Quick Setup Instructions
1. On the server, download the GeForce Experience software from http://www.geforce.com/geforce-experience/download and install it. The server may need a reboot after installation to finish setup. Make sure GeForce Experience is open, updated, and that you've scanned for games. You should see the NVIDIA icon in your system tray. If you don't, try rebooting your machine or reinstalling GeForce Experience. Moonlight may not be able to pair if the NVIDIA icon isn't shown.
2. Start up GeForce Experience on the server and navigate to the **Preferences** tab. Then choose the **SHIELD** option. Make sure the **Allow this PC to stream games to SHIELD devices** checkbox is checked. To set up streaming from the Internet, see [Streaming over the Internet](https://github.com/moonlight-stream/moonlight-docs/wiki/Setup-Guide#streaming-over-the-internet) later on in the guide.
3. Download, install, and start your client. In most cases, your PC server will show up automatically in the PC list. Click the entry in the PC list (PC: and then click on the **Pair** button) to start pairing. If not, click the plus button and add your PC using its local network IP address. If this doesn't work, try the [troubleshooting steps here](https://github.com/moonlight-stream/moonlight-docs/wiki/Troubleshooting).
* Find the server's local network address
1. Click on the Start menu and run the command prompt (cmd.exe)
2. Type *ipconfig /all* and press Enter/Return
3. A local network addresses usually takes the form of **192.168.x.yyy**
4. On your PC, enter the PIN displayed on the Android device and accept the pairing dialog. If you don't see a pairing dialog, try the [troubleshooting steps here](https://github.com/moonlight-stream/moonlight-docs/wiki/Troubleshooting).
5. Choose your PC in the PC list and the app list will be displayed where you can select a game to stream.
##Touchscreen Controls for Android or iOS
Moonlight for Android and iOS use the touch screen as a way of controlling the mouse cursor. Multi-touch devices can emulate more mouse functions than single-touch devices.
* Swiping across the screen moves the mouse cursor in the direction of the swipe.
* Tap once with one finger to left-click.
* Tap and hold in the same place to start a click and drag. After a short while, swipe the finger to drag in the direction of the swipe.
* Hold one finger down and tap a second finger to right-click.
* Tap with three fingers to open the on-screen keyboard. Only some keyboards work with Moonlight for Android - the [Hacker's Keyboard](https://play.google.com/store/apps/details?id=org.pocketworkstation.pckeyboard) seems to work well for everything but the arrow keys.
##Streaming over the Internet
NVIDIA has disabled UPnP support in GFE 2.4.1, so it is necessary to forward ports manually if you're behind a router. Forwarding ports is only required to stream from outside your network. The following ports must be forwarded for streaming to work with the latest version of GeForce Experience:
* TCP 47984, 47989
* UDP 47998, 47999, 48000, 48010
If you are using an older version of GeForce Experience, you may need these additional ports:
* TCP 35043, 47995, 47996, 48010
To find the external IP address of your server, when connected to your network, use a service like http://www.whatismyip.com to determine the IP address another computer uses to talk to you.
_Note:_ Some Internet Service providers change the external IP address in use by any given subscriber on a regular basis. Since Moonlight needs to connect to the right IP address, this change can cause problems for Moonlight. Using a dynamic DNS service like [No-IP](http://www.noip.com) will give Moonlight a consistent name to use for connecting, even if the IP address that's associated with that name changes a lot.
To stream over the Internet, in your client: Type the external IP address or name into the IP bar or command line (PC) or, on Android or iOS, tap on the plus key when you see all the possible servers to connect to, then enter in the IP address or name. Choose your PC in the PC list and the app list will be displayed where you can select a game to stream.
##Using a gamepad connected to the PC instead of the streaming device
Normally, Moonlight sends controller input from the streaming client which gets sent to the game by GFE. If you want to connect a controller to your PC instead of the streaming device, GFE can cause some problems because the emulated controller still appears to games as controller 1. Luckily there is a workaround for this. You'll need to rename the DLL that Nvidia is using to send controller input so it won't be used anymore. On 32-bit and 64-bit Windows, rename rxinput.dll to rxinput.dll.old on in C:\Program Files\NVIDIA Corporation\NvStreamSrv. On 64-bit versions, there's another copy of the DLL in C:\Program Files (x86)\NVIDIA Corporation\NvStreamSrv which you'll want to rename. You may have to do the renaming again if GFE does an update, but it should allow you to use your controller normally on games that only support 1 controller.
##Adding custom programs that are not automatically found
You can stream any almost any game or app by adding the EXE file to GFE manually (if it's not found by the automatic app scan). Open GeForce Experience, click the **Preferences tab**, click **SHIELD** or **GameStream** on the sidebar, then click the add (+) button on the right. Browse to the app or file you want to add and click OK. You can rename the app using the edit button (pencil and paper) on the right (underneath the add button).
The next time the client opens and displays the App List, the newly added programs and games should be displayed and ready to stream.
If quitting an application doesn't stop Moonlight, press *Ctrl+Shift+Alt+Q* on Moonlight PC to quit the streaming session. On Moonlight Android and iOS, pressing the home key will switch out of the streaming session. Choose the **Quit Session** option from the App List to fully quit the streaming session.
##Using Moonlight to stream your entire desktop
Follow the steps above for adding a custom program, but for the path use: **C:\windows\system32\mstsc.exe**
You can rename the remote desktop entry using the edit button. When you click this entry, you will see your full desktop where you can run whatever you want.
***
This page is under construction

56
Troubleshooting.md Normal file

@ -0,0 +1,56 @@
Troubleshooting guide for Moonlight issues. Look at the troubleshooting steps for each of the following issues:
* [Moonlight crashes](https://github.com/moonlight-stream/moonlight-docs/wiki/Troubleshooting#moonlight-crashes)
* [Can't pair or stream at all](https://github.com/moonlight-stream/moonlight-docs/wiki/Troubleshooting#cant-pair-or-stream-at-all)
* [No video displayed on device](https://github.com/moonlight-stream/moonlight-docs/wiki/Troubleshooting#no-video-displayed-on-device)
* [Video is choppy or laggy](https://github.com/moonlight-stream/moonlight-docs/wiki/Troubleshooting#video-is-choppy-or-laggy)
* [Apps crash when launched by Moonlight](https://github.com/moonlight-stream/moonlight-docs/wiki/Troubleshooting#apps-crash-when-launched-by-moonlight)
* [Bluetooth-related streaming issues](https://github.com/moonlight-stream/moonlight-docs/wiki/Troubleshooting#bluetooth-related-streaming-issues)
* [Nvidia stream is showing but game is not loading](https://github.com/moonlight-stream/moonlight-docs/wiki/Troubleshooting#Nvidia-stream-is-showing-but-game-is-not-loading)
### Known application compatibility issues
* 3rd party firewalls (known issues with McAfee and Kaspersky)
* DisplayLink dock/display software
* TeamViewer
* KinoConsole Server
* Remote Desktop (streaming fails during and after an RDP session)
### Moonlight crashes
1. Please [send an email](https://github.com/moonlight-stream/moonlight-docs/wiki/Get-In-Touch) with details about the crash.
### Can't pair or stream at all
1. Reboot your PC and device.
2. Disable your PC's firewall.
3. Make sure a monitor is connected to your PC and turned on.
4. Make sure the NVIDIA Streaming Service is enabled and running.
5. Make sure the NVIDIA tray icon is visible. If it isn't, run "%ProgramFiles%\NVIDIA Corporation\Display\nvtray.exe"
6. Try removing some games from the search path of GeForce Experience. It can have issues with large game lists.
7. Check the list of known application compatibility issues above.
8. If all else fails: uninstall GeForce Experience, reboot, clean install GeForce Experience, and reboot again.
### No video displayed on device
1. Reboot your PC and device.
2. Lower Moonlight settings to 720p30
3. Check the list of known application compatibility issue above.
4. Disable your PC's firewall.
5. Uninstall GeForce drivers, reboot, clean install GeForce drivers, and reboot again.
### Video is choppy or laggy
1. Try streaming with Bluetooth disabled to see if your device has the Bluetooth issue detailed below.
2. Make sure your device is connected on 5 GHz and your PC is wired to your router.
3. Lower the bitrate slider.
4. Try using 720p30 which has the lowest requirements.
### Apps crash when launched by Moonlight
1. Uninstall GeForce drivers, reboot, clean install GeForce drivers, and reboot again.
2. Try launching them through Steam
### Bluetooth-related streaming issues
Depending on your phone/tablet, you may have a bad streaming experience if Bluetooth is active while streaming. This is a hardware issue due to the antenna wiring. If you experience this, you can try a USB Ethernet adapter or a controller that connects directly to your Android device via USB OTG.
### Nvidia stream is showing but game is not loading
MS eventlog will inform that SS2OSD.dll crashSS2OSD.dll crash failed. this is caused by the Asus Sound driver Sonicradar for adding effects to audio.
1. Kill the process
2. Uninstall the software
Still having issues? Check out the [Get In Touch](https://github.com/moonlight-stream/moonlight-docs/wiki/Get-In-Touch) page.

1
_Footer.md Normal file

@ -0,0 +1 @@
© 2016. All rights reserved.