From a2443723b29485416442bffd621dc3aa166f9774 Mon Sep 17 00:00:00 2001 From: nin0 Date: Mon, 17 Jun 2024 19:22:56 -0400 Subject: [PATCH] Add readme --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..88f5e54 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Vencord EAS + +This is the repo for both the frontend and backend for the Vencord Emergency Alert System. + +## Installation + +You run the server by: +1. Installing the `websockets` and `python-dotenv` packages; +1. Making a `.env` file; +1. Adding a line with `TOKEN={token}`, with `{token}` being any string that'll be used to broadcast messages; +1. Running `python main.py`. + +## Usage + +You can send raw text to the WS server. This text is in form of commands: + +- `HI` will reply with a message response; +- `GET` will reply with a message response too; +- `MSG {token} {message}` will set the message and broadcast it to all logged-in clients; +- `CLEAR {token}` will clear the current message. + +You may receive one of two packets while using the server: + +- `MSG {message}` to indicate there's a new message. The client should react by showing an alert with the message. If no message is present, the packet will be `MSG` only. In this case, the client shouldn't react. +- `OK` indicates the action was successful. The client should react by showing an alert telling the user so. + +## Frontend + +The frontend is a static HTML page and can be hosted on anything. \ No newline at end of file