Skip to content
A simpler Matrix client for Android, with fewer permissions and dependencies
Branch: limified
Clone or download
Pull request Compare This branch is 178 commits ahead, 2 commits behind vector-im:develop.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add check point for light and dark themes Feb 18, 2019
docs Make password dialog UX nicer Mar 6, 2019
gradle/wrapper Make nearly lib up to date, gradle 4.10.1, target API 28, kotlin 1.3.20 Mar 21, 2019
tools Add scripts to test app standby and doze mode Mar 27, 2019
vector Merge remote-tracking branch 'upstream/develop' into limified Apr 23, 2019
.gitignore Notification Troubleshoot v1 Dec 19, 2018
.travis.yml Fix / Travis fails when keeping gradle cache Apr 17, 2019
AUTHORS.rst Add option to send messages with enter button (vector-im#1070) Mar 3, 2019
CHANGES.rst Update CHANGES.rst Apr 10, 2019
CONTRIBUTING.md Important announcement Mar 18, 2019
LICENSE remove history Jun 2, 2015
README.md updated pointer for f-droid branch Mar 27, 2019
build.gradle Version++ Apr 4, 2019
build_fdroid_apk.sh Merge tag 'v0.8.17' into limified Oct 13, 2018
build_jitsi_libs.sh Update to the latest jitsi libs Jan 16, 2018
build_matrix_sdk_lib.sh Build: improve build script to build any git branch of the SDK Sep 5, 2018
build_olm_lib.sh Update to the latest jitsi libs Jan 16, 2018
build_riot_apks.sh
compile_with_sdk_lib.sh
compile_with_sdk_project.sh
gradle.properties Configure sonar Sep 26, 2018
gradlew remove history Jun 2, 2015
gradlew.bat remove history Jun 2, 2015
set_debug_env.sh Add scripts to switch SDK between lib/project. May 15, 2018
settings.gradle Make password dialog UX nicer Mar 6, 2019
trigger_release.sh use a tmp folder to clone the matrix-android-skd git repo Dec 22, 2017

README.md

miniVector

This is a minified Android Matrix client derived from the official client. It requires fewer permissions and compiles to a much smaller package.

Full credit goes to the original developers. This fork just shaves-off the following features and dependencies:

  • Jitsi integration (for audio / video conference)
  • React native libraries
  • Application Icon badger
  • Analytics

Links


The rest of this readme is the original readme from riot-android.


======= Important Announcement

The core team is now working mainly on RiotX. New contributions (PR, issues) are still welcome, but be aware that this codebase will be replaced in the future by the RiotX implementation.

Contributing

Please refer to CONTRIBUTING.md if you want to contribute the Matrix on Android projects!

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

You can’t perform that action at this time.