arcs

Amateur Radio Chat Server with a modern interface
git clone git://squid-tech.com/arcs.git
Log | Files | Refs | README

commit 18853f74f76d311fd6d45a6c4142497f2baa9909
parent afaef4c24ba1a9cf8128ebe01b75889cc756b4c1
Author: Josh Moore <jxm5210@g.rit.edu>
Date:   Thu, 19 Dec 2019 12:04:02 -0500

Update README.md
Diffstat:
MREADME.md | 18+++++++++++++++---
1 file changed, 15 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md @@ -1,7 +1,9 @@ # arcs The Amateur Radio Chat Server is a service that enables amateur radio operators to connect to a text chat room through a modern web interface. Users are able to send messages to the server, where they will be received by all other connected users. -Note that you do not need to use the browser interface to connect to ARCS - see section "Non-Browser Use" for more information. +I will try to keep an ARCS server running 24/7 as KD2SIX-1 on frequency 144.39 - try connecting and leaving some messages! + +Note that you do not necessarily need to use the browser interface to connect to ARCS - see section "Non-Browser Use" for more information. ### Setup/Running ARCS is based on "pure" python3, so no special setup is required. You also need a serial KISS TNC, and I highly recommend [Direwolf](https://github.com/wb2osz/direwolf). You also need a transceiver (and an amateur radio license!). @@ -10,12 +12,22 @@ ARCS is based on "pure" python3, so no special setup is required. You also need 2. Replace MYCALL in `arcs.py` with your own callsign. 3. Replace HOST with the callsign of the ARCS server. 4. If you are running your own server, modify the server config section of `arcs.py` to match your setup. -5. Connect your radio to your computer, and set it to frequency 144.39. +5. Connect your radio to your computer, and set it to frequency 144.39 (national APRS frequency). 6. Run `direwolf -p`, making note of the path to the serial KISS TNC. 7. Start ARCS with `python3 arcs.py <serial/tnc/path> <baudrate> [options ...]` (If you are running your own server, include the `-server` flag when you run `arcs.py`) 8. Open `index.html` in your web browser, and you're ready to go! +### Commands +TODO + ### Non-Browser Use You do not need to use any of the included python3 code or a web browser to connect to an ARCS server. You can just send APRS messages directly to the callsign of the server (i.e. KD2SIX-1), and you will be connected just like through the browser interface. You will need to continue to send messages or manually send `/ping` commands periodically in order to keep your connection alive. -Note that this is not intended use, and this connection method is not actively supported. You should connect to ARCS servers through your web browser. +Note that this is not intended use, and this connection method is not actively supported. You should connect to ARCS servers through the browser interface. + +### Contributing +Thank you for taking the time to look at ARCS. You can contribute by sending pull requests, opening issues with bug reports and feature suggestions, or just by using ARCS and letting me know how it goes. + +Feel free to get in touch if you have any questions about ARCS or packet radio in general, one of my goals is to get more hams to use packet! + +73 KD2SIX