[![Github All Releases](https://img.shields.io/github/downloads/MyHush/SilentDragonAndroid/total.svg)](https://img.shields.io/github/downloads/MyHush/SilentDragonAndroid/total.svg)
SilentDragon Android is an Android frontend for the desktop [SilentDragon](https://github.com/MyHush/SilentDragon) or [SilentDragonLite](https://github.com/MyHush/SilentDragonLite) that lets you send and receive shielded payments from your mobile phone. We are currently working on implementing Lite Wallet and HushChat functionality on Android, so follow us on our [Twitter](https://twitter.com/MyHushTeam) or [Mastodon](https://fosstodon.org/@myhushteam) to stay updated. After this functionality is implemented, we are planning on making an F-Droid release.
1. Via the [Google Play Store](https://play.google.com/store/apps/details?id=org.myhush.silentdragon).
1. Direct APK install available at the [Releases page](https://github.com/MyHush/SilentDragonAndroid/releases). You will need to allow `Install from untrusted sources` on your Android phone in order to install from this source.
### Running SilentDragon
## Running SilentDragon
In order to let your Android phone connect to your desktop, you need to run the desktop [SilentDragon](https://github.com/MyHush/SilentDragon), and sync fully. This is not a full node
on your Android (your poor battery!). It's a remote control for your full node.
@ -21,21 +41,15 @@ is about 900MB on disk.
After your node is synced, go to `Apps -> Connect Mobile App` to view the
connection QR Code, which you can scan from the Android App.
## Dev Download
You can also head over to the [Releases page](https://github.com/MyHush/SilentDragonAndroid/releases) to download an APK. Please report bugs if you see any!
### Install the Android APK directly
If you're installing the APK directly, you'll need to allow `Install from untrusted sources` on your Android phone.
### Bugs???
You can file issues in the [issues tab](https://github.com/MyHush/SilentDragonAndroid/issues).
We appreciate them! Please follow the Github issue template, when reasonable.
### Compiling from source
## Compiling from source
You can also compile and run from source.
On OS X:
@ -65,64 +79,24 @@ Make sure you have Gradle 5.4.x or higher, 5.4.1 is known to work:
Or you can use Android Studio on Linux, OS X, or Windows:
Make sure to install ndkVersion 21.1.6352462
Make sure to install ndkVersion 21.1.6352462.
Clone the repository and open the project in Android Studio.
Android Studio will automatically run the initial build process.
Click the Run button to launch the app after the build process is complete.
## Release Build Process
The first time you create a release build you'll need to create a keystore file and prepare a properties file. The
release keystore is used for app signing and a properties file is used to store
sensitive information about the keystore. These files should not be committed
to git. Once you have both of these files you can create a release build for
* With Android Studio IDE open, on the system bar click Build -> Generate Signed Bundle/APK
* Select the APK option instead of the Bundle option
* On the next screen select app as the module and click "Create new"
* Set the Key Store Name to `silent_dragon_keystore.jks` and the path to that of the project, create a password for the keystore path, a Key alias, and a key password. The store password and key password should be the same. Fill out some basic organization information and click Ok.
* On the next screen make sure the build variant "release" is selected and click Finish.
### Preparing a properties file
Copy `secrets.properties` file from `examples` folder and paste it to the projects main directory.
Fill store_file_location, key_alias, key_password and store_password when you created the release keystore.
### Building a release APK for Google Play
Before creating each build you should increment the version code & version name
in the build.gradle file. These must be incremented for each release otherwise
the Play Store will reject the build.
To create a release build navigate to the project directory in terminal and run
```
./new_binary.sh 1.2.3
```
where 1.2.3 is the version number, which must match the codebase to be accepted to Google Play.
This will produce an apk file in the following directory.
<stringname="disallow_routing_over_external_service">Disallow routing over external service/internet</string>
<stringname="only_attempts_direct_connection">If checked, the app will only attempt a direct connection to SilentDragon, and not route traffic over the internet via the WormHole service at wormhole.myhush.org . Please see the https://myhush.org/silentdragon for more details</string>
* With Android Studio IDE open, on the system bar click Build -> Generate Signed Bundle/APK
* Select the APK option instead of the Bundle option
* On the next screen select app as the module and click "Create new"
* Set the Key Store Name to `silent_dragon_keystore.jks` and the path to that of the project, create a password for the keystore path, a Key alias, and a key password. The store password and key password should be the same. Fill out some basic organization information and click Ok.
* On the next screen make sure the build variant "release" is selected and click Finish.
## Preparing a properties file
Copy `secrets.properties` file from `examples` folder and paste it to the projects main directory.
Fill store_file_location, key_alias, key_password and store_password when you created the release keystore.
## Building a release APK for Google Play
Before creating each build you should increment the version code & version name
in the build.gradle file. These must be incremented for each release otherwise
the Play Store will reject the build.
To create a release build navigate to the project directory in terminal and run
```
./new_binary.sh 1.2.3
```
where 1.2.3 is the version number, which must match the codebase to be accepted to Google Play.
This will produce an apk file in the following directory.