Skip to content

Latest commit

 

History

History
124 lines (80 loc) · 4.31 KB

README.md

File metadata and controls

124 lines (80 loc) · 4.31 KB
Raw

wtf?

Thirukkural Bot

A telegram bot that provides thirukkural in tamil its english translations with all information!
Liked my work? Don't forget to ⭐ the repo :)

java stars Website vinuxd.github.io/Thirukkural-Bot size issues license

Features

Deployment

  • First clone this repository to your local machine.
git clone https://github.com/VinuXD/Thirukkural-Bot.git
  • Rename .env.example to .env
  • Fill .env variables.
  • Navigate to src/main/java/me/vinuxd/ThirukkuralBot.java
  • Run ThirukkuralBot.java
  • It starts on your local server.
  • Go to your telegram bot and send /start to get started.
- Note: Support for deploying in VPS server will not be given.

Variables

# Bot Username without @
BOT_USERNAME=

# Bot Token. Get one from @BotFather
BOT_TOKEN=

# Add @MissRose_Bot in a dedicated private group
# Then send /id. (Eg: -100*********)
LOG_GROUP=

FAQs

How can I schedule bot to send Thirukkural daily in my Group?

  • Its Automated! All you need is patience btw. Just add Thirukkural Bot to your group and wait untill 6.30 AM IST.
  • Psst🤫! Rarely very rarely, If you really doesn't get a daily digest, Kick and re-add the bot.

How can I opt out from daily digest?

  • NO! You can't, Coz there is no protocol at our end for opting out. If you don't want to receive daily digest, just remove the bot from your group.
  • If you really don't want to get daily digest and want Thirukkural Bot that badly? Head to the Support Chat.

I have no Groups in common with Thirukkural Bot still can I get daily digest?

  • Absolutely! Join this Dedicated Channel which is maintained by me, to get daily digest.

Still unclear? Support Chat is for you!.

License

GPLv3 LOGO

Copyright © 2022 VINU
Thirukkural-Bot is a free software licensed under GPL V3.0

Being Open Source doesn't mean you can just make a copy and change anything 
and release it.
Read the following carefully,

1. You must provide the copy with the original software or with instructions 
on how to obtain original software, should clearly state all changes, should
clearly disclose full source code, should include same license
and all copyrights should be retained.

2. In simple words, You can ONLY use the source code for `Open Source` Project 
under `GPL v3.0` or later with all your source code CLEARLY DISCLOSED on any code 
hosting platform like GitHub, with clear INSTRUCTIONS on how to obtain the original 
software, should clearly STATE ALL CHANGES made and should RETAIN all copyrights.
Use of this software under any "non-free" license is NOT permitted.

Credits

Changelogs

Visit the Telegram Channel for updates.

TODOs

  1. Schedule bot to send kural in every groups at a specific time.
  2. Write program to get kural with its number.
  3. Add Threads to make bot faster.
  4. Improve logging in console & telegram.
! This repository is deprecated and moved to a private repository.