diff --git a/README.md b/README.md
index 0c09690..29c0b38 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
-
-Reticulum WebChat
+Reticulum MeshChat
-## What is Reticulum WebChat?
+## What is Reticulum MeshChat?
A simple mesh network communications app powered by the [Reticulum Network Stack](https://github.com/markqvist/Reticulum).
@@ -30,7 +30,7 @@ A simple mesh network communications app powered by the [Reticulum Network Stack
## Features
-- Supports sending and receiving messages between [Reticulum WebChat](https://github.com/liamcottle/reticulum-webchat), [Sideband](https://github.com/markqvist/Sideband/) and [Nomadnet](https://github.com/markqvist/nomadnet).
+- Supports sending and receiving messages between [Reticulum MeshChat](https://github.com/liamcottle/reticulum-meshchat), [Sideband](https://github.com/markqvist/Sideband/) and [Nomadnet](https://github.com/markqvist/nomadnet).
- Supports receiving and saving images and attachments sent from Sideband.
- Supports sending images and file attachments.
- Supports saving inbound and outbound messages to a local database.
@@ -40,7 +40,7 @@ A simple mesh network communications app powered by the [Reticulum Network Stack
## Beta Features
-- Support for Audio Calls to other [Reticulum WebChat](https://github.com/liamcottle/reticulum-webchat) users.
+- Support for Audio Calls to other [Reticulum MeshChat](https://github.com/liamcottle/reticulum-meshchat) users.
- Audio is encoded with [codec2](https://github.com/drowe67/codec2) to support low bandwidth links.
- Using a microphone requires using the web ui over localhost or https, due to [AudioWorklet](https://developer.mozilla.org/en-US/docs/Web/API/AudioWorklet) secure context.
- I have tested two-way audio calls over LoRa with a single hop. It works well when a [reasonable bitrate](https://unsigned.io/understanding-lora-parameters/) is configured on the RNode.
@@ -50,7 +50,7 @@ A simple mesh network communications app powered by the [Reticulum Network Stack
## Download
-You can download the latest version for Windows and Mac from the [releases](https://github.com/liamcottle/reticulum-webchat/releases) page.
+You can download the latest version for Windows and Mac from the [releases](https://github.com/liamcottle/reticulum-meshchat/releases) page.
Alternatively, you can download the source and run it manually from a command line.
@@ -58,7 +58,7 @@ See the ["How to use it?"](#how-to-use-it) section below on how to do this.
## Getting Started
-Once you've downloaded, installed and launched Reticulum WebChat, there's a few things you need to do in order to start communicating with other people on the network.
+Once you've downloaded, installed and launched Reticulum MeshChat, there's a few things you need to do in order to start communicating with other people on the network.
1. Create an Identity
2. Configure your Display Name
@@ -74,9 +74,9 @@ A Reticulum Identity is a public/private key-pair. You control the private key u
Your public key is shared with the network when you send an announce, and allows others on the network to automatically discover a route to a destination you control.
-At this time, Reticulum WebChat generates a new Identity the first time you launch it. A future update will allow you to create and manage multiple identities.
+At this time, Reticulum MeshChat generates a new Identity the first time you launch it. A future update will allow you to create and manage multiple identities.
-For now, if you want to change, or reset your identity, you can access the identity file at `~/.reticulum-webchat/identity`.
+For now, if you want to change, or reset your identity, you can access the identity file at `~/.reticulum-meshchat/identity`.
**Configure your Display Name**
@@ -106,7 +106,7 @@ When someone else on the network announces themselves (more specifically, their
You can click on any of these discovered peers to open a messaging interface. From here, you can send text messages, files and inline images. If they respond, their messages will show up there too.
-As well as being able to announce your LXMF address and discover others, Reticulum WebChat can also discover [Nomad Network](https://github.com/markqvist/nomadnet) nodes hosted by other users. From the Nodes tab, you are free to explore pages and download files they may be publicly sharing on the network.
+As well as being able to announce your LXMF address and discover others, Reticulum MeshChat can also discover [Nomad Network](https://github.com/markqvist/nomadnet) nodes hosted by other users. From the Nodes tab, you are free to explore pages and download files they may be publicly sharing on the network.
A future update is planned to allow you to host your own Node and share pages and files with other peers on the network. For now, you could use the official [Nomad Network](https://github.com/markqvist/nomadnet) client to do this.
@@ -128,8 +128,8 @@ Remember, in order to connect with other peers or nodes, they must announce on t
If you don't want to, or can't [download](#download) a standalone application, you will need to install [Python 3](https://www.python.org/downloads/), clone the source code from this repo, install dependencies and then run `web.py`.
```
-git clone https://github.com/liamcottle/reticulum-webchat
-cd reticulum-webchat
+git clone https://github.com/liamcottle/reticulum-meshchat
+cd reticulum-meshchat
pip install -r requirements.txt
python web.py
```
@@ -146,7 +146,7 @@ python web.py --help
usage: web.py [-h] [--host [HOST]] [--port [PORT]] [--headless] [--identity-file IDENTITY_FILE] [--identity-base64 IDENTITY_BASE64] [--generate-identity-file GENERATE_IDENTITY_FILE] [--generate-identity-base64]
[--reticulum-config-dir RETICULUM_CONFIG_DIR] [--storage-dir STORAGE_DIR]
-ReticulumWebChat
+ReticulumMeshChat
options:
-h, --help show this help message and exit
@@ -204,7 +204,7 @@ python web.py --identity-base64 "GCN6mMhVemdNIK/fw97C1zvU17qjQPFTXRBotVckeGmoOwQ
## Build Electron Application
-Reticulum WebChat can be run from source via a command line, as explained above, or as a standalone application.
+Reticulum MeshChat can be run from source via a command line, as explained above, or as a standalone application.
To run as a standalone application, we need to compile the python script and dependencies to an executable with [cxfreeze](https://github.com/marcelotduarte/cx_Freeze) and then build an [Electron](https://www.electronjs.org/) app which includes a bundled browser that can interact with the compiled python executable.
diff --git a/electron/loading.html b/electron/loading.html
index f26e461..ca16f80 100644
--- a/electron/loading.html
+++ b/electron/loading.html
@@ -3,7 +3,7 @@
Reticulum WebChat
+ Reticulum MeshChat
@@ -17,7 +17,7 @@
-
Reticulum WebChat
+
Reticulum MeshChat
Phone | Reticulum WebChat
+ Phone | Reticulum MeshChat
diff --git a/public/index.html b/public/index.html
index 209e447..1cfe73a 100644
--- a/public/index.html
+++ b/public/index.html
@@ -4,7 +4,7 @@
Reticulum WebChat
+ Reticulum MeshChat
@@ -25,7 +25,7 @@
-
Reticulum WebChat
+
Reticulum MeshChat
Reticulum WebChat must be restarted for any interface changes to take effect.
+ Reticulum MeshChat must be restarted for any interface changes to take effect.
diff --git a/public/network.html b/public/network.html
index 33b7581..bdeac1a 100644
--- a/public/network.html
+++ b/public/network.html
@@ -4,7 +4,7 @@
Network | Reticulum WebChat
+ Network | Reticulum MeshChat
diff --git a/setup.py b/setup.py
index 5e30678..ccb931d 100644
--- a/setup.py
+++ b/setup.py
@@ -1,15 +1,15 @@
from cx_Freeze import setup, Executable
setup(
- name='ReticulumWebChat',
+ name='ReticulumMeshChat',
version='1.0.0',
- description='A simple open-source web based LXMF client for Reticulum.',
+ description='A simple mesh network communications app powered by the Reticulum Network Stack',
executables=[
Executable(
script='web.py', # this script to run
base=None, # we are running a console application, not a gui
- target_name='ReticulumWebChat', # creates ReticulumWebChat.exe
- shortcut_name='ReticulumWebChat', # name shown in shortcut
+ target_name='ReticulumMeshChat', # creates ReticulumMeshChat.exe
+ shortcut_name='ReticulumMeshChat', # name shown in shortcut
shortcut_dir='ProgramMenuFolder', # put the shortcut in windows start menu
icon='logo/icon.ico', # set the icon for the exe
copyright='Copyright (c) 2024 Liam Cottle',
diff --git a/web.py b/web.py
index 21be561..e67835f 100644
--- a/web.py
+++ b/web.py
@@ -35,7 +35,7 @@ def get_file_path(filename):
return os.path.join(datadir, filename)
-class ReticulumWebChat:
+class ReticulumMeshChat:
def __init__(self, identity: RNS.Identity, storage_dir, reticulum_config_dir):
@@ -1853,7 +1853,7 @@ class NomadnetFileDownloader(NomadnetDownloader):
def main():
# parse command line args
- parser = argparse.ArgumentParser(description="ReticulumWebChat")
+ parser = argparse.ArgumentParser(description="ReticulumMeshChat")
parser.add_argument("--host", nargs='?', default="127.0.0.1", type=str, help="The address the web server should listen on.")
parser.add_argument("--port", nargs='?', default="8000", type=int, help="The port the web server should listen on.")
parser.add_argument("--headless", action='store_true', help="Web browser will not automatically launch when this flag is passed.")
@@ -1918,8 +1918,8 @@ def main():
print("Reticulum Identity <{}> has been loaded from file {}.".format(identity.hash.hex(), default_identity_file))
# init app
- reticulum_webchat = ReticulumWebChat(identity, args.storage_dir, args.reticulum_config_dir)
- reticulum_webchat.run(args.host, args.port, launch_browser=args.headless is False)
+ reticulum_meshchat = ReticulumMeshChat(identity, args.storage_dir, args.reticulum_config_dir)
+ reticulum_meshchat.run(args.host, args.port, launch_browser=args.headless is False)
if __name__ == "__main__":
+
