README.md

MCScraper

MCScraper is a server side friendly discord bot made on python with selenium and undetected-chromedriver to ease the process of managing free aternos servers from discord guild text channels. To achieve this it uses selenium as its main driver api and to disable cloudflare detection it uses undetected-chromedriver. This bot will require to connect to your aternos account through cookies and can control all the servers to which you have proper permissions.

Features

1. Server friendly
2. Modularity(multiple servers can be controlled)
3. Does not have the token or cookie expiration problem like the other ones
4. It never lies

bot functions

$list-servers: lists all the servers that it can control

$status [server index no]: displays the current status of the mentioned status

$getinfo [server index no]: displays all the possible info about the mentioned server

$start [server index no]: starts the mentioned server

$stop [server index no]: stops the mentioned server

Installation / Setup

Installing chrome and chromedriver

first we need to install the chrome for that download the package file from there official website(Latest stable version is recomended) then install it by running the command on your terminal:

for debian or ubuntu:

sudo apt update
sudo apt install ./<filename>.deb

then install the chromedriver by downloading the binary from here(download the one that supports your chrome browser) after downloading copy the file and paste it in either your /usr/bin/ or /bin/ folder(for servers with different users setup /usr/bin is prefered but for running it as root user /bin/ is recomended)

Installing pip requirements

to install all the required python packages just run the command

pip install -r requirements.txt

CAUTION: the charset-normalizer package can sometimes fail to install depending on your distribution and environment because its a inbuilt feature and might not be available in pip. In those cases just erase line 10 from requirements.txt file

Creating credentials.json and servers.json

credentials.json is the file containing all of your data required to connect to your aternos account and discord bot

for that first goto the discord developers portal => create an application => create a bot => copy the token of your bot

then for connecting to your aternos account you need the cookies of that page. For that goto the aternos servers page => click on any of your servers => right click and click on inspect => goto application section and click on cookies => select https://aternos.org/ => copy and paste the cookies according to the names of them mentioned in credentials.json bellow. Only ATERNOS_SESSION is needed as rest are tracker cookies.

NOTE: You are seeing such kind of a format because of old code concept but currently this is the way to make the bot work. The following format might be updated later in future, till then use the given way only.

mcscraper/credentials.json

{
  "secret_key": "<Your bot token>",
  "common_cookies": {
    "one": {
      "name": "ATERNOS_SESSION",
      "value": "<Your aternos session cookie>"
    },
    "two": {
      "name": "ATERNOS_LANGUAGE",
      "value": "en"
    }
  }
}

NOTE: The older way was to manually get the server ids and paste them but with the commit 3e6a63d the dynamic data updation system was added so please follow the new way.
Keep the servers.json file empty but with a pair of curly braces just to make it json valid. Now after doing whatever is further instructed in this README, and then after starting the bot run the command $list-servers from discord, it will automatically update the file and give the bot control to all the servers you have access to.

mcscraper/servers.json

{
}

After running the command $list-servers the servers.json file should look like this.

{
    "example1": {
        "server_cookie": {
            "name": "ATERNOS_SERVER",
            "value": "E0uHgjBGkHogHqRk"
        }
    },
    "example2": {
        "server_cookie": {
            "name": "ATERNOS_SERVER",
            "value": "vFEfhTYfhxAOZTqI"
        }
    }
    ...
}

Usage

there are two ways of running it first is to just directly type

python bot.py

which is the worst way to do it only recomended if used for testing. The best way is to create a service

/lib/systemd/system/bot.service

[Unit]
Description=Bot Service
After=multi-user.target
Conflicts=getty@tty1.service

[Service]
Type=simple
Restart=on-failure
WorkingDirectory=/<path to mcscraper folder>/mcscraper/
ExecStart=/<python interpreter bin folder>/python /<path to mcscraper folder>/mcscraper/bot.py
StandardInput=tty-force

[Install]
WantedBy=multi-user.target

then run the commands

sudo systemctl daemon-reload
sudo service bot start
sudo service bot status

this will make the bot run even if you exit the terminal

CAUTIONS

1. do not host it on any cloudflare blocked hosting service like heroku as the requests are flaged as bot requests
2. at least 1 core and 1 GB of RAM machine should be used or crashes might happen

Load Test

the test was done on a 1 core 1 GB RAM machine rather a server(ECS)

when bot is idle

when bot is under load

here the cpu load is bellow 60% but expect it to get higher because in some cases it also touches 98%.

Contributing

Feel free to contribute to it by forking or just use the code but please maintain the guidlines under the GPL 3.0 LICENSE. Also pull requests are always welcome.

License

GPL 3.0