Jukebox Jury Telegram bot

Description

Jukebox Jury Telegram bot curates a Jukeboxjury gameshow round.

Program flow

At the beginning panelists introduce songs for the bot and bot shuffles the playing order. Then, each panelist reviews the introduced song and eventually when everything has been reviewed, bot generates an HTML page of the results.

Flow states are depicted below:

stateDiagram-v2
    [*] --> Init: Program started
    Init --> StartGame : Panelist starts the game
    StartGame --> WaitPanelistsToJoin : Waiting for panelists
    WaitPanelistsToJoin --> WaitPanelistsToJoin : Add panelist
    WaitPanelistsToJoin --> AddSong : All panelists joined
    WaitPanelistsToJoin --> StopGame : Admin selects "Stop Game"
    AddSong --> AddSong : Wait for a new song
    AddSong --> ShuffleHost : All songs submitted
    AddSong --> StopGame : Admin selects "Stop Game"
    ShuffleHost --> IntroduceSong : Introduce a song
    IntroduceSong --> WaitForReviews : Collecting reviews
    WaitForReviews --> WaitForReviews : Wait for reviews
    WaitForReviews --> RevealReviews : All reviews submitted
    RevealReviews --> IntroduceSong : Next song from the list
    RevealReviews --> StopGame : All songs reviewed
    StopGame --> [*] : Game ended
    StopGame --> Init: Wait for a new game

Loading

Dependencies

• Telegram
• GNU Make
• Go 1.23?

Build & configuration

Build

On the repostirory root:

make -C cmd/

An example configuration is located in ./env_example file. Copy that into .env file and edit to match with your settings.

Variable explanations:

Name	Explanation
BOT_API_TOKEN	Telegram bot API token
CHAT_ID	Channel where to send public messages
RESULTS_DIRECTORY	Directory where to save result HTMLs
RESULTS_URL	Prefix for the results URL

Running

Run the program and use the configration file .env found in the same directory

./cmd/dist/jukeboxjury -f .env