Skip to content

Convert the tracklists with Telegram Bot into human-readable format

Notifications You must be signed in to change notification settings

corsairdnb/telegram-tracklist-bot

Repository files navigation

Telegram Tracklist Bot

This bot helps the DJ's to convert the playlists into human-readable format.

Based on the official Telegram Bot API and open-source PHP bot framework.

Works only with filenames and text format playlists.

Instructions

Create your first bot

  1. Message @botfather https://telegram.me/botfather with the following text: /newbot If you don't know how to message by username, click the search field on your Telegram app and type @botfather, where you should be able to initiate a conversation. Be careful not to send it to the wrong contact, because some users has similar usernames to botfather.

    botfather initial conversation

  2. @botfather replies with Alright, a new bot. How are we going to call it? Please choose a name for your bot.

  3. Type whatever name you want for your bot.

  4. @botfather replies with Good. Now let's choose a username for your bot. It must end in `bot`. Like this, for example: TetrisBot or tetris_bot.

  5. Type whatever username you want for your bot, minimum 5 characters, and must end with bot. For example: telesample_bot

  6. @botfather replies with:

    Done! Congratulations on your new bot. You will find it at
    telegram.me/telesample_bot. You can now add a description, about
    section and profile picture for your bot, see /help for a list of
    commands.
    
    Use this token to access the HTTP API:
    123456789:AAG90e14-0f8-40183D-18491dDE
    
    For a description of the Bot API, see this page:
    https://core.telegram.org/bots/api
    
  7. Note down the 'token' mentioned above.

  8. Type /setprivacy to @botfather.

    botfather later conversation

  9. @botfather replies with Choose a bot to change group messages settings.

  10. Type (or select) @telesample_bot (change to the username you set at step 5 above, but start it with @)

  11. @botfather replies with

    'Enable' - your bot will only receive messages that either start with the '/' symbol or mention the bot by username.
    'Disable' - your bot will receive all messages that people send to groups.
    Current status is: ENABLED
    
  12. Type (or select) Disable to let your bot receive all messages sent to a group. This step is up to you actually.

  13. @botfather replies with Success! The new status is: DISABLED. /help

Installation

  • Clone this repository.

  • Create MySQL database and import the structure.sql file.

  • Create the config file config.php by renaming the config.sample.php and fill your own credentials.

  • Give the file permission to execute:

    chmod +x getUpdateCLI.php
    
  • Run this script as a daemon, for example by adding such line to your crontab:

    * * * * * ~/www/telegram-tracklist-bot/getUpdateCLI.php
    

    This command will execute php-script every minute.

Test your bot

  • Type /tracklist command.

  • The bot would ask the tracklist file.

  • Send the file to your bot.

  • Enjoy the well-formatted tracklist!

About

Convert the tracklists with Telegram Bot into human-readable format

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages