Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve build instructions in README.md #1315

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Improve build instructions in README.md #1315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f237700
Update Build instructions, various small wording/formatting tweaks
kentyman23 Jan 15, 2024
99ad39c
Add instructions on installing NDK from Android Studio
kentyman23 Jan 15, 2024
3f2467c
No longer use deprecated local.properties
kentyman23 Jan 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 30 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,43 @@
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/232a8tadrrn8jv0k/branch/master?svg=true)](https://ci.appveyor.com/project/cgutman/moonlight-android/branch/master)
[![Translation Status](https://hosted.weblate.org/widgets/moonlight/-/moonlight-android/svg-badge.svg)](https://hosted.weblate.org/projects/moonlight/moonlight-android/)

[Moonlight for Android](https://moonlight-stream.org) is an open source client for NVIDIA GameStream and [Sunshine](https://github.com/LizardByte/Sunshine).
[Moonlight](https://moonlight-stream.org/) for Android is an open source client for
[Nvidia GameStream](https://www.nvidia.com/en-us/support/gamestream/) and
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there value in linking to a dead service?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe not, but I figured since people still get support in #geforce-experience in Discord that maybe we weren't ready to stop mentioning it. I defer to the maintainer.

[Sunshine](https://github.com/LizardByte/Sunshine).

Moonlight for Android will allow you to stream your full collection of games from your Windows PC to your Android device,
whether in your own home or over the internet.
Moonlight for Android will allow you to stream your full collection of games from your computer to
your Android device, whether in your own home or over the internet.

Moonlight also has a [PC client](https://github.com/moonlight-stream/moonlight-qt) and [iOS/tvOS client](https://github.com/moonlight-stream/moonlight-ios).
Moonlight also has clients for [PC](https://github.com/moonlight-stream/moonlight-qt),
[iOS/tvOS](https://github.com/moonlight-stream/moonlight-ios), and
[more](https://moonlight-stream.org/).

You can follow development on our [Discord server](https://moonlight-stream.org/discord) and help translate Moonlight into your language on [Weblate](https://hosted.weblate.org/projects/moonlight/moonlight-android/).
You can follow development on our [Discord server](https://moonlight-stream.org/discord)
and help translate Moonlight into your language on
[Weblate](https://hosted.weblate.org/projects/moonlight/moonlight-android/).

## Download

## Downloads
* [Google Play Store](https://play.google.com/store/apps/details?id=com.limelight)
* [Amazon App Store](https://www.amazon.com/gp/product/B00JK4MFN2)
* [F-Droid](https://f-droid.org/packages/com.limelight)
* [APK](https://github.com/moonlight-stream/moonlight-android/releases)

## Building
* Install Android Studio and the Android NDK
* Run ‘git submodule update --init --recursive’ from within moonlight-android/
* In moonlight-android/, create a file called ‘local.properties’. Add an ‘ndk.dir=’ property to the local.properties file and set it equal to your NDK directory.
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can I get confirmation from someone with more Android development experience that we can indeed totally remove the need for local.properties given the instructions I laid out. It seemed to work on my machine, but I want to make sure there are no side effects I'm not considering.

Copy link

@ReenigneArcher ReenigneArcher Jul 12, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just got into working on this project, and I was able to build the app without creating the local.properties file.

I am getting some issues when running the app in Android Emulator though (specifically I cannot pair the app to Sunshine)... but I kind of doubt it's because of that file.

Edits:

  • The pairing issues seem random, probably it is timeout issues due to Android Emulator being slow, and the debug build adding a little extra slowness.
  • The local.properties file was created automatically for me with the contents below. maybe with these contents it doesn't need the NDK directory specifically?
## This file must *NOT* be checked into Version Control Systems,
# as it contains information specific to your local configuration.
#
# Location of the SDK. This is only used by Gradle.
# For customization when using a Version Control System, please read the
# header note.
#Thu Jul 11 14:58:55 EDT 2024
sdk.dir=C\:\\Users\\ReenigneArcher\\AppData\\Local\\Android\\Sdk

* Build the APK using Android Studio or gradle
## Build

1. Install [Android Studio](https://developer.android.com/studio)
1. Install the Android NDK
1. Determine which version to use by finding `ndkVersion` in
[`app/build.gradle`](app/build.gradle)
1. In Android Studio, open _Tools»SDK Manager_
![image](ndk.png)
1. Click the _SDK Tools_ tab
1. Enable the _Show Package Details_ checkbox in the bottom-right
1. Expand the _NDK (Side by side)_ category
1. Enable the checkbox for the version determined above
1. Click OK
Comment on lines +32 to +40
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For me, it automatically installed the NDK version that was specified in the gradle file, but this is probably still helpful information.

1. Run `git submodule update --init --recursive` from within [`moonlight-android/`](/)
1. Build the APK using Android Studio or Gradle

## Authors

Expand All @@ -31,5 +48,5 @@ You can follow development on our [Discord server](https://moonlight-stream.org/
* [Aaron Neyer](https://github.com/Aaronneyer)
* [Andrew Hennessy](https://github.com/yetanothername)

Moonlight is the work of students at [Case Western](http://case.edu) and was
started as a project at [MHacks](http://mhacks.org).
Moonlight is the work of students at [Case Western](http://case.edu) and was started as a project at
[MHacks](http://mhacks.org).
Binary file added ndk.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.