Skip to content

Latest commit

 

History

History
204 lines (160 loc) · 10.7 KB

README.md

File metadata and controls

204 lines (160 loc) · 10.7 KB
Raw

Robrix: a Rust Matrix client built atop Robius

Robrix Matrix Chat Project Robius Matrix Chat

Robrix is a Matrix chat client written in Rust to demonstrate the functionality of Project Robius, a framework for multi-platform application development in Rust. Robrix is written using the Makepad UI toolkit.

▶️ Click here to see the Robrix project tracker!

Note

⚠️ Robrix is a work-in-progress that doesn't yet support all Matrix chat features.

Check out our most recent talks and presentations for more info:

The following table shows which host systems can currently be used to build Robrix for which target platforms.

Host OS Target Platform Builds? Runs?
macOS macOS ✅ ✅
macOS Android ✅ ✅
macOS iOS ✅ ✅
Linux Linux ✅ ✅
Linux Android ✅ ✅
Windows Windows ✅ ✅
Windows Android ✅ ✅

Building and Running

  1. First, install Rust.

  2. If you're building on Linux or WSL on Windows, install the required dependencies. Otherwise, proceed to step 3.

    • openssl, clang/libclang, binfmt, Xcursor/X11, asound/pulse.

    On a Debian-like Linux distro (e.g., Ubuntu), run the following:

    sudo apt-get update
sudo apt-get install libssl-dev libsqlite3-dev pkg-config binfmt-support libxcursor-dev libx11-dev libasound2-dev libpulse-dev

  3. Then, build and run Robrix (you can optionally add --release after run):

cargo run -- 'USERNAME' 'PASSWORD' ['HOMESERVER_URL']
  • Robrix only supports a standard username + password login currently.
    • Note the usage of single quotes (not double quotes), which will prevent your shell from treating certain symbols as globs/regex patterns.
    • If you created your Matrix account using a third-party Single Sign On (SSO) like a Google account, you can set a standard password by using Element's password reset form.
  • The HOMESERVER_URL argument is optional and uses the "https://matrix-client.matrix.org/" URL by default.
    • The Matrix homeserver must support Sliding Sync, the same requirement as Element X.

Building Robrix for Android

  1. Install the cargo-makepad build tool:

    cargo install --force --git https://github.com/makepad/makepad.git --branch rik cargo-makepad

  2. Use cargo-makepad to install the Android toolchain, with the full NDK:

    cargo makepad android install-toolchain --full-ndk

  3. Build and run Robrix using cargo-makepad:

    cargo makepad android run -p robrix --release
    • You'll need to connect a physical Android device with developer options enabled, or start up an emulator using Android Studio.
      • API version 33 or higher is required, which is Android 13 and up.

Feature status tracker

These are generally sorted in order of priority. If you're interested in helping out with anything here, please reach out via a GitHub issue or on our Robius matrix channel.

Basic room views and fundamental actions

  • View list of joined rooms
  • View timeline of events in a single room
  • Fetch and display room avatars
  • Fetch user profiles (displayable names)
  • Fetch and display user profile avatars
  • Backwards pagination (upon viewing a room timeline)
  • Dynamic backwards pagination based on scroll position/movement: #109
  • Loading animation while waiting for pagination request: #109
  • Stable positioning of events during simple timeline update
  • Stable positioning of events during complex/multi-part timeline update
  • Display simple text-only messages
  • Display image messages (PNG, JPEG)
  • Rich text formatting for message bodies
  • Display reactions (annotations)
  • Handle opening links on click
  • Linkify plaintext hyperlinks
  • Reply previews above messages: #82
  • Send messages (standalone, no replies)
  • Interactive reaction button, send reactions: #115
  • Reply button, send reply: #83
  • Re-spawn timeline as focused on an old event after a full timeline clear: #103
  • Display multimedia (audio/video/gif) message events: #120
  • Collapsible/expandable view of contiguous "small" events: #118
  • E2EE device verification, decrypt message content: #116

Auxiliary/admin features: login, registration, settings

  • Persistence of app session to disk: #112
  • Username/password login screen: #113
  • SSO, other 3rd-party auth providers login screen: #114
  • Side panel showing detailed user profile info (click on their Avatar)
  • Ignore and unignore users (see known issues)
  • User settings screen
  • Dedicated view of spaces
  • Dedicated view of direct messages (DMs): #139
  • Link previews beneath messages: #81
  • Keyword filters for the list of all rooms: #123
  • Search messages within a room: #122
  • Room browser, search for public rooms
  • Room creation
  • Room settings/info screen
  • Room members pane
  • Save/restore events in rooms to/from the event cache upon app shutdown/start: #164

Known problems/issues

  • Matrix-specific links are not yet fully handled (https://matrix.to/...)
  • Ignoring/unignoring a user clears all timelines (see: matrix-org/matrix-rust-sdk#1703); the timeline will be re-filled using gradual pagination, but the viewport is not maintained

Packaging Robrix for Distribution on Desktop Platforms

Tip

We already have pre-built releases of Robrix available for download.

  1. Install cargo-packager:
rustup update stable  ## Rust version 1.79 or higher is required
cargo +stable install --force --locked cargo-packager

For posterity, these instructions have been tested on cargo-packager version 0.10.1, which requires Rust v1.79.

  1. Install the robius-packaging-commands crate with the makepad feature enabled:
cargo install --locked --git https://github.com/project-robius/robius-packaging-commands.git
  1. Then run the packaging command, which must build in release mode:
cargo packager --release ## --verbose is optional

Platform-specific considerations

Note that due to platform restrictions, you can currently only build:

  • Linux packages on a Linux OS machine
  • Windows installer executables on a Windows OS machine
  • macOS disk images / app bundles on a macOS machine
  • iOS apps on a macOS machine.
  • Android, on a machine with any OS!

There are some additional considerations when packaging Robrix for macOS:

Important

You will see a .dmg window pop up — please leave it alone, it will auto-close once the packaging procedure has completed.

Tip

If you receive the following error:

ERROR cargo_packager::cli: Error running create-dmg script: File exists (os error 17)

then open Finder and unmount any Robrix-related disk images, then try the above cargo packager command again.

Tip

If you receive an error like so:

Creating disk image...
hdiutil: create failed - Operation not permitted
could not access /Volumes/Robrix/Robrix.app - Operation not permitted

then you need to grant "App Management" permissions to the app in which you ran the cargo packager command, e.g., Terminal, Visual Studio Code, etc. To do this, open System Preferences → Privacy & Security → App Management, and then click the toggle switch next to the relevant app to enable that permission. Then, try the above cargo packager command again.

After the command completes, you should see both the Robrix.app and the .dmg in the dist/ directory. You can immediately double-click the Robrix.app bundle to run it, or you can double-click the .dmg file to

Note that the .dmg is what should be distributed for installation on other machines, not the .app.

If you'd like to modify the .dmg background, here is the Google Drawings file used to generate the MacOS .dmg background image.