battlepillars-bot/README.md

# 🇺🇦 🖕

## 🍎 Бот для фарма в Battlepillars

![Battlepillars Logo](images/logo.png)

🇺🇸 [English](README-EN.md) guide!

## 💻 Требования

* [JDK](https://adoptium.net/temurin/releases/) 11.0.17+8
* [SikuliX](https://launchpad.net/sikuli/sikulix/2.0.5/+download/sikulixide-2.0.5.jar) 2.0.5 или выше
* [Jython](https://search.maven.org/artifact/org.python/jython-standalone/2.7.3/jar) 2.7.3 Standalone

## 💽 Установка Jython

Скачаиваем `jython-standalone-2.7.3.jar` и размещаем его по указанным путям
для своей операционной системы.

* Windows: `%APPDATA%\Sikulix\Extensions`
* Mac: `~/Library/Application Support/Sikulix/Extensions`
* Linux: `~/.Sikulix/Extensions`

## 🕹 Подготовка игры

1. Установить в настройках игры **оконный режим** и разрешение окна **1024x768**
2. Выбрать для гусениц скин «Кольчуга»
3. Запустить из меню игры кампанию, открыть 8 уровень
4. В качестве элементов экипировки выбрать
третий предмет: **Медик**, четвёртый предмет: **Огнемёт**
5. Запустить уровень (это необходимо, чтобы по умолчанию всегда был выбран 8 уровень)

## 🤖 Запуск бота

1. Открываем игру, заходим в компанию и оставляем игру на глобальной карте,
чтобы 8 уровень был на экране
2. Открываем скрипт `apple-farm.py` в SikuliX IDE
3. Запускаем скрипт

> Для остановки выполнения скрипта исполльзуется
> комбинация клавиш [Alt]+[Shift]+[C].

## ⭐ Дополнительно

### run-ide.bat

Скрипт для запуска **SikuliX IDE** с необходимой версией **JDK**.  
Предпологается, что директория с JDK разположена рядом с файлом IDE (`sikulixide-2.0.5.jar`).