pull

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,25 @@
+name: Bug Report
+description: File a bug report
+body:
+  - type: textarea
+    id: details
+    attributes:
+      label: Details
+      description: Try to be as detailed as possible, what happened? What did you expect to happen? What steps can we take to reproduce the issue?
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: What version are you using?
+      placeholder: v0.4.0
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Logs
+      description: Check latest logs (logs directory) for any errors, if information is relevant, please include it here.
+    validations:
+      required: true

.github/workflows/build.yml

@@ -9,37 +9,16 @@ jobs:
     name: "Build Koolo binary"
     runs-on: windows-2022
     steps:
-      # Remove this once Windows image get fixed
-      - name: Remove Strawberry Perl from PATH
-        run: |
-          $env:PATH = $env:PATH -replace "C:\\Strawberry\\c\\bin;", "" 
-          "PATH=$env:PATH" | Out-File -FilePath $env:GITHUB_ENV -Append
-          rm C:\mingw64 -force -r
-      - name: "Install CMake"
-        run: |
-          choco install -y --force cmake 7zip.install wget
-      - name: "Install MinGW"
-        run: |
-          wget -nv https://download.qt.io/development_releases/prebuilt/mingw_64/x86_64-8.1.0-release-posix-seh-rt_v6-rev0.7z
-          7z x -aoa	-oC: x86_64-8.1.0-release-posix-seh-rt_v6-rev0.7z
-          "C:\mingw64\bin" >> $env:GITHUB_PATH
       - name: "Checkout"
         uses: actions/checkout@v4
       - name: "Setup Go"
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
         with:
-          go-version: '1.21'
-      - name: "Prepare env"
-        run: mkdir C:\go\pkg
-      - name: "Building OpenCV"
-        continue-on-error: true
-        env:
-          GOPATH: C:\go
-        run: .\prepare_env.bat
+          go-version: '1.23'
       - name: "Building Koolo artifacts"
         env:
           GOPATH: C:\go
-        run: .\build.bat
+        run: .\build.bat "${{  github.ref_name }}"
       - name: "Packing the release"
         run: 7z a -tzip koolo_${{ github.ref_name }}.zip .\build\*
       - name: Release

.gitignore

@@ -1,7 +1,13 @@
 /.idea
+/.vscode
+/.github
+/bin
 /build
 /stats
 /screenshots
-/log.txt
-/config/*.yaml
-/config/*.yml
+/logs
+
+/config/*
+!/config/template
+!/config/koolo.yaml.dist
+!/config/Settings.json

README.md

@@ -1,22 +1,30 @@
-![Koolo](images/you_died.png)
-<h1 align="center">Koolo</h1>
+<div style="background-color: #FFFACD; padding: 10px; border-radius: 5px; text-align: center">
+  <h2 style="margin: 0;">⚠️ Warning: People using this tool have been reporting bans. Do not use it.</h2>
+</div>
+<p align="center">
+  <img src="assets/koolo.webp" alt="Koolo" width="150">
+</p>
+<h3 align="center">Koolo</h3>
 
 ---
 
-Koolo is a small bot for Diablo II: Resurrected. Koolo project was built for informational and educational purposes
+Koolo is a small bot for Diablo II: Resurrected (Expansion). Koolo project was built for informational and educational purposes
 only, it's not intended for online usage. Feel free to contribute opening pull requests with new features or bugfixes.
+Koolo reads game memory and interacts with the game injecting clicks/keystrokes to the game window. As good as it can.
+
+Feel free to join our Discord community to report bugs, ask for help or just to chat: [Koolo Discord]( https://discord.gg/zgFMyzAFHE)
 
 ## Disclaimer
 Can I get banned for using Koolo? The answer is a crystal clear yes, you can get banned although at this point I'm
 not aware of any ban for using it. I'm not responsible for any ban or any other consequence that may arise from it.
 
 ## Features
-- Blizzard Sorceress, Nova Sorceress and Hammerdin are currently supported
-- Supported runs: Countess, Andariel, Ancient Tunnels, Summoner, Mephisto, Council, Eldritch, Pindleskin, Nihlathak,
-  Tristram, Lower Kurast, Stony Tomb, The Pit, Arachnid Lair, Baal, Tal Rasha Tombs, Diablo (WIP), Cows
+- Blizzard Sorceress, Nova Sorceress, FoH, Berserk Barbarian Hork (Travincal), Mosaic are currently supported. Hammerdin, Javazon and Winddruid are WIP
+- Supported runs: Countess, Andariel, Ancient Tunnels, Summoner, Mephisto, Council, Eldritch-Shenk, Endugu, Drifter Cavern, Pindleskin, Nihlathak,
+  Tristram, Lower Kurast and Superchests, Stony Tomb, The Pit, Arachnid Lair, Baal, Duriel, Tal Rasha Tombs, Diablo, Cows, Treshsocket
+- Multi window support (run multiple bots at the same time)
 - Bot integration for Discord and Telegram
-- "Companion mode" one leader bot will be creating games and the rest of the bots will join the game... and sometimes it
-  works
+- "Companion mode" one leader bot will be creating games and the rest of the bots will join the game... (not working currently)
 - Pickit based on NIP files
 - Auto potion for health and mana (also mercenary)
 - Chicken when low health
@@ -25,54 +33,59 @@ not aware of any ban for using it. I'm not responsible for any ban or any other
 - CTA buff and class buffs
 - Auto repair
 - Skip on immune
-- Auto leveling sorceress and paladin (WIP)
+- Auto leveling sorceress and paladin (WIP) this feature is not finished.
 - Auto gambling
+- Auto cubing and crafting (WIP)
+- Terror Zones (WIP)
+- Classic is not supported
 
 ## Requirements
-- Diablo II: Resurrected
-- Diablo II: LOD 1.13c (required by https://github.com/blacha/diablo2/tree/master/packages/map)
+- Diablo II: Resurrected (1280x720 required, windowed mode, ensure accessibility large fonts disabled)
+- **Diablo II: LOD 1.13c** (IMPORTANT: It will **NOT** work without it, this step is not optional)
 
 ## Quick Start
-Koolo will be clicking, moving the mouse, pressing keys... Basically this makes the computer unusable while running the
-bot. It's recommended to run it on a [virtual machine](https://github.com/jamesstringerparsec/Easy-GPU-PV).
+### Preparing the character
+- Koolo will read game keybindings in order to use the skills, doesn't matter what key is used, but the skills for the build must be set.
+- For blizzard sorceress, set the **left** skill to Glacial Spike or Ice Blast, and for Hammerdin to Blessed Hammer.
+- Foh set keybind for FOH and holybolt on left skill, conviction on right skill
+- Berserk barb set berserk as left skill. Also to use FindItem you need higher goldfind on secondary weapons slot. Alibaba + anything will work.
+- Buy TP and ID tomes and one stack of keys and keep them in the inventory, additionally set the TP tome to a key binding, this is **required**.
+- Horadric Cube can be stashed or kept in inventory, Koolo will use it to cube recipes if enabled.
+- Keep the charms in the inventory, Koolo can be configured to lock specific inventory slots.
 
-- If you haven't done yet, install **Diablo II: LOD 1.13c**
-- [Download](https://github.com/hectorgimenez/koolo/releases) the latest Koolo release, or alternatively you can [build it from source](#development-environment)
+### Running the tool
+- If you haven't done yet, install **Diablo II: LOD 1.13c** (required)
+- [Download](https://github.com/hectorgimenez/koolo/releases) the latest Koolo release (recommended for most users), or alternatively you can [build it from source](#development-environment)
 - Extract the zip file in a directory of your choice.
-- Open `config/config.yaml` with your favorite text editor and ensure `D2LoDPath` config is pointing to your **Diablo II: LOD 1.13c** installation directory.
-- Configure custom bot settings under `config/config.yaml` and `config/pickit/*.nip` files for pickit rules.
-- Open Diablo II: Resurrected and ensure the game resolution is set to windowed mode and 1280x720 or 1920x1080 in HiDPI mode.
-- Enter the game with your character.
 - Run `koolo.exe`.
-- It should start the configured runs. You can pause/resume execution with ```,``` or stop it with ```.``` keys
+- Follow the setup wizard, it will guide you through the process of setting up the bot, you will need to setup some directories and character configuration.
+- If you want to back up/restore your configuration, and for manual setup, you can find the configuration files in the `config` directory.
+
+## Pickit rules
+Item pickit is based on [NIP files](https://github.com/blizzhackers/pickits/blob/master/NipGuide.md), you can find them in the `config/{character}/pickit` directory.
 
-## How it works
-Koolo reads game memory and interacts with the game simulating clicks/keystrokes.
-It uses the following third party libraries:
+All the .nip files contained in the pickit directory will be loaded, so you can have multiple pickit files.
 
-- https://github.com/hectorgimenez/d2go
-- https://github.com/hectorgimenez/diablo2 (forked
-  from [blacha's repo](https://github.com/blacha/diablo2/tree/master/packages/map))
+There are some considerations to take into account:
+- If item fully matches the pickit rule before being identified, it will be picked up and stashed unidentified.
+- If item doesn't match the full rule, will be identified and checked again, if fully matches a rule it will be stashed otherwise sold to vendor.
+- If there is an error on the NIP file or Koolo can not understand it, the application will not start.
+- Pickit rules can not be changed in runtime (yet), you will need to restart Koolo to apply changes.
 
 ## Development environment
 **Note:** This is only required if you want to build the project from source. If you want to run the bot, you can just download the [latest release](https://github.com/hectorgimenez/koolo/releases).
 
 Setting the development environment is pretty straightforward, but the following dependencies are **required** to build the project.
 
 ### Dependencies
-- [Download MingGW](https://sourceforge.net/projects/mingw-w64/files/) ```x86_64-posix-seh``` should be fine, extract it
-  and add it to the system PATH on Windows environment variables. For example if extracted in ```C:\mingw64``` add
-  ```C:\mingw64\bin``` to the PATH. [Robotgo](https://github.com/go-vgo/robotgo) and [GoCV](https://github.com/hybridgroup/gocv#windows) dependencies requires MinGW to build.
-- [Download CMake](https://cmake.org/download/) select add it to the user path during the installation process.
-- [Download Go >= 1.21](https://go.dev/dl/)
+- [Download Go >= 1.23](https://go.dev/dl/)
 - [Install git](https://gitforwindows.org/)
 
 ### Building from source
 Open the terminal and run the following commands in project root directory:
 ```shell
 git clone https://github.com/hectorgimenez/koolo.git
 cd koolo
-prepare_env.bat
 build.bat
 ```
 This will produce the "build" directory with the executable file and all the required assets.