Metadata-Version: 2.4
Name: reticulum-meshchatx
Version: 4.9.0
Summary: A simple mesh network communications app powered by the Reticulum Network Stack
Author: Quad4
License-Expression: 0BSD AND MIT
Project-URL: Homepage, https://github.com/Quad4-Software/MeshChatX
Keywords: reticulum,meshchat,meshchatx,lxmf,rns
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Other Audience
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Communications
Classifier: Topic :: Software Development :: Build Tools
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiohttp>=3.14.3
Requires-Dist: aioquic>=1.3.0
Requires-Dist: lxmf>=1.1.1
Requires-Dist: psutil>=7.2.2
Requires-Dist: pyserial>=3.5
Requires-Dist: rns>=1.5.3
Requires-Dist: websockets>=17.1
Requires-Dist: bcrypt<6.0.0,>=5.0.0
Requires-Dist: aiohttp-session<3.0.0,>=2.12.1
Requires-Dist: cryptography<51.0.0,>=50.0.1
Requires-Dist: pycparser>=3.0
Requires-Dist: audioop-lts>=0.2.2; python_version >= "3.13"
Requires-Dist: ply<4.0,>=3.11
Requires-Dist: lxst>=0.5.2
Requires-Dist: miniaudio<2.0,>=1.70
Requires-Dist: cbor2>=6.1.4
Requires-Dist: wasmtime>=48.0.0
Requires-Dist: bleak<4.0,>=3.0.2
Requires-Dist: httpx[http2]<1.0,>=0.28.1
Dynamic: license-file

# Reticulum MeshChatX

[Русский](lang/README.ru.md) | [Deutsch](lang/README.de.md) | [Italiano](lang/README.it.md) | [中文](lang/README.zh.md) | [日本語](lang/README.ja.md)

Initially MeshChatX was a fork of Reticulum MeshChat by Liam Cottle. It has evolved to be very much different and focused on modern software development principles. It may be buggy due to many changes and adapted to make it more maintainable and end goal of improving stability.

There are many changes from MeshChat: LXST, [RRC](https://rrc.kc1awv.net/0) relay chat, a dedicated Map that is offline ready, raw SQL instead of an ORM, native fetch instead of Axios, latest stable Electron, wheels with bundled frontend, i18n, pnpm 11+ with supply chain security.

MeshChatX is also focused on security and privacy, including usage of native OS sandboxing like AppContainer for windows and Landlock for linux.

AI Disclaimer: Open-weight LLMs may used to assist with development and maintaining the project, but all code is reviewed by humans and follows best practices.

- Website: [meshchatx.com](https://meshchatx.com)
- Source: [github.com/Quad4-Software/MeshChatX](https://github.com/Quad4-Software/MeshChatX)
- Mirror: [lavaforge.org/Reticulum-Things/MeshChatX](https://lavaforge.org/Reticulum-Things/MeshChatX)
- PyPI: [reticulum-meshchatx](https://pypi.org/project/reticulum-meshchatx/)
- Changelog: [CHANGELOG.md](CHANGELOG.md)
- Donate: [donate.md](donate.md)
- LXMF: `f489752fbef161c64d65e385a4e9fc74`

<a href="https://apps.obtainium.imranr.dev/redirect.html?r=obtainium://add/https://github.com/Quad4-Software/MeshChatX"><img src="https://raw.githubusercontent.com/ImranR98/Obtainium/main/assets/graphics/badge_obtainium.png" height="60" alt="Get it on Obtainium"></a>

rngit NomadNet Node: `132f67e79d9b24aad014e93015fb858f:/page/index.mu`

## Install/Usage Methods

There are many ways you can use MeshChatX.

### Docker

```bash
docker compose -f docker/docker-compose.yml up -d
```

```bash
docker run -d --name reticulum-meshchatx \
  -p 127.0.0.1:8000:8000 \
  -v meshchatx-config:/config \
  ghcr.io/quad4-software/meshchatx:latest
```

Container Images: `quad4io/meshchatx` (Docker Hub) and `ghcr.io/quad4-software/meshchatx`. Hardened and extra tags are in [Installation](docs/en/installation.md).

### PyPI (pip, pipx, uv)

```bash
pip install reticulum-meshchatx
# or
pipx install reticulum-meshchatx
# or
uv pip install reticulum-meshchatx
```

```bash
meshchatx --headless --host 127.0.0.1
```

meshchat is the same entry point. Release wheels from GitHub also work: pip install ./reticulum_meshchatx-*-py3-none-any.whl.

### From source (git clone, make, task)

HTTPS:

```bash
git clone https://github.com/Quad4-Software/MeshChatX.git
cd MeshChatX

# Over Reticulum (rngit / git-remote-rns):

git clone rns://06a54b505bb67b25ef3f8097e8001edc/public/MeshChatX
cd MeshChatX
```

Then install and run with either Make or Task (same targets):

```bash
make install && make build && make run

# or taskfile

task install && task build && task run

# Or through UV / pnpm yourself:

corepack enable
pnpm install --frozen-lockfile
uv sync --group dev
pnpm run build-frontend
uv run python -m meshchatx.meshchat --headless --host 127.0.0.1
```

AppImage, deb, rpm, Flatpak, Electron, and Android: [Installation](docs/en/installation.md) and [Building](docs/en/building.md).

Current version is 4.9.0.

## Docs

| Guide                                                       | Covers                                 |
| ----------------------------------------------------------- | -------------------------------------- |
| [Getting started](docs/en/getting-started.md)               | First-day flow                         |
| [Installation](docs/en/installation.md)                     | Docker details, packages, CLI flags    |
| [Building](docs/en/building.md)                             | Offline builds, packaging, Android APK |
| [Development](docs/en/development.md)                       | task/make, versioning, locales         |
| [Identities and security](docs/en/identity-and-security.md) | Backups, corruption recovery, wipe     |
| [Platform guides](docs/en/platform-guides/)                 | Pi, Termux, Quest, Linux sandbox       |

## Security, license, credits

- [SECURITY.md](SECURITY.md) · [LEGAL.md](LEGAL.md) · [donate.md](donate.md)
- Project-owned code is 0BSD. Upstream MeshChat portions remain MIT. Full text: [LICENSE](LICENSE).
- Credits: [Liam Cottle](https://github.com/liamcottle) (original MeshChat), [RFnexus](https://github.com/RFnexus) (micron parser JS), [markqvist](https://github.com/markqvist) (Reticulum, LXMF, LXST).
