Skip to content

Latest commit

 

History

History
100 lines (70 loc) · 6.96 KB

readme.md

File metadata and controls

100 lines (70 loc) · 6.96 KB
Raw

Translation status SchildiChat-Android Matrix room #android:schildi.chat

SchildiChat Android Next

Matrix client based on Element Android X in the tradition of the original SchildiChat for Android which was based on the now deprecated Element Android codebase.

Similarly to Element X, this SchildiChat Android rewrite should still be considered beta, as it lacks some functionality which one might expect from a fully-featured chat app, compared to the old SchildiChat implementation.

An overview over changes compared to Element X can be found here.

Note for F-Droid: You can get faster updates directly from the developer by adding the SpiritCroc F-Droid repository. These builds usually match the releases in the official F-Droid repository thanks to reproducible builds, but get built directly on app update and do not need to go through a possibly lengthy build process on the F-Droid servers.

Beta builds for testing pre-release versions are available from the SpiritCroc testing F-Droid repository under a different package name, and can thus be installed next to the stable release.

Translations

If you want to translate SchildiChat, visit our weblate.
Translations that concern upstream Element code are best contributed directly to Element, who currently manage translations on localazy.

Screenshots

Building

In general, building works the same as for Element X or any common Android project. Just import into Android Studio and make sure you have all the required SDKs ready.

Currently, SchildiChat uses a forked matrix-rust-sdk and wysiwyg published on GitHub packages, which unfortunately still does not provide unauthenticated access. Accordingly, before building, create a GitHub token with the read:packages permission, and configure it in your local.properties:

gpr.user=...
gpr.token=...

Alternatively, you may export the GPR_USER and GPR_TOKEN environment variables before building.

If you do not have a GitHub account, you can also download the appropriate .aar file from the SDK's releases and put it into ./libraries/rustsdk/matrix-rust-sdk.aar.

WYSIWYG development

To develop changes in our matrix-rich-text-editor fork:

Build WYSIWYG locally

  • Clone the repo
  • Bump the version number to some future version that doesn't exist yet using ./update_version 1.2.3 where 1.2.3 is your chosen version number. By not re-using any existing version number you can make sure you're using your local build if the build of SchildiChat succeeds.
  • Publish the wysiwyg by running make android in its directory. (Make sure you have JAVA_HOME, ANDROID_NDK_HOME and all the build dependencies setup)

Include local-built WYSIWYG in SchildiChat

  • Modify settings.gradle.kts to insert mavenLocal() into the dependencyResolutionManagement {} block. (Cherry-pick)
  • Change the version number of wysiwyg in gradle/libs.versions.toml to match the one you published locally.

Contributing

Generally, contributions are welcome!
Note that in order to ease upstream merges, we want to leave the smallest footprint possible on Element's sources when implementing original features or patching Element's behaviour.

In particular (may change a bit while the project is still in alpha):

  • Put code into additional files (chat.schildi.* package names) if reasonable
    • Prefer schildi/lib module if it doesn't depend on element modules (except maybe strings)
    • Prefer schildi/components module if it depend on some of Element's Design/UI components but nothing else
    • Otherwise, prefer element module where it makes most sense (or create a new module for bigger features, maybe)
  • Put Schildi-specific drawables and other xml resources that override upstream resources into the sc build flavor
    • This way, we can use the same name and avoid merge conflicts
    • Compare e.g. libraries/designsystem: we define the flavor sc and thus put drawables in the sc instead of main directory. For new modules that do not feature a sc flavor yet, copy over the required build.gradle.kts content from a module that does.
  • Put Schildi-specific strings into schildi/lib
    • Never touch upstream strings! If we want to change Element's strings, we'll either want a script that patches them, so we can restore upstream strings before upstream merges and re-do our changes automatically after the merge, or alternative put it into an sc build flavor, if we do not need to touch multiple translations.
  • Don't worry too much about code style if violating it can ease upstream merges
    • When putting upstream code into a new block (e.g., putting it in an if-statement), don't indent the upstream code, but rather add comments like // Wrong indention for merge-ability - start and // Wrong indention for merge-ability - end