A glossy Matrix collaboration client for Android
  • Java 68.6%
  • Kotlin 26.9%
  • JavaScript 3.6%
  • HTML 0.5%
  • Shell 0.4%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Benoit Marty 3c335786f3
Merge pull request #3522 from element-hq/bma/licenseChange
License change: AGPL-3 + Commercial license
2025-01-30 17:36:15 +01:00
.buildkite final pipeline 2019-10-01 13:44:25 +02:00
.github Update issue templates 2020-09-22 14:40:39 +02:00
docs Make password dialog UX nicer 2019-03-06 15:47:51 +01:00
gradle/wrapper Upgrade gradle 2019-09-27 10:51:02 +02:00
tools Add file LICENSE-COMMERCIAL and apply dual license header 2025-01-30 17:28:04 +01:00
vector Add file LICENSE-COMMERCIAL and apply dual license header 2025-01-30 17:28:04 +01:00
.gitignore Notification Troubleshoot v1 2018-12-19 18:43:11 +01:00
.travis.yml debug failing CI builds 2019-08-01 17:29:02 +02:00
AUTHORS.rst Add option to send messages with enter button (#1070) 2019-03-03 23:23:08 +01:00
build.gradle Version++ 2020-05-20 23:20:07 +02:00
build_fdroid_apk.sh Build: improve build script to build any git branch of the SDK 2018-09-05 10:23:30 +02:00
build_jisti_libs.sh Comment out unnecessary steps to build Jitsi lib 2019-08-28 10:28:11 +02:00
build_matrix_sdk_lib.sh Add file LICENSE-COMMERCIAL and apply dual license header 2025-01-30 17:28:04 +01:00
build_olm_lib.sh Update to the latest jitsi libs 2018-01-16 16:35:11 +01:00
CHANGES.rst Improve formatting and spelling. 2020-08-24 18:28:22 +02:00
compile_with_sdk_lib.sh Some class has been moved in Matrix SDK and it has now 3 submodules 2019-05-06 14:55:28 +02:00
compile_with_sdk_project.sh Some class has been moved in Matrix SDK and it has now 3 submodules 2019-05-06 14:55:28 +02:00
CONTRIBUTING.md Important announcement 2019-03-18 16:37:18 +01:00
gradle.properties Use Server-provided Params for Domain, Display Name, and Avatar Url for Jitsi Widget 2020-05-06 03:06:44 -07:00
gradlew
gradlew.bat
LICENSE Change license to AGPL-3 2025-01-30 17:12:56 +01:00
LICENSE-COMMERCIAL Add file LICENSE-COMMERCIAL and apply dual license header 2025-01-30 17:28:04 +01:00
README.md Add license section in the README.md file. 2025-01-30 17:30:46 +01:00
set_debug_env.sh Create pipeline for buildkite 2019-04-30 13:50:53 +02:00
settings.gradle Some class has been moved in Matrix SDK and it has now 3 submodules 2019-05-06 14:55:28 +02:00
sign_apk.sh Create script to sign the APK 2019-05-02 15:46:43 +02:00
trigger_release.sh

Riot-Android Buildkite Weblate Android Matrix room #riot-android:matrix.org Quality Gate Vulnerabilities Bugs

Riot is an Android Matrix client. It is now deprecated and has been replaced by Element Android

Important announcement

The core team is now only working on Element Android. Element Android is now published on the PlayStore as a replacement of Riot-Android. So the code from this project is not published by the core team to the PlayStore, and not published anymore on F-Droid store as well.

Contributing

Please contribute to Element Android now!

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 FCM or "appfdroid" if don't.

for example, with FCM, it would give

    appmyriot {
        applicationId "im.myriot"
        // use the version name
        versionCode rootProject.ext.versionCodeProp
        versionName rootProject.ext.versionNameProp
        buildConfigField "boolean", "ALLOW_FCM_USE", "true"
        buildConfigField "String", "SHORT_FLAVOR_DESCRIPTION", "\"F\""
        buildConfigField "String", "FLAVOR_DESCRIPTION", "\"FDroid\""
    }
  • if you use FCM, duplicate appImplementation at the end of this file and replace appImplementation by appmyriotImplementation.
  • 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 FCM or you don’t.
  • Rename it to appmyriot.
  • If you use FCM, you will need to generate your own google-services.json.

Customise your flavour

  • Open riot-android/vector/src/appmyriot/AndroidManifest.xml
  • Change the application name to myRiot with "android:label="myRiot"" and "tools:replace="label"" in the application tag.
  • 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

  1. What is the minimum Android version supported?

    the mininum SDK is 16 (Android 4.1)

  2. Where the apk is generated?

    Riot/build/outputs/apk

Copyright (c) 2015 - 2025 New Vector Ltd

This software is dual licensed by New Vector Ltd (Element). It can be used either:

(1) for free under the terms of the GNU Affero General Public License (as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version); OR

(2) under the terms of a paid-for Element Commercial License agreement between you and Element (the terms of which may vary depending on what you and Element have agreed to).

Unless required by applicable law or agreed to in writing, software distributed under the Licenses is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licenses for the specific language governing permissions and limitations under the Licenses.