From 5964e17bbd58da2758a466b3bcb4f8b9abd069d0 Mon Sep 17 00:00:00 2001 From: Martin Brodbeck Date: Wed, 4 Oct 2023 08:38:25 +0200 Subject: [PATCH] README added --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..45bb51a --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# m32chat +m32chat is a simple chat server for the [Morserino](https://morserino.info). + +It es a reimplementation of the Python2.7 script [m32_chat_server](https://github.com/sp9wpn/m32_chat_server). + +The m32chat service listens on port 7373 for UDP messages and rebroadcasts them to the other subscribed Morserino clients. + +To subscribe to the service, just send the message `hi` from your Morserino. The server will respond with ":hi" with the number of clients connected (1 means you're alone). + +If a client is inactive for a certain time, it will be removed from the subscriber list. The server then send the message `:bye` to this client. You can also force the removal by sending the message `:bye`. + +Additional notes: +- Currently **no** UDP packets are being sent to avoid NAT timeouts +- The number of clients is restricted (to avoid abuse) +- Amall delay is introduced (to avoid abuse)