VencordEAS/README.md

# Vencord EAS

This is the repo for both the frontend and backend for the Vencord Emergency Alert System.

Demo instance at https://vencord-eas.nin0.dev, websocket url is wss://eas-ws.nin0.dev, token is 3coA4foQw89t0q3h57r7. 

## 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:

- `GET` will reply with a message response;
- `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 three responses 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.
- `NULL` to indicate that no data is available. No client reaction is intended.

## Frontend

The frontend is a static HTML page and can be hosted on anything.