- Java 92.1%
- JavaScript 4.1%
- Kotlin 2.9%
- HTML 0.7%
- Shell 0.2%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| docs | ||
| gradle/wrapper | ||
| projectFilesBackup/.idea | ||
| tools | ||
| vector | ||
| .gitignore | ||
| .travis.yml | ||
| AUTHORS.rst | ||
| build.gradle | ||
| build_fdroid_apk.sh | ||
| build_jitsi_libs.sh | ||
| build_matrix_sdk_lib.sh | ||
| build_olm_lib.sh | ||
| build_riot_apks.sh | ||
| CHANGES.rst | ||
| compile_with_sdk_lib.sh | ||
| compile_with_sdk_project.sh | ||
| CONTRIBUTING.rst | ||
| google-services.json | ||
| gradle.properties | ||
| gradlew | ||
| gradlew.bat | ||
| LICENSE | ||
| README.md | ||
| set_debug_env.sh | ||
| settings.gradle | ||
| test_referrer.sh | ||
| trigger_release.sh | ||
Riot
Riot is an Android Matrix client.
Build instructions
This client is a standard android studio project.
If you want to compile it in command line with gradle, go to the project directory:
Debug mode:
./gradlew assembleDebug
Release mode:
./gradlew assembleRelease
And it should build the project (you need to have the right android SDKs)
Recompile the provided aar files until we have gradle
generate olm-sdk.aar
sh build_olm_lib.sh
generate matrix-sdk.aar
sh build_matrix_sdk_lib.sh
generate the other aar files
sh build_jitsi_libs.sh
compile the matrix SDK with the Riot-android project
sh set_debug_env.sh
Make your own flavour
Let says your application is named MyRiot : You have to create your own flavour.
Modify riot-android/vector/build.gradle
In "productFlavors" section, duplicate "app" group if you plan to use GCM/FCM or "appfdroid" if don't.
for example, with GCM, it would give
appmyriot {
applicationId "im.myriot"
// use the version name
versionCode rootProject.ext.versionCodeProp
versionName rootProject.ext.versionNameProp
resValue "string", "allow_gcm_use", "true"
resValue "string", "allow_ga_use", "true"
resValue "string", "short_flavor_description", "G"
resValue "string", "flavor_description", "GooglePlay"
}
- if you use GCM, duplicate appCompile at the end of this file and replace appCompile by appmyriotCompile.
- if you don't, update the "if (!getGradle().getStartParameter().getTaskRequests().toString().contains("fdroid"))" to include your flavor.
Create your flavour directory
- Copy riot-android/vector/src/app or appfroid if you use GCM or you don’t.
- Rename it to appmyriot.
- If you use GCM, you will need to generate your own google-services.json.
Customise your flavour
- Open riot-android/vector/src/appmyriot/AndroidManifest.xml
- Comment the provider section.
- Change the application name to myRiot with "android:label="myRiot""
- Any other field can be customised by adding the resources in this directory classpath.
- Open Android studio, select your flavour.
- Build and run the app : you made your first Riot app.
You will need to manage your own provider because "im.vector" is already used (look at VectorContentProvider to manage it).
Customise your application settings with a custom google play link
It is possible to set some default values to Riot with some extra parameters to the google play link.
- Use the https://developers.google.com/analytics/devguides/collection/android/v4/campaigns URL generator (at the bottom)
- Set "Campaign Content" with the extra parameters (e.g. is=http://my__is.org%26hs=http://my_hs.org). Please notice the usage of %26 to escape the &
- Supported extra parameters:
- is : identity server URL
- hs : home server URL
- Generate the customised link
- The application may have to be installed from the Play Store website (and not from the Play Store application) for this feature to work properly.
FAQ
-
What is the minimum android version supported?
the mininum SDK is 16 (android 4.1)
-
Where the apk is generated?
Riot/build/outputs/apk

