forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add Android instructions to example README (#775)

Browse Source 
Bonus: Fixed iOS formatted text by adding preceding newline.
This commit is contained in:
Nicholas Rishel 2020-11-02 22:54:08 -08:00 committed by GitHub
parent 66f2f76a18
commit ce1d16d90d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 45 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
examples/README.md
View File

@ -147,15 +147,18 @@ Then serve `examples/wasm` dir to browser. i.e.
#### build & run #### build & run
Using bash: Using bash:
$ cd examples/ios $ cd examples/ios
$ make run $ make run
In an ideal world, this will boot up, install and run the app for the first In an ideal world, this will boot up, install and run the app for the first
iOS simulator in your `xcrun simctl devices list`. If this fails, you can iOS simulator in your `xcrun simctl devices list`. If this fails, you can
specify the simulator device UUID via: specify the simulator device UUID via:
$ DEVICE_ID=${YOUR_DEVICE_ID} make run $ DEVICE_ID=${YOUR_DEVICE_ID} make run
If you'd like to see xcode do stuff, you can run If you'd like to see xcode do stuff, you can run
$ open bevy_ios_example.xcodeproj/ $ open bevy_ios_example.xcodeproj/
which will open xcode. You then must push the zoom zoom play button and wait which will open xcode. You then must push the zoom zoom play button and wait
@ -169,3 +172,45 @@ variable in the "`cargo_ios` target" to be either `x86_64-apple-ios` or
Note: if you update this variable in Xcode, it will also change the default Note: if you update this variable in Xcode, it will also change the default
used for the `Makefile`. used for the `Makefile`.
## Android
#### pre-req
$ rustup target add aarch64-linux-android armv7-linux-androideabi
$ cargo install cargo-apk
The Android SDK 29 must be installed, and the environment variable `ANDROID_SDK_ROOT` set to the root Android `sdk` folder.
When using `NDK (Side by side)`, the environment variable `ANDROID_NDK_ROOT` must also be set to one of the NDKs in `sdk\ndk\[NDK number]`.
#### build & run
To run on a device setup for Android development, run:
$ cargo apk run --example bevy_android --features="supported_android_features" --no-default-features
:warning: At this time Bevy does not work in Android Emulator.
When using Bevy as a library, the following fields must be added to `Cargo.toml`:
[package.metadata.android]
build_targets = [ "aarch64-linux-android", "armv7-linux-androideabi" ]
target_sdk_version = 29
min_sdk_version = 29
[[package.metadata.android.feature]]
name = "android.hardware.vulkan.level"
version = "1"
Please reference `cargo-apk` [README](https://crates.io/crates/cargo-apk) for other Android Manifest fields.
#### old phones
Bevy by default requires Android API level 29 which is the [Play Store's minimum API to upload or update apps](https://developer.android.com/distribute/best-practices/develop/target-sdk). Users of older phones may want to use an older API when testing.
To use a different API, the following fields must be updated in Cargo.toml:
[package.metadata.android]
target_sdk_version = >>API<<
min_sdk_version = >>API or less<<