HFCNotificator/README.md
2023-10-11 13:04:29 +03:00

1.5 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

Just invite the bot to a server (see "Links" below), and /register a channel to start receiving notifications!

Please do note that the bot instance listed here is hosted on a private machine, and may be a bit slow (although it doesn't seem to be an issue yet). Feel free to host your own version!

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