songy

This is a telegram bot written in rust using the frankenstein telegram bot library.

what does it do?

This bot provides an interface to files. It is meant to be used as a digital songbook.

bot commands

To let telegram know what commands the bot provides you have to set these in the BotFather. The /list command lists all available files in the provided --songs-path recursively. There is one thing you can do for additional structuring. Suppose you have provided the path /var/songs as the --songs-path. If you create the subfolder /var/songs/en then the command /en will be available in the bot to list only files/songs recursively in that subfolder. That way you could organize your songs in different languages.

installation

1. Download the latest release executable
2. Don't forget to make the downloaded file executable: chmod +x <file>
3. Decide about the configuration
   1. Create a telegram bot to obtain the bot api token (--token)
   2. Which language do you want the bot to speak? english, german or romanian/moldovan (--lang)
   3. Where do you store the files that the bot uses? (--songs-path)
4. Start the bot: ./songy --token <api_token> --songs-path <full/path/to/songs/folder>

config

Instead of providing all settings via command line arguments you can provide a yml config file with the settings with the --config argument.

e.g. ./songy --config songy.yml.

These are the available configuration options:

songy.yml

search_file: <path_to_file>
reports_path: <path_to_folder>
token: <telegram_bot_token>
songs_path: <path_to_folder>
lang: <en|de|md>

Command line arguments have precedence over configuration file options.

setup systemd service under linux

As the bot has to run endlessly you probably want to create some sort of background service. Here's a simple solution I use.

1. touch /etc/systemd/system/songy.service
2. Copy this into songy.service

[Unit]
Description=Digital song book

[Service]
ExecStart=/full/path/to/songy/executable --token <api_token> --songs-path <full/path/to/songs/folder> --lang <en|de|md>
Restart=on-failure

[Install]
WantedBy=default.target

3. systemctl start songy

Searching Files

Basic

If you have some images or pdf files and you want to sing now then you can just throw them into a folder, assign that folder in the --songs-path argument, start the bot and you're done. This way every text you send to the bot that doesn't start with a slash (/) will be used to search in the file names you provided. This way you have a basic search.

Advanced

Alternatively you can provide a text file via the --search-file argument. When sending the bot a text message that doesn't start with a slash (/) now it won't search in the provided file names rather in the provided --search-file text file. For that to work the --search-file text file has to have the following structure:

One song per line.

line 1: <filename_without_extension>:<song_title>:<song_lyrics>
line 2: <filename_without_extension>:<song_title>:<song_lyrics>
...

<filename_without_extension> will be taken as a bot command. Telegram has the following rules about bot commands: Commands must always start with the / symbol and contain up to 32 characters. They can use Latin letters, numbers and underscores.

<song_title> can contain umlauts.

<song_lyrics> can contain umlauts.

Example

So suppose you have the song Love Me Tender in your --songs-path folder and the actual file name is Love_Me_Tender.pdf . The line for the --search_file text file could look like this:

Love_Me_Tender:lovemetender:lovemetenderlovemesweetneverletmegoyouhavemademylifecompleteandiloveyousolovemetenderlovemetrueallmydreamsfulfillformydarlingiloveyouandialwayswilllovemetenderlovemelongtakemetoyourheartforitstherethatibelongandwillneverpartlovemetenderlovemedeartellmeyouaremineillbeyoursthroughalltheyearstilltheendoftime

Help

If you want to use this repo but you face problems configuring it you can contact me.