mirror of
https://github.com/GaMeNu/HFCNotificator.git
synced 2024-11-16 15:24:51 +02:00
A Discord bot to send notificaitons for Home Front Command alerts
ea834b6e6f
Fixed DM registration errors caused by v2.0.1 Clarified that the bot can also send alert DMs |
||
|---|---|---|
| translations | ||
| cog_notificator.py | ||
| create_db.py | ||
| db_access.py | ||
| main.py | ||
| markdown.py | ||
| README.md | ||
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 (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