dbrgn / xc-bot

A chat bot that notifies you about new paragliding cross-country flights.

XC Bot

A chat bot that notifies you about new paragliding cross-country flights published on XContest as part of the Swiss Cross Country Cup. Inspired by the Telegram bot XC Switzerland by Sergey Popov.

Supported messenger backends:

• Threema: https://threema.id/*CHXCBOT?text=help

More may follow in the future.

Usage

Show the help screen:

help

Follow a pilot:

follow <username>

List pilots being followed:

list

Stop following a pilot:

stop <username>

Show the current bot version:

version

Architecture

The bot is written in Rust using a SQLite database for keeping track of the processed flights and flight subscriptions.

Docker Image

The repository includes a Dockerfile.

Important paths:

• /etc/xc-bot/config.toml: Configuration file
• /xc-bot/: Work directory (including database)

You'll probably want to mount both files into the container.

Note: This container runs as default user by default. If you use podman, you can run the container as non-root.

License

Licensed under the AGPL version 3 or later. See LICENSE.md file.

Copyright (C) 2021–2024 Danilo Bargen

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

xc-bot's Issues

Admin commands

For certain users (specified in the configfile), allow processing admin commands.

• stats: Return the number of users, the number of subscriptions and the number of flights.

Only fetch flight details if there are subscribers

Avoid same subscription with different case

A user should not be able to subscribe to "chrigel" and "Chrigel".

Commands: Add/remove subscriptions

Removing: Case insensitive

Commands: Turn on/off notifications

This allows disabling notifications without removing all subscriptions

Resize thumbnail

Should not be larger than 512x512px.

Cache public keys

Do not fetch them every time.

Support incoming messages

• Process incoming messages
• Reply with help message when an unknown command is received

Commands: List subscriptions