Skip to content

Latest commit

 

History

History
311 lines (248 loc) · 8.92 KB

README.md

File metadata and controls

311 lines (248 loc) · 8.92 KB
Raw

Updated script to work with ruby 3

Online Games Bot Engine

A simple bot for auto-building and gain resources via missions. Tested on Linux and MacOS. Available a container version to run on different platforms. Supports the "Lords and Knights" 2020 version.

Lords and Knights

Website: https://lordsandknights.com Naive bot solution to optimize your nights and days. Spent more time on what is matters than do a routine job.

Features

Automate buildings

Do continuous buildings in any order that you specify. Feel free to use my strategy from config/servers.yml.example. Use Free speedup building if it is available.

Research

Do research in Library or University. Dumb approach - the first available research.

Missions

Continuously send troops to missions. WARNING: Disable it manually, if you have a war or require forces for something.

Events

Get automaticaly rewards if it them available in the Task list.

Free Gifts

Collect automaticaly free gifts if it them available

Exchange Silver

Use Mass functions to exchange silver from each castle and fortress. By default, it would exchange resources to more than 1000 silver. There is an option to modify it threshold: BARTER_SILVER_THRESHOLD.

Example of config to exchange silver and custom threshold:

  :actions:
    - exchange_silver:
        threshold: 18000

Quick Usage

Run the bot on your machine or in cloud, you should install Docker. The container has all required packages to run bots: Chrome and Ruby environment.

Provide settings via environment variable SERVERS_JSON.

$ export SERVERS_JSON=$(cat <<JSON
{
  "miry_de": {
    "timeout": 5,
    "email": "<[email protected]>",
    "password": "<your password>",
    "server_name": "Germanien III (DE) - empfohlen",
    "actions": [
      "build_first",
      "send_troops_to_missions",
      "research",
      "events"
    ],
    "buildings": [
      "Sawmill",
      "Stonecutter",
      "Forge",
      {
        "Ore store": {
          "level": 3
        }
      },
      {
        "Wood store": {
          "level": 3
        }
      },
      {
        "Stone store": {
          "level": 3
        }
      },
      "Lumberjack",
      "Quarry",
      "Ore mine",
      "Library",
      "Wood store",
      "Stone store",
      "Ore store",
      {
        "Tavern": {
          "level": 4
        }
      },
      "Farm",
      "Arsenal",
      "Market",
      "Fortifications",
      "Wood Storage",
      "Stone Storage",
      "Ore Storage",
      "Townhall",
      "Barracks",
      "University",
      "Fortress Wall",
      "Marketplace",
      "Tavern Quarter"
    ]
  }
}
JSON
$ docker run -e SERVERS_JSON="${SERVERS_JSON}" miry/online_games_bot make run.daemon

HINT: You can use docker run option --env-file <file>, where you can store environment variables.

The process would run forewer. When there is some problem with bot, it would stop for 10 minutes, and then starts again. It is good, if you loged in in same time and do modifications onself.

Setup environment for MacOS

  1. Make an account for docker, after you’ve done that download docker. (https://docs.docker.com/v17.12/docker-for-mac/install/) Make sure to pick the stable version.
  2. Make sure you have downloaded the bot. (https://github.com/miry/online_games_bots) Have the folder on the desktop to make it easy to find.
  3. Open the bot folder, click the config folder and open (servers.yml) with your preferred text editor and fill it out with the correct information. After you’ve done that save the file and close it. Check the configuration format with http://www.yamllint.com/.
  4. Go to your terminal and follow theses steps.
  5. cd desktop (Press enter)
  6. cd online_games_bots-master/ (shortcut key after you typed online press tab it should fill out the name) (press enter)
  7. Run the processin container:
docker run -e LOG_LEVEL=debug -v $(pwd)/config:/app/config -v $(pwd)/tmp:/app/tmp miry/online_games_bot bundle exec ruby runner.rb (Press enter)
  1. If you need help please join the discord. (https://discord.gg/VaEtdbC)

Setup environment for Windows

  1. Make an account for docker, after you’ve done that download docker. (https://docs.docker.com/docker-for-windows/install/) Make sure to pick the stable version.
  2. Make sure you have downloaded the bot. (https://github.com/miry/online_games_bots) Have the folder on the desktop to make it easy to find.
  3. Open the bot folder and create a new empty file "servers_env" in it. Open servers_env with your preferred text editor and fill it out according to the following template:
SERVERS_JSON={"server": {"email": "<your_email>", "password": "<password>", "server_name": "<server_name>", "timeout": 5, ...}}

(!) Formally, this is almost the same JSON as in the example, only with the whitespaces removed (since Docker is sensitive to them). Otherwise there will be "poorly formatted environment" exception thrown. Save the file and close it. 4. Open powershell and do next steps:

cd "<bot_folder_path>"
docker run --name lk_bot --env-file servers_env miry/online_games_bot make run.daemon

If you need help please join the discord. (https://discord.gg/VaEtdbC)

Settings

The config file located in config/servers.yml. The structure is simple. First you should specify the custom server name example lak_us and bot. Note: if you want to use more than one account (for example for multiple servers), just use more definitions in servers.yml file

lak_germanien_3:
  :bot: lords_and_kinghts_v3

Now we know what kind of game you want to connect. For Lords and Knights we need to specify the server.

lak_germanien_3:
  :bot: lords_and_kinghts_v3
  :server_name: Germanien III (DE)
  :server_url: http://lordsandknights.com

lak_germanien_4:
  :bot: lords_and_kinghts_v3
  :server_name: Germanien IV (DE) 
  :server_url: http://lordsandknights.com
  • server_name is the text name that you can copy from the login page after you inpuit the credentials.
  • server_url is the login url

Config path

The default path servers config is config/servers.yml. It could be overide via option --config or -c:

$ bundle exec ruby runner.rb -c config.yml

It could be used to run multiple bots in same time:

$ bundle exec ruby runner.rb -c config_eu.yml
$ bundle exec ruby runner.rb -c config_us.yml
$ bundle exec ruby runner.rb -c config_ua.yml

Actions

  • build_first - Create a first building in the list. The order of buidlings get from :buildings
  • send_troops_to_missions - Send troops to missions for each castle.
  • research - Research 1 topic in Library or University. If there is research in progress, does not add a new to the queue.
  • send_troops_from_all_castles - Send troops to missions cross all castles and fortress (faster than send_troops_to_missions). Requires Mass Functions enabled after you conquer few castles.
  • events - Collect the prizes for completed events.
  • exchange_silver - Exchange resources from all castles to silver.
  • alliance_help - Once per round check if some of Alliance require help and click on Free help button

Example:

de3:
  :email: [email protected]
  :password: securepassword
  :server_name: Germanien III (DE) - empfohlen
  :actions:
    - build_first
    - send_troops_to_missions
    - research
    - events
    - free_gift
    - exchange_silver
        unit: Handcart
        threshold: 1000
    - exchange_silver
        unit: Ox cart
        threshold: 10000

Actions could be specified more than once, with different options. In previous example the action exchange_silver specified twice. First time it checks silver for Handcart unit, and then checks for Ox cart.

Buildings

Setup a list allowed to build buildings and the order. Depends on ui version it could be different number for buildings.

miry_us:
  :email: [email protected]
  :password: securepassword
  :server_name: Germanien III (DE) - empfohlen
  :actions:
    - build_first
    - send_troops_to_missions
    - research
    - free_gift
  :buildings:
    - Quarry
    - Lumberjack
    - Ore store
    - Wood store
    - Stone store
    - Ore mine
    - Keep
    - Farm
    - Fortifications
    - Arsenal
    - Library
    - Tavern
    - Market

You can specify max required level for building. It gives more granular upgrades and provides different kind of strategies.

:buildings:
  - Ore store:
      level: 3
  - Wood store:
      level: 3
  - Stone store:
      level: 3

  - Lumberjack:
      level: 5
  - Quarry:
      level: 5
  - Ore mine:
      level: 5

  - Library:
      level: 2

  - Lumberjack:
      level: 6
  - Quarry:
      level: 6
  - Ore mine:
      level: 6
  - Ore store
  - Wood store
  - Stone store

Check config/servers.yml.example for more options and strategies.

Logging

To increase log level, you need to specify the LOG_LEVEL env variable. Possible values: debug, info, warn, error