mirror of
https://github.com/ArcaneChat/android.git
synced 2026-07-03 14:05:24 +02:00
Alexander Krotov
132 lines
5.1 KiB
Markdown
132 lines
5.1 KiB
Markdown
## Delta Chat Android Client
|
|
|
|
This is the Android client for [Delta Chat](https://delta.chat/).
|
|
It is available on [F-Droid](https://f-droid.org/app/com.b44t.messenger) and
|
|
the [Google Play Store](https://play.google.com/store/apps/details?id=chat.delta).
|
|
The APK can also be downloaded from [GitHub](https://github.com/deltachat/deltachat-android/releases)
|
|
(only for experienced users).
|
|
|
|
For the core library and other common info, please refer to the
|
|
[Delta Chat Core Library](https://github.com/deltachat/deltachat-core-rust).
|
|
|
|
<img alt="Screenshot Chat List" src="docs/images/2019-01-chatlist.png" width="298" /> <img alt="Screenshot Chat View" src="docs/images/2019-01-chat.png" width="298" />
|
|
|
|
|
|
# Check Out Repository
|
|
|
|
When checking out _deltachat-android_, make sure also to check out the
|
|
subproject _deltachat-core-rust_:
|
|
|
|
- When using Git, you can do this initially by
|
|
`$ git clone --recursive https://github.com/deltachat/deltachat-android`
|
|
or later by `git submodule update --init --recursive`. If you do this in your
|
|
home directory, this results in the folder `~/deltachat-android` which is just fine.
|
|
|
|
# Build Using Dockerfile
|
|
|
|
If you only want to build an APK, the easiest way is to use
|
|
provided `Dockerfile` with [Docker](https://www.docker.com/) or
|
|
[Podman](https://podman.io/). Podman is a drop-in replacement for Docker
|
|
that does not require root privileges.
|
|
|
|
First, build the image `deltachat-android` by running
|
|
```
|
|
podman build --build-arg UID=$(id -u) --build-arg GID=$(id -g) . -t deltachat-android
|
|
```
|
|
or
|
|
```
|
|
docker build --build-arg UID=$(id -u) --build-arg GID=$(id -g) . -t deltachat-android
|
|
```
|
|
|
|
Then, run the image:
|
|
```
|
|
podman run --userns=keep-id -it --name deltachat -v $(pwd):/home/app -w /home/app localhost/deltachat-android
|
|
```
|
|
or
|
|
```
|
|
docker run -it --name deltachat -v $(pwd):/home/app -w /home/app localhost/deltachat-android
|
|
```
|
|
|
|
Within the container, install toolchains and build the native library:
|
|
```
|
|
deltachat@6012dcb974fe:/home/app$ scripts/install-toolchains.sh
|
|
deltachat@6012dcb974fe:/home/app$ ./ndk-make.sh
|
|
```
|
|
|
|
Then, [build an APK](https://developer.android.com/studio/build/building-cmdline):
|
|
```
|
|
deltachat@6012dcb974fe:/home/app$ ./gradlew assembleDebug
|
|
```
|
|
|
|
If you don't want to use Docker or Podman, proceed to the next section.
|
|
|
|
# Install Build Environment
|
|
|
|
To setup build environment manually, you can read the `Dockerfile`
|
|
and mimic what it does.
|
|
|
|
First, you need to setup Android SDK and Android NDK. Configure
|
|
`ANDROID_NDK_ROOT` environment variable to point to the Android NDK
|
|
installation directory. Currently ndk20b is the minimum required version.
|
|
Newer versions will likely work, however, are not tested and not used
|
|
in official releases, in general, changes on the ndk-version should be
|
|
done with care.
|
|
|
|
Then, install Rust using [rustup](https://rustup.rs/). Install Rust
|
|
toolchains for cross-compilation by executing `scripts/install-toolchains.sh`.
|
|
|
|
After that, call `./ndk-make.sh` in the root directory to build core-rust.
|
|
Afterwards run the project in Android Studio. The project requires API 25.
|
|
|
|
With chance, that's it :) - if not, read on how to set up a proper development
|
|
environment.
|
|
|
|
|
|
# Install Development Environment
|
|
|
|
1. Some libs required by Android Studio may be missing on 64 bit Linux machines
|
|
[Source](https://developer.android.com/studio/install.html)], so for Ubuntu execute
|
|
`$ sudo apt-get install libc6:i386 libncurses5:i386 libstdc++6:i386 lib32z1 libbz2-1.0:i386`
|
|
and for Fedora execute
|
|
`$ sudo yum install zlib.i686 ncurses-libs.i686 bzip2-libs.i686`.
|
|
|
|
2. Download Android Studio from <https://developer.android.com> (android-studio-ide-...-linux.zip)
|
|
and unpack the archive which contains a single folder called `android-studio`;
|
|
move this folder e.g. to `~/android-studio`.
|
|
|
|
3. To launch Android Studio for the first time, open a terminal, navigate to
|
|
`~/android-studio/bin`, execute `./studio.sh` and use all the standard values
|
|
from the wizard.
|
|
|
|
4. Android Studio now asks you if you want to open an existing project;
|
|
choose `~/deltachat-android` as created in the "Build" chapter (Android Studio starts to
|
|
build the project, however, there are some steps missing before this will
|
|
succeed).
|
|
|
|
5. If components are missing, click on the corresponding error
|
|
message and install eg. required SDKs and the "Build-Tools" (you should
|
|
also find the option at "Tools / Android / SDK Manager / SDK Platforms").
|
|
Now the build should succeed - but the app still misses the native part.
|
|
|
|
6. Download Android NDK from
|
|
[NDK Archives](https://developer.android.com/ndk/downloads)
|
|
and extract the archive containing a single folder
|
|
called `android-ndk-r…`; move this folder e.g. to `~/android-ndk-r…`.
|
|
|
|
7. Export the folder path to your environment as `ANDROID_NDK` and add it to `PATH`.
|
|
You can achieve this e.g. by adding the following lines to `.bashrc`
|
|
`export ANDROID_NDK=/home/USERNAME/android-ndk-r…`
|
|
`export PATH=$PATH:$ANDROID_NDK`.
|
|
|
|
|
|
# Credits
|
|
|
|
The user interface classes are based on the Signal messenger.
|
|
|
|
|
|
# License
|
|
|
|
Licensed GPLv3+, see the LICENSE file for details.
|
|
|
|
Copyright © 2020 Delta Chat contributors.
|