RNS-Things/MeshChatX
2
0
Fork 0
Code Issues 8 Pull Requests Actions Packages Projects Releases Wiki Activity

docs(README): update project description, enhance feature list, and clarify migration warnings

Browse Source
This commit is contained in:
ivan
2026-01-01 23:44:14 -06:00
parent bce2237a1b
commit 18bcce4f4b
1 changed files with 18 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -1,34 +1,40 @@
# Reticulum MeshChatX # Reticulum MeshChatX
A heavily customized and updated fork of [Reticulum MeshChat](https://github.com/liamcottle/reticulum-meshchat). A [Reticulum MeshChat](https://github.com/liamcottle/reticulum-meshchat) fork from the future.
This project is seperate from the original Reticulum MeshChat project, and is not affiliated with the original project.
> [!WARNING]
> Backup your reticulum-meshchat folder before using, even though MeshChatX will attempt to auto-migrate whatever it can from the old database without breaking things. Its best to keep backups.
This project is seperate from the original Reticulum MeshChat project, and is not affiliated with the original project. It has been completely reworked, but I try to maintain a migrator to auto-migrate from old database to new one.
## Major Features ## Major Features
- Full LXST support w/ custom voicemail support (espeak-ng and ffmpeg required). - Full LXST support w/ custom voicemail, phonebook, contacts, contact sharing and ringtone support.
- Map (w/ MBTiles support for offline) - Multi-identity support.
- Security improvements - Authentication
- Custom UI/UX - Map (OpenLayers w/ MBTiles upload and exporter for offline maps)
- More Tools - Security improvements (automatic HTTPS, CORS, and much more)
- Built-in page archiving and automatic crawler (no multi-page support yet). - Modern Custom UI/UX
- Block LXMF users and NomadNet Nodes - More Tools (RNStatus, RNProbe, RNCP and Translator)
- Built-in page archiving and automatic crawler.
- Block LXMF users, Telephony and NomadNet Nodes
- Toast system for notifications - Toast system for notifications
- i18n support (En, De, Ru) - i18n support (En, De, Ru)
- Raw SQLite database backend (replaced Peewee ORM) - Raw SQLite database backend (replaced Peewee ORM)
- LXMF Telemetry (WIP)
## TODO ## TODO
- [ ] Tests and proper CI/CD pipeline. - [ ] Tests and proper CI/CD pipeline.
- [ ] RNS hot reload fix - [ ] RNS hot reload fix
- [ ] Backup/Import identities, messages and interfaces.
- [ ] Offline Reticulum documentation tool - [ ] Offline Reticulum documentation tool
- [ ] LXMF Telemtry for map
- [ ] Spam filter (based on keywords) - [ ] Spam filter (based on keywords)
- [ ] Multi-identity support.
- [ ] TAK tool/integration - [ ] TAK tool/integration
- [ ] RNS Tunnel - tunnel your regular services over RNS to another MeshchatX user. - [ ] RNS Tunnel - tunnel your regular services over RNS to another MeshchatX user.
- [ ] RNS Filesync - P2P file sync - [ ] RNS Filesync - P2P file sync
- [ ] RNS Page Node
- [ ] Micron Editor
## Usage ## Usage