WARNING: Always do your own research, as some projects may ultimately deliver no real-world value and might try to upsell features for cold hard cash!

🎥 Step-by-Step Video Walkthrough 🎬

Watch along while I perform each step, from server setup, downloading and installing the script, configuring the options, and initiating your automated claims with the Video Walkthrough.

Quick Start Install via Docker (best option for non-technical users)

Using Docker simplifies the setup for non-technical users, by "containerizing" the application and its dependencies, keeping it separate from your main operating system, and ensuring a consistent environment across different architectures (X86/ARM64) and operating systems (Linux-based/Windows). This approach eliminates issues related to dependency management and version conflicts.

Install Docker Desktop on your PC or CLI Docker on a VPS and then type the following commands into a terminal. Refer to the DOCKER.md or video walkthrough for full details.

Run a Container with the Script and Dependencies from the Latest Image (with automatic restart set)

docker run -d --name telegram-claim-bot --restart unless-stopped thebrumby/telegram-claim-bot

Enter the Container To Interact with the Script - Add New Game Accounts, Monitor for Errors etc

docker exec -it telegram-claim-bot /bin/bash

Once Inside the Container - To launch a game:

./launch.sh

To see the status of all your accounts, delete processes, and see PM2 logs on one page:

./launch.sh status

For more details on status, check out its STATUS.md guide.

You can type exit or CTRL+D to leave the container, which will remain running until stopped. You may use the docker exec command above to re-enter the container as often as needed.

Setting Up a Relay from This Script to a Telegram Bot

We've detailed the process of setting up a relay from this script to a Telegram bot in step-by-step instructions. This includes creating a bot using BotFather, configuring your script to use the bot, and adding interaction levels. For comprehensive instructions, refer to the TG-BOT.md guide.

Windows 10 & 11 Alternative Installation - Utilize WSL2:

You can check out the WINDOWS.md guide or check out this video for further instructions.

Stand-alone Linux Installation (best option for technically-minded users):

To create a stand-alone (non-Docker) version, follow the instructions at LINUX.md or watch the video walkthrough. This method is compatible with Ubuntu-style operating systems and tested on Ubuntu 20.04 - 24.04.

General Instructions

💻 TIP: This project has no control over the size of your hardware, how many servers or devices you will use, or the number of game sessions that you will initiate on each device. However, it's important to remember that every game session you initiate using the recommended process manager (PM2) has an overhead in system resources.

1. When not actively making a claim, each session uses around 35 MB of RAM (memory) and virtually no CPU load. During the Setup and Claim phases, each concurrent session requires approximately 450 MB of memory and utilizes a larger portion of your CPU resources. The concurrent claims setting (default value 1) limits the number of active claims to prevent hardware overload, if additional claim sessions become due, they will queue until a concurrent claim slot becomes free. If you have a multiple-core processor and generous RAM, you can increase this by changing the settings as described in the Usage Notes.

2. Hard disk space: Each game session has a saved browser cache which includes images, CSS, and JavaScript assets used by the game. Depending on the game, this can range from 100 to 400 MB. Additionally, the recommended process manager (PM2) also stores logs. If disk space is a concern, you can set limits on the PM2-LOGS.md or set enableCache to 'n' in the script settings.

It is the script user's responsibility to assess the capacity of their hardware, review it regularly, and limit the number of game session instances that they initiate to stay within the limits of their hardware. Failure to do so may lead to slow processing, script/server crashes, and the possibility you will be locked out of your server.