https://github.com/codewarnab/akinatorbot
Just a fun project for playing Akinator game inside telegram
https://github.com/codewarnab/akinatorbot
akinator python python-telegram-bot telegram-bot
Last synced: 3 months ago
JSON representation
Just a fun project for playing Akinator game inside telegram
- Host: GitHub
- URL: https://github.com/codewarnab/akinatorbot
- Owner: codewarnab
- Created: 2023-08-20T13:06:23.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-04T10:07:03.000Z (about 1 year ago)
- Last Synced: 2025-02-28T07:36:48.923Z (3 months ago)
- Topics: akinator, python, python-telegram-bot, telegram-bot
- Language: Python
- Homepage: https://t.me/Akinatorq_bot
- Size: 766 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Akinator-Bot
A Telegram bot where you can play the Akinator Guessing game
check out [Akinator](https://telegram.me/Akinatorq_bot) on Telegram.
If the bot is offline, contact [me](https://telegram.me/blacknut1803) on telegram, so that I can look into it.
current users : 426 [24-12-2023]
( bot is down due this [issue](https://github.com/Ombucha/akinator.py/issues/13)
## Setting up the database
Akinator uses **MongoDB** by default to store the user stats such as number of games won, abandoned, played and their telegram provided info and also to facilitate for the leaderboard function. MongoDB is easy to set up and work with, noSQL is easy compared to SQL. MongoDB even offers free cloud database for small use. You can create a local mongoDB cluster or use the online mongoDB Atlas to start.. Here, the scope of the following steps is to follow on the footpath of the online setup using mongoDB Atlas.
### steps
1) Go to [mongoDB official site](https://www.mongodb.com/) and login/register.
2) On the Atlas tab, click `create` to create a new cluster.
3) Now configure the cluster as you want such as the cloud service provider, region, cluster tier etc..
4) Now click on the cluster name which will take you to the Overview page.
5) Click `Collections` and create a database called `aki-db`. Inside `aki-db` create a collections called `users`,`groups`,`last_msg_ids`,`user_chatting_data` .
6) Now on the left side, under the `Security` click the `Database Access` and add a user. Don't forget to note down the username and password!
7) Now go to `Network Access` right under `Database Access` and check whether `0.0.0.0/0` is in the **IP Access List**. If not, then click `Add IP Address` and add `0.0.0.0/0`.
8) Now everything is set up! But there's still one step left, i.e to copy the mongoDB address to your database to be accessed by Akinator.
9) Now under the `Deployment` tab, click `Databases` and you should see the cluster you created. Now click the button named `Connect`. Choose `Connect your application`. Select `python` as Driver and appropriate version.
10) It should now give you a template string and will give you instructions on what need to be changed/replaced with. It usually askes you to replace ``, `` and `myFirstDatabase`.
11) Do you now remember step 6 ? Where you should have noted down the username and password. yeah, now you have to replace the username, password. And for `myFirstDatabase`, replace it with your `cluster` name.
12) Everything's done! Finally just copy the string and paste it in the appropriate environmenal variable.
# Commands
`/start` - Start the bot
`/language` - Change language of the questions asked by Akinator ( This doesn't change the language of the bot interface! )
`/childmode` - Enable/Disable NSFW Content
`/play` - Start playing!
`/me` - Shows stats about you.
`/leaderboard` - Check leaderboard. It includes various categories!
## Admin Commands
`/find`- See the user count of the bot
`/total`- Get the name of the group and member count where bot is added
`/log`- get the log file sent to you
`#broadcast` - bot will broadcast any message with containing `#broadcast` in them
**CHATTING** - You can now chat with the user in bot by replying the forwarded message from the user (you can reply with anything text or media even with inline buttons) .
## Deployment
1 . download the repo as zip
2.change the necassary details in the config.py
3 . learn how to deploy python script in gcloud [here](https://youtu.be/lEKp2O7MTfY?si=p2VYayICKKIxieKq)
## Credits
1. Original source code is taken from [Telegram Akinator Bot](https://github.com/adenosinetp10/Akinator-Bot) ( i am aslo a conrtributor there )
3. [Infiniticity's Akinator.py (`akinator` on PyPI)](https://github.com/Infiniticity/akinator.py)
4. [python-telegram-bot](https://github.com/python-telegram-bot/python-telegram-bot)