Git Product home page Git Product logo

olorin's Introduction

Telegram Music Sharing Bot

Olorin is an advanced Telegram music bot written in Golang. It allows users (or admins/moderators) to share songs with dynamic emoji reactions and a Twitter profile link for further engagement.

Key Features

Below are the key features of the bot:

  • Music Sharing: Users can share songs in MP3 format. Each shared song has essential metadata like the title, artist, and genre.
  • Dynamic Emoji Reactions: The bot provides a set of emojis (๐Ÿ‘, ๐Ÿ‘Ž, ๐Ÿ”ฅ, ๐Ÿฅฐ, ๐Ÿš€) that users can tap to react to the shared song. The count of each emoji reaction updates in real time.
  • User Choice Memory: The bot remembers the last emoji each user tapped. If a user changes their reaction, the bot updates the counts accordingly, ensuring that each user's reaction is unique at any given time.
  • Twitter Profile Link: Each shared song includes A Twitter profile link. It allows users to follow the source or artist for more updates. The link is formatted to prevent Telegram from showing a web preview card, ensuring a clean and focused user interface.
  • Command Deletion: When a user shares song using the /sharemusic command, the bot deletes the command message to keep the chat clutter-free.
  • Concurrency-Safe: The application uses mutex locks to ensure that the emoji counts are updated atomically, making it safe for use in high-traffic groups.
  • Debugging Enabled: The bot runs in debug mode, logging essential information for monitoring and troubleshooting.

Instructions

Install Dependencies

First, you'll need to install the Telegram Bot API package for Golang:

go mod init main
go mod tidy

Local Development

Fire up the bot:

go run .

Deployment to Production

Alternatively, you can deploy your own copy of the app using the web-based flow:

Deploy to Heroku

Screenshots

Screenshots of the bot are available here.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the Unlicense License - see the file for details.

Copyright

(c) 2023 Finbarrs Oketunji.

CC0

olorin's People

Contributors

0xnu avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.