diff --git a/android/README.md b/android/README.md new file mode 100644 index 0000000..e979c15 --- /dev/null +++ b/android/README.md @@ -0,0 +1,88 @@ +# MeshChatX Android App + +This directory contains the Android app build configuration using Chaquopy to embed the Python MeshChatX server. + +## Architecture + +The app uses a **WebView** to display the existing Vue.js frontend. The Python server runs in the background via Chaquopy and serves the web interface on `http://127.0.0.1:8000`. + +**No Kotlin frontend needed** - we reuse the entire existing Vue.js web frontend! + +## Prerequisites + +- Android Studio (latest version) +- Android SDK with API level 24+ (Android 7.0+) +- Chaquopy license (free for open source projects, see https://chaquo.com/chaquopy/pricing/) + +## Setup + +1. **Initialize Gradle Wrapper** (if not already done): + + ```bash + task android-init + ``` + + Or manually: + + ```bash + cd android + gradle wrapper --gradle-version 8.2 + ``` + +2. **Get Chaquopy License**: + - Sign up at https://chaquo.com/chaquopy/ + - Add your license key to `android/local.properties`: + ``` + chaquopy.license=your-license-key-here + ``` + +3. **Prepare Build**: + ```bash + task android-prepare + ``` + This will: + - Build the frontend + - Copy the `meshchatx` package to `app/src/main/python/` + - Initialize Gradle wrapper if needed + +## Building + +### Using Task (Recommended) + +```bash +# Build debug APK +task android-build + +# Build release APK (requires signing config) +task android-build-release +``` + +### Using Gradle Directly + +```bash +cd android +./gradlew assembleDebug +``` + +Or open the `android` directory in Android Studio and build from there. + +## Configuration + +The server is configured to: + +- Run on `127.0.0.1:8000` (localhost only) +- Use HTTP (not HTTPS) for local WebView access +- Run in headless mode (no browser launch) + +## Notes + +- The app requires network permissions for RNS/mesh networking +- Storage permissions are needed for identity and message storage +- The Python server runs in a background thread +- The WebView loads the Vue.js frontend after a 2-second delay to allow server startup + +## Troubleshooting + +- If the WebView shows a blank page, check logcat for Python errors +- Ensure all Python dependencies are listed in `app/build.gradle` chaquopy.pip block +- Some native dependencies (like RNS) may need additional configuration diff --git a/android/app/build.gradle b/android/app/build.gradle new file mode 100644 index 0000000..2506db1 --- /dev/null +++ b/android/app/build.gradle @@ -0,0 +1,79 @@ +plugins { + id 'com.android.application' + id 'com.chaquo.python' +} + +android { + namespace 'com.meshchatx' + compileSdk 34 + + defaultConfig { + applicationId "com.meshchatx" + minSdk 24 + targetSdk 34 + versionCode 1 + versionName "3.1.0" + + testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" + } + + buildTypes { + release { + minifyEnabled false + proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' + } + } + + compileOptions { + sourceCompatibility JavaVersion.VERSION_1_8 + targetCompatibility JavaVersion.VERSION_1_8 + } + + packagingOptions { + jniLibs { + useLegacyPackaging = true + } + } +} + +chaquopy { + defaultConfig { + version = "3.11" + buildPython "python3.11" + + pip { + install "aiohttp>=3.13.2" + install "lxmf>=0.9.3" + install "psutil>=7.1.3" + install "rns>=1.0.4" + install "websockets>=15.0.1" + install "bcrypt>=5.0.0,<6.0.0" + install "aiohttp-session>=2.12.1,<3.0.0" + install "cryptography>=46.0.3,<47.0.0" + install "requests>=2.32.5,<3.0.0" + install "lxst>=0.4.5,<0.5.0" + install "ply>=3.11,<4.0" + } + } + + sourceSets { + main { + python { + srcDirs = ["src/main/python"] + } + } + } +} + +dependencies { + implementation 'androidx.appcompat:appcompat:1.6.1' + implementation 'com.google.android.material:material:1.10.0' + implementation 'androidx.constraintlayout:constraintlayout:2.1.4' + implementation 'androidx.webkit:webkit:1.8.0' + implementation 'androidx.lifecycle:lifecycle-runtime-ktx:2.6.2' + + testImplementation 'junit:junit:4.13.2' + androidTestImplementation 'androidx.test.ext:junit:1.1.5' + androidTestImplementation 'androidx.test.espresso:espresso-core:3.5.1' +} + diff --git a/android/app/src/main/AndroidManifest.xml b/android/app/src/main/AndroidManifest.xml new file mode 100644 index 0000000..c354e67 --- /dev/null +++ b/android/app/src/main/AndroidManifest.xml @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/android/app/src/main/java/com/meshchatx/MainActivity.java b/android/app/src/main/java/com/meshchatx/MainActivity.java new file mode 100644 index 0000000..4374bc8 --- /dev/null +++ b/android/app/src/main/java/com/meshchatx/MainActivity.java @@ -0,0 +1,96 @@ +package com.meshchatx; + +import android.annotation.SuppressLint; +import android.os.Bundle; +import android.webkit.WebSettings; +import android.webkit.WebView; +import android.webkit.WebViewClient; +import android.widget.ProgressBar; +import androidx.appcompat.app.AppCompatActivity; +import com.chaquo.python.Python; +import com.chaquo.python.android.AndroidPlatform; + +public class MainActivity extends AppCompatActivity { + private WebView webView; + private ProgressBar progressBar; + private static final String SERVER_URL = "http://127.0.0.1:8000"; + private static final int SERVER_PORT = 8000; + + @SuppressLint("SetJavaScriptEnabled") + @Override + protected void onCreate(Bundle savedInstanceState) { + super.onCreate(savedInstanceState); + setContentView(R.layout.activity_main); + + webView = findViewById(R.id.webView); + progressBar = findViewById(R.id.progressBar); + + if (!Python.isStarted()) { + Python.start(new AndroidPlatform(this)); + } + + WebSettings webSettings = webView.getSettings(); + webSettings.setJavaScriptEnabled(true); + webSettings.setDomStorageEnabled(true); + webSettings.setDatabaseEnabled(true); + webSettings.setAllowFileAccess(true); + webSettings.setAllowContentAccess(true); + webSettings.setMixedContentMode(WebSettings.MIXED_CONTENT_ALWAYS_ALLOW); + + webView.setWebViewClient(new WebViewClient() { + @Override + public void onPageFinished(WebView view, String url) { + super.onPageFinished(view, url); + progressBar.setVisibility(android.view.View.GONE); + } + + @Override + public void onPageStarted(WebView view, String url, android.graphics.Bitmap favicon) { + super.onPageStarted(view, url, favicon); + progressBar.setVisibility(android.view.View.VISIBLE); + } + }); + + startMeshChatServer(); + + new Thread(() -> { + try { + Thread.sleep(2000); + } catch (InterruptedException e) { + e.printStackTrace(); + } + runOnUiThread(() -> { + webView.loadUrl(SERVER_URL); + }); + }).start(); + } + + private void startMeshChatServer() { + new Thread(() -> { + try { + Python py = Python.getInstance(); + py.getModule("meshchat_wrapper").callAttr("start_server", SERVER_PORT); + } catch (Exception e) { + e.printStackTrace(); + } + }).start(); + } + + @Override + public void onBackPressed() { + if (webView.canGoBack()) { + webView.goBack(); + } else { + super.onBackPressed(); + } + } + + @Override + protected void onDestroy() { + super.onDestroy(); + if (webView != null) { + webView.destroy(); + } + } +} + diff --git a/android/app/src/main/python/meshchat_wrapper.py b/android/app/src/main/python/meshchat_wrapper.py new file mode 100644 index 0000000..7882f30 --- /dev/null +++ b/android/app/src/main/python/meshchat_wrapper.py @@ -0,0 +1,21 @@ +import sys + +def start_server(port=8000): + try: + from meshchatx.meshchat import main + + sys.argv = [ + 'meshchat', + '--headless', + '--host', '127.0.0.1', + '--port', str(port), + '--no-https' + ] + + main() + except Exception as e: + print(f"Error starting MeshChatX server: {e}") + import traceback + traceback.print_exc() + raise + diff --git a/android/app/src/main/res/layout/activity_main.xml b/android/app/src/main/res/layout/activity_main.xml new file mode 100644 index 0000000..8fc7bca --- /dev/null +++ b/android/app/src/main/res/layout/activity_main.xml @@ -0,0 +1,29 @@ + + + + + + + + + diff --git a/android/app/src/main/res/values/colors.xml b/android/app/src/main/res/values/colors.xml new file mode 100644 index 0000000..46d2800 --- /dev/null +++ b/android/app/src/main/res/values/colors.xml @@ -0,0 +1,11 @@ + + + #FFBB86FC + #FF6200EE + #FF3700B3 + #FF03DAC5 + #FF018786 + #FF000000 + #FFFFFFFF + + diff --git a/android/app/src/main/res/values/strings.xml b/android/app/src/main/res/values/strings.xml new file mode 100644 index 0000000..e8eae5d --- /dev/null +++ b/android/app/src/main/res/values/strings.xml @@ -0,0 +1,5 @@ + + + MeshChatX + + diff --git a/android/app/src/main/res/values/themes.xml b/android/app/src/main/res/values/themes.xml new file mode 100644 index 0000000..a0ae9bd --- /dev/null +++ b/android/app/src/main/res/values/themes.xml @@ -0,0 +1,13 @@ + + + + + diff --git a/android/build.gradle b/android/build.gradle new file mode 100644 index 0000000..1556385 --- /dev/null +++ b/android/build.gradle @@ -0,0 +1,24 @@ +buildscript { + repositories { + google() + mavenCentral() + maven { url "https://chaquo.com/maven" } + } + dependencies { + classpath 'com.android.tools.build:gradle:8.7.3' + classpath "com.chaquo.python:gradle:15.0.1" + } +} + +allprojects { + repositories { + google() + mavenCentral() + maven { url "https://chaquo.com/maven" } + } +} + +task clean(type: Delete) { + delete rootProject.buildDir +} + diff --git a/android/gradle.properties b/android/gradle.properties new file mode 100644 index 0000000..fdea6eb --- /dev/null +++ b/android/gradle.properties @@ -0,0 +1,4 @@ +org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8 +android.useAndroidX=true +android.enableJetifier=true + diff --git a/android/gradle/wrapper/gradle-wrapper.jar b/android/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..033e24c Binary files /dev/null and b/android/gradle/wrapper/gradle-wrapper.jar differ diff --git a/android/gradle/wrapper/gradle-wrapper.properties b/android/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..42d8b50 --- /dev/null +++ b/android/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,8 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.12.1-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists + diff --git a/android/gradlew b/android/gradlew new file mode 100755 index 0000000..8b7901c --- /dev/null +++ b/android/gradlew @@ -0,0 +1,249 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://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. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" + diff --git a/android/gradlew.bat b/android/gradlew.bat new file mode 100644 index 0000000..e240214 --- /dev/null +++ b/android/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega + diff --git a/android/settings.gradle b/android/settings.gradle new file mode 100644 index 0000000..8250daf --- /dev/null +++ b/android/settings.gradle @@ -0,0 +1,21 @@ +pluginManagement { + repositories { + google() + mavenCentral() + gradlePluginPortal() + maven { url "https://chaquo.com/maven" } + } +} + +dependencyResolutionManagement { + repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS) + repositories { + google() + mavenCentral() + maven { url "https://chaquo.com/maven" } + } +} + +rootProject.name = "MeshChatX" +include ':app' + diff --git a/docs/meshchat_on_android_with_termux.md b/docs/meshchat_on_android_with_termux.md index 14eedcc..efd6ccf 100644 --- a/docs/meshchat_on_android_with_termux.md +++ b/docs/meshchat_on_android_with_termux.md @@ -1,31 +1,83 @@ -# MeshChat on Android +# MeshChatX on Android -It's possible to run on Android from source, using [Termux](https://termux.dev/). +It's possible to run MeshChatX on Android using [Termux](https://termux.dev/). Installation is now much simpler since the wheel package includes both the server and pre-built web assets. -You will need to install a few extra dependencies and make a change to `requirements.txt`. +## Method 1: Install from Wheel (Recommended) + +This is the easiest method - the wheel includes everything you need. + +### Install System Dependencies ``` pkg upgrade -pkg install git -pkg install nodejs-lts -pkg install python-pip +pkg install python pkg install rust pkg install binutils pkg install build-essential ``` -You should now be able to follow the [how to use it](../README.md#how-to-use-it) instructions above. +> Note: Python 3.11 or higher is required. Check with `python --version`. -Before running `pip install -r requirements.txt`, you will need to comment out the `cx_freeze` dependency. It failed to build on my Android tablet, and is not actually required for running from source. +### Download and Install Wheel + +Download the latest wheel from the [releases page](https://git.quad4.io/Ivan/MeshChatX/releases), then: ``` -nano requirements.txt +pip install reticulum_meshchatx-*-py3-none-any.whl ``` -Ensure the `cx_freeze` line is updated to `#cx_freeze` +The wheel will automatically install all Python dependencies. Building `cryptography` may take a while on Android. -> Note: Building wheel for cryptography may take a while on Android. +### Run MeshChatX -Once MeshChat is running via Termux, open your favourite Android web browser, and navigate to http://localhost:8000 +``` +meshchat +``` -> Note: The default `AutoInterface` may not work on your Android device. You will need to configure another interface such as `TCPClientInterface`. +Then open your Android web browser and navigate to `http://localhost:8000` + +## Method 2: Install from Source + +If you need to build from source (for development or if no wheel is available for your architecture): + +### Install System Dependencies + +``` +pkg upgrade +pkg install git +pkg install nodejs-lts +pkg install python +pkg install rust +pkg install binutils +pkg install build-essential +``` + +### Install pnpm + +``` +corepack enable +corepack prepare pnpm@latest --activate +``` + +### Clone and Build + +``` +git clone https://git.quad4.io/Ivan/MeshChatX.git +cd MeshChatX +pip install poetry +poetry install +pnpm install +pnpm run build-frontend +poetry build -f wheel +pip install dist/*.whl +``` + +### Run MeshChatX + +``` +meshchat +``` + +## Configuration Notes + +> Note: The default `AutoInterface` may not work on your Android device. You will need to configure another interface such as `TCPClientInterface` in the settings.