Android Matrix messenger application using the Matrix Rust Sdk and Jetpack Compose
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Benoit Marty a68f39d8c4 Git ignore copilot folder. 8 months ago
.github Use nschloe/action-cached-lfs-checkout to retrieve LFS content. 8 months ago
.idea Kotlin 1.9.22 9 months ago
.maestro Update Maestro test after wording change. 8 months ago
anvilannotations Update Gradle to 8.1 and AGP to v8.0 (#329) 2 years ago
anvilcodegen Fix ktlint issues 10 months ago
app Remove Modifier parameter in private function when only default value is used. 9 months ago
appconfig Fix ktlint issues 10 months ago
appnav Show blocked users list (#2437) 8 months ago
changelog.d Disable trace logs for read receipts 8 months ago
docs Fix small typos 9 months ago
fastlane/metadata/android/en-US Merge tag 'v0.4.5' into develop 8 months ago
features Fix text alignment on empty poll view. 8 months ago
gradle Update dependency org.matrix.rustcomponents:sdk-android to v0.2.7 (#2526) 8 months ago
libraries Merge pull request #2511 from element-hq/bnjbvr/disable-special-log-level-for-read-receipts 8 months ago
plugins Bump version patch. 8 months ago
samples/minimal RoomListFilters : use kotlin filtering as rust one is slower and has more chance to bust the room list cache. 8 months ago
screenshots Sync Strings (#2523) 8 months ago
services Analytics : add analytics on read status and favorite toggles 9 months ago
tests Merge pull request #2518 from element-hq/feature/bma/testPollHistoryView 8 months ago
tools Add the Dark version to the data.js file and render it in the webpage. 8 months ago
.editorconfig Ktlint: disable rule standard:blank-line-before-declaration. 10 months ago
.gitattributes Generate screenshots for foreign languages ("de" and "fr" for now). #2454 8 months ago
.gitignore Git ignore copilot folder. 8 months ago
AUTHORS.md Organization renaming: replace all `https://github.com/vector-im` by `https://github.com/element-hq` 11 months ago
CHANGES.md Changelog for version 0.4.5 8 months ago
CODEOWNERS Update CODEOWNERS after organization renaming 11 months ago
CONTRIBUTING.md Remove `_`, added by mistake. 9 months ago
Gemfile Add Gemfile to be able to run danger locally. 2 years ago
LICENSE Initial commit 2 years ago
README.md Remove `_`, added by mistake. 9 months ago
build.gradle.kts Update dependency io.nlopez.compose.rules:detekt to v0.3.12 (#2510) 8 months ago
gradle.properties Only apply dependencyanalysis plugin to some modules 10 months ago
gradlew Update dependency gradle to v8.4 (#1496) 1 year ago
gradlew.bat Update dependency gradle to v8.2 (#744) 1 year ago
settings.gradle.kts StartDM : add tests 11 months ago
towncrier.toml Organization renaming: replace all `https://github.com/vector-im` by `https://github.com/element-hq` 11 months ago

README.md

Latest build Quality Gate Status Vulnerabilities Bugs codecov Element X Android Matrix room #element-x-android:matrix.org Localazy

Element X Android

Element X Android is a Matrix Android Client provided by element.io. This app is currently in a pre-alpha release stage with only basic functionalities.

The application is a total rewrite of Element-Android using the Matrix Rust SDK underneath and targeting devices running Android 6+. The UI layer is written using Jetpack Compose, and the navigation is managed using Appyx.

Learn more about why we are building Element X in our blog post: https://element.io/blog/element-x-experience-the-future-of-element/.

Table of contents

Screenshots

Here are some early screenshots of the application:

Rust SDK

Element X leverages the Matrix Rust SDK through an FFI layer that the final client can directly import and use.

We're doing this as a way to share code between platforms and while we've seen promising results it's still in the experimental stage and bound to change.

Status

This project is in work in progress. The app does not cover yet all functionalities we expect. The list of supported features can be found in this issue.

Contributing

Want to get actively involved in the project? You're more than welcome! A good way to start is to check the issues that are labelled with the good first issue label. Let us know by commenting the issue that you're starting working on it.

But first make sure to read our contribution guide first.

You can also come chat with the community in the Matrix room dedicated to the project.

Build instructions

Just clone the project and open it in Android Studio. Makes sure to select the app configuration when building (as we also have sample apps in the project).

Support

When you are experiencing an issue on Element X Android, please first search in GitHub issues and then in #element-x-android:matrix.org. If after your research you still have a question, ask at #element-x-android:matrix.org. Otherwise feel free to create a GitHub issue if you encounter a bug or a crash, by explaining clearly in detail what happened. You can also perform bug reporting from the application settings. This is especially recommended when you encounter a crash.

Copyright © New Vector Ltd

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:

http://www.apache.org/licenses/LICENSE-2.0

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