Skip to content

Latest commit

 

History

History
64 lines (50 loc) · 4.06 KB

TG-BOT.md

File metadata and controls

64 lines (50 loc) · 4.06 KB
Raw

Setting Up a Relay from this Script to a Telegram Bot

Step 1: Create a Telegram Bot Using BotFather

  1. Search for BotFather in your Telegram client or use this link: BotFather.

  2. Create a New Bot:

    • Start a chat with BotFather.
    • Enter the command /newbot.
    • Follow the instructions to name your bot and give it a unique username.
    • Copy the token provided by BotFather. This token will be used to access the HTTP API for your bot. Keep this token secure, as anyone with access to it can control your bot.

  3. Send a Message to Your New Bot:

    • Visit your bot's URL given by the BotFather, which will be something like https://t.me/myBotName_bot.
    • Type "Hello" and press enter to send the message. This initializes a chat that our script will use.

Step 2: Configure the Script to Use the Telegram Bot

  1. Launch Any Game and Select y to Edit the Settings:

    • For example, run ./launch.sh hot.
    • Scroll through the options by hitting Enter until you reach the "Telegram verbose level" option.
    • Choose a level of detail between 0 (no updates pushed) to 3 (every small step pushed). For most users, level 1 is a good choice.
    • Continue to scroll down until you reach "Enter the Telegram Bot Token" and enter the access token from BotFather.
    • Keep hitting Enter until all settings have been cycled through and the revised settings are shown.
    • At this point, you can either set up a new game session or press Ctrl+C to exit.
    • With these steps completed, each game session restarted with the updated settings will push updates to your bot.

  2. Set Up Additional Interaction with Your Telegram Bot:

    • Run ./launch.sh tg-bot to add an additional level of interaction between your game sessions and the Telegram bot.
    • This script will set up a PM2 process to monitor for requests from you in Telegram.
    • Once set up, you can use commands like /start, /help, /status, /logs, and /exit to pull additional information for each game session by choosing the links from the list of options.

By following these steps, you'll have a fully configured relay from your script to your Telegram bot, allowing you to receive updates and interact with your game sessions via Telegram.

Massive thanks to community member JBR1999 for developing and contributing this code!

Available Commands:

  • /start - Start the original bot
  • /logs <session name> <lines> - List the logs of the process
    • /logs HOT:Wallet1 - Show the last 30 log lines for game "HOT", session "Wallet1".
    • /logs Vertus:Wallet2 100 - Show the last 100 log lines for game "Vertus", session "Wallet2".
  • /status - Lists a status summary of every game session in PM2
  • /status <session name> - Get the last 30 balances and status for a specific session
    • /status HOT:Wallet1 - Show the last 30 claim results and balance updates for game "HOT", session "Wallet1".
  • /list - List all active and inactive games from PM2.
  • /list <pattern> - List only games matching the pattern
    • /list hot - Lists all games with "hot" in the name.
  • /start <pattern> - Start all PM2 processes matching the pattern
    • /start HOT:Wallet1 - Starts the HOT:Wallet1 session.
  • /restart <pattern> - Restart all PM2 processes matching the pattern
    • /restart :Wallet1 - Restarts all PM2 processes matching account Wallet1.
  • /stop <pattern> - Stop processes matching the pattern
    • /stop Vertus: - Stops all PM2 processes for the game "Vertus".
  • /update - Update the game files (try pull-games.sh, then git pull).
  • /help - Show this help message.
  • /exit - Exit the bot.

Using Pattern Matching in Commands:

You may use pattern matching with certain commands. When using /list, it is not case-sensitive. For example, you can use /list hot or /list vertus. However, for the /start, /restart, and /stop commands, case sensitivity matters. For instance:

  • /stop HOT: will stop all HOT games, regardless of the account name.
  • /restart :Wallet1 will restart all Wallet1 sessions across any available game.