Skip to content

obviyus/HamVerBot

Repository files navigation

Version GitHub CI Status

Commit Activity Lines of Code

🏎️ HamVerBot

#f1's favourite F1 bot running on Libera.Chat built using the irc crate.

Features

  • !next to reply with time until the next event
  • automatically send a message 5 minutes before the next event starts
  • post results of an event to the configured channels

Getting Started

To begin, clone the repository and populate config.toml. An example configuration is:

owners = ['obviyus']
nickname = "HamVerBot-Dev"
nick_password = "some-password" # Required for SASL authentication
password = "some-password"
realname = "Steward of #f1"
server = "irc.libera.chat"
port = 6697
use_tls = true
encoding = "UTF-8"
channels = ["#f1"]
umodes = "+RB-x"
user_info = "IRC bot for #f1"
version = "irc:git:Rust"
source = "https://github.com/obviyus/HamVerBot"
ping_time = 180
ping_timeout = 20
burst_window_length = 8
max_messages_in_burst = 15
should_ghost = false
ghost_sequence = []

[options]
command_prefix = "!"

To run the bot,

RUST_LOG=info F1_API_KEY='your-api-key' cargo run

Contributing

This repository uses the automated semantic-release suite of tools to generate version numbers. All commit messages must conform to the Angular Commit Message conventions.

Thanks for the logo ordos!