Installation - Cyrexxis/RokTracker GitHub Wiki

Installation

There are two ways of installing the scanner, the easy way with an EXE file and the advanced way where you run the python file directly. If you have no experience with programming, I highly recommend using the simple way.

Emulator Settings

You need to set these options exactly like that (tabs refer to bluestacks):

  • Display Tab
    • Resolution: 1600x900
    • DPI: Custom (450)
  • Advanced Tab
    • Android Debug Bride: Turned on

Simple Installation

Requirements

  1. Bluestacks 5 https://www.bluestacks.com/de/bluestacks-5.html or LD Player 9 https://en.ldplayer.net/
  2. To use tesserocr you also need to download the trained tesseract models https://github.com/tesseract-ocr/tessdata
  3. ADB Platform Tools Download and Extract (See Important Notes) https://dl.google.com/android/repository/platform-tools_r31.0.3-windows.zip
  4. Tested on Windows 11

Setup

  1. Download the latest release for your system here: Latest Release (choose RoK Tracker.zip)
  2. Extract the zip in the folder where you want the scanner to be installed in
  3. Download the requirements 2 (tessdata) and 3 (platform-tools) and extract them in the deps folder
    • tesseract needs to go into deps/tessdata/
    • platform-tools need to go into deps/platform-tools
    • complete tree how the folder should look like are here
  4. Configure your Bluestacks instance according to the instructions

Usage

  1. Adjust the default options in the config.json file to your liking
  2. Double-click the EXE like any normal program and enjoy the scanner
  3. The results of the scans can be found in the scans-* folder, where * is the type of scan you are doing

Simple File/Folder Structure

./
├─ _internal/
│ ├─ ...
├─ deps/
│ ├─ inputs/
│ ├─ tessdata/
│ │ ├─ *.traineddata
│ │ ├─ ...
│ ├─ platform-tools/
│ │ ├─ adb.exe
│ │ ├─ ...
├─ config.json
├─ *.exe

Advanced Installation

Requirements

  1. Bluestacks 5 https://www.bluestacks.com/de/bluestacks-5.html or LD Player 9 https://en.ldplayer.net/
  2. Python 3.12 Installation https://www.python.org/downloads/release/python-3123/
  3. To use tesserocr you also need to download the trained tesseract models https://github.com/tesseract-ocr/tessdata
  4. ADB Platform Tools Download and Extract (See Important Notes) https://dl.google.com/android/repository/platform-tools_r31.0.3-windows.zip
  5. On Windows, "Microsoft Build Tools for C++" might be required for some python packages https://visualstudio.microsoft.com/de/visual-cpp-build-tools/
  6. Tested on Windows 11. Needs Python 3.12.x, otherwise you will need to modify the requirements.

Setup

  1. Download the latest release for your system here: Latest Release (choose the source code option), alternatively clone the git repository
  2. Download and install Python and Build Tools for C++
  3. Download the requirements 3 (tessdata) and 4 (platform-tools) and extract them in the deps folder
    • tesseract needs to go into deps/tessdata/
    • platform-tools need to go into deps/platform-tools
    • complete tree how the folder should look like are here
  4. Open your terminal in this folder and create a venv via python -m venv venv
  5. Activate that venv via ./venv/Scripts/activate
  6. Install the python requirements via pip install -r requirements_win64.txt
  7. Configure your Bluestacks instance according to the instructions

Usage

  1. Open a terminal in your rok tracker folder
  2. Activate the venv via ./venv/Scripts/activate
  3. Start the scanner:
    • python kingdom_scanner_console.py for the CLI version of the kingdom scanner
    • python kingdom_scanner_ui.py for the GUI version of the kingdom scanner
    • python alliance_scanner_console.py for the CLI version of the alliance scanner
    • python alliance_scanner_ui.py for the GUI version of the alliance scanner
    • python honor_scanner_console.py for the CLI version of the honor scanner
    • python honor_scanner_ui.py for the GUI version of the honor scanner
  4. The results of the scans can be found in the scans-* folder, where * is the type of scan you are doing

Folder/File Structure

./
├─ deps/
│ ├─ inputs/
│ ├─ tessdata/
│ │ ├─ *.traineddata
│ │ ├─ ...
│ ├─ platform-tools/
│ │ ├─ adb.exe
│ │ ├─ ...
├─ config.json
├─ *_scanner_console.py
├─ *_scanner_ui.py
├─ ...