🤖 quizquickanswer-telegram-game-bot

Funny quiz game, play with friends on your telegram group!

🎁 Support: Donate

This project is free, open source and I try to provide excellent free support. Why donate? I work on this project several hours in my spare time and try to keep it up to date and working. THANK YOU!

📎 Menu

• 💡 Features
• 👔 Screenshot
• 🚀 How to use
• 🎮 How to play
• 🔨 Developer Mode
• • 🏁 Run Project
• • 💾 Setup Project
• • 🚀 Deploy
• 📚 Documentation
• 👨‍💻 Contributing
• 🐛 Known Bugs
• 🍻 Community:
  • Telegram (🇬🇧 English | 🇮🇹 Italian)

💡 Features

• [✔️] Easy to use
• [✔️] MIT License
• [✔️] Powered by Grammy Telegram API Framework
• [✔️] Quiz game, play with friends on your telegram group

👔 Screenshot

🚀 Installation

1. Add @QuizQuickAnswerBot to your Telegram group
2. Make @QuizQuickAnswerBot admin of your group
3. Run /start or /start@QuizQuickAnswerBot
4. Make yourself master of game, run /master @nickname
5. Follow instructions and Play with friends!

🎮 How to play

1. Set a master with /master @nickname
2. Master send private message to @QuizQuickAnswerBot
3. Master write question with syntax: QUESTION ## TIP, example: gameboy ## '90s' portable console
4. Friends try to answer quickly in the telegram group. Who reply with right answer is the new master!

⏱ Official Group

If you have no telegram groups of friends you can play in the official one, you will find new friends and kind people:

• 🇬🇧 English
• 🇮🇹 Italian

🔨 Developer Mode

🏁 Run Project

1. Clone this repository or download nightly, beta or stable.
2. Write to @botfather on telegram and create new bot (save token and set bot username)
3. Set bot token: export BOT_TOKEN=1234:asdfghjkl
4. Set mongodb connection url: export MONGODB=mongodb://localhost:27017/quizquickanswerdb
5. Run npm install
6. Run npm run dev
7. Write /start on telegram bot.

🚀 Deploy

Deploy bot to your server and:

1. Set bot token: export BOT_TOKEN=1234:asdfghjkl
2. Set mongodb connection url: export MONGODB=mongodb://localhost:27017/quizquickanswerdb
3. Run init npm install
4. Generate release npm run release
5. Start bot npm run start-pm2

📚 Documentation

Run npm run docs

👑 Backers and Sponsors

Thanks to all our backers! 🙏 Donate 3$ or more on paypal, ko-fi, github or patreon and send me email with your avatar and url.

👨‍💻 Contributing

I ❤️ contributions! I will happily accept your pull request! (IMPORTANT: Only to nightly branch!) Translations, grammatical corrections (GrammarNazi you are welcome! Yes my English is bad, sorry), etc... Do not be afraid, if the code is not perfect we will work together 👯 and remember to insert your name in .all-contributorsrc and package.json file.

Thanks goes to these wonderful people (emoji key):

Patryk Rzucidło 💻 🌍 📖 🐛

Alì Shadman 💻 🌍 📖 🐛

Denise Scazzari 🌍

Alessandro Di Maria 💻 🐛 🌍

💰 In the future, if the donations allow it, I would like to share some of the success with those who helped me the most. For me open source is share of code, share development knowledges and share donations!

🦄 Other Projects

💫 License

• Code and Contributions have MIT License
• Images and logos have CC BY-NC 4.0 License
• Documentations and Translations have CC BY 4.0 License

Copyleft (c) 2022 Patryk Rzucidło (@PTKDev) <[email protected]>