search

Cyrexxis / RokTracker

Open Source Rise of Kingdoms Stats Management Tool. Track TOP X Players of kingdom / alliance / honor leaderboard.
MIT License
46 stars 18 forks source link

readme

Rok Tracker

Latest Changes

Summary

Open Source Rise of Kingdoms Stats Management Tool. Track TOP X Players in kingdom / alliance / honor leaderboard. Depending on what you scan the resulting .xlsx will look different:

For kingdom rankings Governor Id, Governor Name, Power, Kill Points, Ranged Points, T1/T2/T3/T4/T5 Kills, Total kills, T4+T5 kills, Dead troops, RSS Gathered, RSS Assistance, Helps and Alliance name will get saved.

For the honor and alliance rankings only the governor name and the score will be saved. Because there is no guarantee that the name is correct a picture of the name will be saved in addition.

This is a heavily modified version of the original tool from nikolakis1919 in the repository https://github.com/nikolakis1919/RokTracker

There are two ways of installing and using the scanner. The first is an exe file with no need for other software to be installed. This approach is described under simple installation. The second way of using the scanner is by using the python files directly. However, for that approach you need to have a running python installation and have to install the dependencies manually. This is explained under advanced installation.

Simple installation

Required

  1. Bluestacks 5 Installation https://www.bluestacks.com/de/bluestacks-5.html
  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 10 and 11, could work on Windows 7

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

Required

  1. Bluestacks 5 Installation https://www.bluestacks.com/de/bluestacks-5.html
  2. Python 3.11 Installation https://www.python.org/downloads/release/python-3110/
  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 für C++" might be required for some python packages https://visualstudio.microsoft.com/de/visual-cpp-build-tools/
  6. Tested on Windows 10 and 11, could work on Windows 7. Tested with Python 3.11.0 and 3.11.7.

Setup

  1. Download the latest release for your system here: Latest Release (choose the source code option)
  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
├─ ...

Features

Kingdom Scanner

Alliance and Honor Scanner

Bluestacks 5 Settings

Main configuration

Configuration for automatic port detection

Important Notes

General

  1. It is recommended to use a venv to keep your global python installation clean of the dependencies. After setting up the venv and activating it, you can install the requirements with the requirements.txt file (more about that in the "Usage" section)
  2. The scanner does not need admin privilege to run
  3. Make sure your folder structure matches the expected structure
  4. Bluestacks settings must be the same as in pictures above. THIS IS VERY IMPORTANT!
  5. BE CAREFUL to always copy the .xlsx file from the scans folder when it is finished, because in the next capture, there is a chance for it to get overwritten (very low chance).
  6. Chinese letters might not be shown properly in CMD, but they are visible in the final .xlsx file.
  7. You can do whatever you want in your computer when tool is scanning. Only be warned that copying can result in wrong governor names if it coincides with the name copy of the script.
  8. Game Language has to be English. Anything else will cause trouble in detecting inactive governors. Change it only for scan, if yours is different and then switch back.

Scan

  1. In order to get only your kingdoms ranks, the character that is currently logged in game must be in HOME KINGDOM, else you will get all the players in your KvK including players from different kingdoms.
  2. The view before running the program should be at the top of power rankings or at the top of kill points rankings for the rok-scanner.py or at the top of an alliance leader board of your choice or at top of the personal honor rank for the alliance-scanner.py. No move should be made in this window until scanning is done.
  3. [Only for kingdom scan] Account must be lower in ranks than the amount of players you want to scan. e.g. Cannot scan top 100 when character's rank is 85. Use a farm account instead.
  4. [Only for kingdom scan] Resume Scan option starts scanning the middle governor that is displayed in screen. The 4th in order. So before starting the tool make sure that you are in the correct view in bluestacks.

Error reporting / help

Recently people started to random guess my discord name. So I'll just make it public here, it's simply cyrexxis same as my Github username.

I try my best to help those people, but I will set up some rules for help requests:

A second way I will set up is Github discussions. The advantage with that is that other people see the mistakes and errors, maybe it helps them to fix them by their own.