https://github.com/ptkdev/rpg-monster-telegram-game-bot
RPG Monster Game Bot
https://github.com/ptkdev/rpg-monster-telegram-game-bot
Last synced: 4 months ago
JSON representation
RPG Monster Game Bot
- Host: GitHub
- URL: https://github.com/ptkdev/rpg-monster-telegram-game-bot
- Owner: ptkdev
- License: other
- Created: 2022-11-14T23:18:14.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-22T23:51:24.000Z (about 3 years ago)
- Last Synced: 2025-04-15T19:23:00.599Z (10 months ago)
- Language: TypeScript
- Homepage: https://t.me/RPGMonsterBot
- Size: 1.42 MB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# 🤖 rpg-monster-telegram-game-bot
[](https://github.com/ptkdev/rpg-monster-telegram-game-bot/blob/main/CHANGELOG.md) [](https://www.npmjs.com/package/@ptkdev/rpg-monster-telegram-game-bot) [](https://github.com/ptkdev/rpg-monster-telegram-game-bot/blob/main/LICENSE.md) [](https://www.typescriptlang.org/) [](https://grammy.dev/) [](https://github.com/tc39/ecma262) [](https://discord.ptkdev.io)
RPG Monster Game Bot for Telegram Groups, play with friends!
## 🎁 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!**
[](https://www.paypal.me/ptkdev) [](https://ko-fi.com/ptkdev) [](https://github.com/sponsors/ptkdev) [](https://www.patreon.com/join/ptkdev) [](https://ptk.dev/img/icons/menu/bitcoin_wallet.png) [](https://ptk.dev/img/icons/menu/ethereum_wallet.png)
## 📎 Menu
- 💡 [Features](#-features)
- 👔 [Screenshot](#-screenshot)
- 🚀 [How to use](#-installation)
- 🎮 [How to play](#-how-to-play)
- 🔨 [Developer Mode](#-developer-mode)
- - 🏁 [Run Project](#-run-project)
- - 💾 [Setup Project](#-setup-project)
- - 🚀 [Deploy](#-deploy)
- 📚 [Documentation](#-documentation)
- 👨💻 [Contributing](#-contributing)
- 🐛 [Known Bugs](https://github.com/ptkdev/rpg-monster-telegram-game-bot/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
- 🍻 Community:
- 
Telegram ([🇬🇧 English](https://t.me/QuizQuickAnswerGroup) | [🇮🇹 Italian](https://t.me/QuizQuickAnswerGroupITA))
## 💡 Features
- [✔️] Easy to use
- [✔️] MIT License
- [✔️] Powered by Grammy Telegram API Framework
- [✔️] RPG Monster Game Bot for Telegram Groups, play with friends!
## 👔 Screenshot
[](https://raw.githubusercontent.com/ptkdev/rpg-monster-telegram-game-bot/main/.github/assets/screenshot.png)
## 🚀 Installation
1. Add [@RPGMonsterBot](https://t.me/RPGMonsterBot) to your Telegram group
2. Make **@RPGMonsterBot** admin of your group
3. Run `/start` or `/start@RPGMonsterBot`
4. Follow instructions and Play with friends!
## 🎮 How to play
1. TODO
## ⏱ 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](https://t.me/QuizQuickAnswerGroup)
- [🇮🇹 Italian](https://t.me/QuizQuickAnswerGroupITA)
## 🔨 Developer Mode
#### 🏁 Run Project
1. Clone this repository or download [nightly](https://github.com/ptkdev/rpg-monster-telegram-game-bot/archive/nightly.zip), [beta](https://github.com/ptkdev/rpg-monster-telegram-game-bot/archive/beta.zip) or [stable](https://github.com/ptkdev/rpg-monster-telegram-game-bot/archive/main.zip).
2. Write to [@botfather](https://t.me/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](https://www.paypal.me/ptkdev), [ko-fi](https://ko-fi.com/ptkdev), [github](https://github.com/sponsors/ptkdev) or [patreon](https://www.patreon.com/join/ptkdev) and send me [email](mailto:support@ptkdev.io) with your avatar and url.
[](https://api.ptkdev.io/backers/sponsor1.html) [](https://api.ptkdev.io/backers/sponsor2.html) [](https://api.ptkdev.io/backers/sponsor-kofi1.html) [](https://api.ptkdev.io/backers/sponsor-kofi2.html) [](https://api.ptkdev.io/backers/sponsor-kofi3.html) [](https://api.ptkdev.io/backers/sponsor3.html) [](https://api.ptkdev.io/backers/sponsor4.html) [](https://api.ptkdev.io/backers/sponsor5.html) [](https://api.ptkdev.io/backers/sponsor6.html) [](https://api.ptkdev.io/backers/sponsor7.html) [](https://api.ptkdev.io/backers/sponsor8.html) [](https://api.ptkdev.io/backers/sponsor9.html) [](https://api.ptkdev.io/backers/sponsor10.html) [](https://api.ptkdev.io/backers/sponsor11.html) [](https://api.ptkdev.io/backers/sponsor12.html) [](https://api.ptkdev.io/backers/sponsor13.html) [](https://api.ptkdev.io/backers/sponsor14.html) [](https://api.ptkdev.io/backers/sponsor15.html) [](https://api.ptkdev.io/backers/backer1.html) [](https://api.ptkdev.io/backers/backer2.html) [](https://api.ptkdev.io/backers/backer3.html) [](https://api.ptkdev.io/backers/backer4.html) [](https://api.ptkdev.io/backers/backer5.html) [](https://api.ptkdev.io/backers/backer6.html) [](https://api.ptkdev.io/backers/backer7.html) [](https://api.ptkdev.io/backers/backer8.html) [](https://api.ptkdev.io/backers/backer9.html) [](https://api.ptkdev.io/backers/backer10.html) [](https://api.ptkdev.io/backers/backer11.html) [](https://api.ptkdev.io/backers/backer12.html) [](https://api.ptkdev.io/backers/backer13.html) [](https://api.ptkdev.io/backers/backer14.html) [](https://api.ptkdev.io/backers/backer15.html) [](https://api.ptkdev.io/backers/backer16.html) [](https://api.ptkdev.io/backers/backer17.html) [](https://api.ptkdev.io/backers/backer18.html) [](https://api.ptkdev.io/backers/backer19.html) [](https://api.ptkdev.io/backers/backer20.html) [](https://api.ptkdev.io/backers/backer21.html) [](https://api.ptkdev.io/backers/backer22.html) [](https://api.ptkdev.io/backers/backer23.html) [](https://api.ptkdev.io/backers/backer24.html) [](https://api.ptkdev.io/backers/backer25.html) [](https://api.ptkdev.io/backers/backer26.html) [](https://api.ptkdev.io/backers/backer27.html) [](https://api.ptkdev.io/backers/backer28.html) [](https://api.ptkdev.io/backers/backer29.html)
## 👨💻 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](https://allcontributors.org/docs/en/emoji-key)):
Patryk Rzucidło
💻 🌍 📖 🐛
Alì Shadman
💻 🌍 📖 🐛
> 💰 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
[](https://ptk.dev/)
[](https://github.com/ptkdev/ptkdev-logger) [](https://github.com/ptkdev/all-shields-cli) [](https://github.com/ptkdev/chrome-extension-aspectratio219) [](https://availableon.badge.ptkdev.io/) [](https://github.com/ptkdev/json-token-replace) [](https://github.com/ptkdev/eslint-plugin-snakecasejs)
[](https://github.com/ptkdev-components/webcomponent-instagram-widget) [](https://github.com/ptkdev-components/webcomponent-patreon-box) [](https://github.com/ptkdev-components/webcomponent-carousel-slideshow)
[](https://github.com/ptkdev/vscode-theme-dark-blood) [](https://t.me/gamebookchatbot) [](https://github.com/ptkdev?q=svelte) [](https://github.com/ptkdev?q=webcomponent) [](https://github.com/ptkdev?q=bot) [](https://github.com/ptkdev?q=node) [](https://meingifs.pics/) [](https://github.com/ptkdev/ptkdev-stickers#-install-free)
## 💫 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](https://ptk.dev) ([@PTKDev](https://twitter.com/ptkdev)) <[support@ptkdev.io](mailto:support@ptkdev.io)>