HFCNotificator/README.md
GaMeNu ba5b06faf2 v2.0.1 fixes
Added alert description to alert messages
Bot now moves to datetime.now() if the latest message is within 1 minute
Updates to /about and README
2023-10-11 19:17:29 +03:00

1.4 KiB

Home Front Command Notificator

A bot to send Discord notifications for HFC alerts

Created by GaMeNu and yrrad8

IMPORTANT: This bot is unofficial! Please do not rely on it alone.

What is this?

This is a bot that connects to the HFC's servers and sends real-time notifications about alerts in Israel.

Setup

Invite the bot to a server, and /register a channel, and you're ready to go!

Alternatively, you can DM the bot to receive alerts directly to your DMs!

Please do note that the bot instance listed here is hosted on a private machine, and may be a bit slow.

Self-hosting

Requirements

Required PyPI packages (run each with pip install)

discord.py
mysql-connector-python
python-dotenv

Other requirements

MySQL Server: https://dev.mysql.com/downloads/mysql/

.env format:

Replace the angled brackets with the matching data

TOKEN = <Discord bot token>
AUTHOR_ID = <Your Discord user ID>

DB_USERNAME = <MySQL database username>
DB_PASSWORD = <MySQL database password>

note that the .env file must be in the same directory as main.py

GitHub

Official Bot Invite Link

Bot Profile (Use to open a Direct Message with the bot)

HFC Website