Skip to content

Commit

Permalink
3.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@swiftb
swiftb committed Jan 25, 2016
2 parents eb7eb9a + f9aafd6 commit 7a16c28
Show file tree
Hide file tree
Showing 16 changed files with 881 additions and 320 deletions.
3 changes: 3 additions & 0 deletions FAQ.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@

## Vision Run

**Q:** I get a "Start failed (state = 0)!" warning, what's wrong?
**A:** In Windows, use standard 100% (96 DPI) display scaling in (32 bit) True Color

**Q:** The Vision run gets stuck before reaching my gilded ranger!?
**A:** You need one transitional hero/ranger (with 1 gild) that the bot can find after the clickable/Midas start.

Expand Down
85 changes: 51 additions & 34 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Clicker Heroes Sw1ft Bot

A mid/late game bot for [Clicker Heroes][Reddit].
A game bot for [Clicker Heroes][Reddit].

## Overview

Expand All @@ -25,6 +25,7 @@ A mid/late game bot for [Clicker Heroes][Reddit].
* Built in re-gilder between rangers
* Option to auto-save before ascending
* Monitored _click safety zones_ preventing bot misclicks
* Logging to file

### Features without image search

Expand All @@ -38,7 +39,7 @@ A mid/late game bot for [Clicker Heroes][Reddit].
- Intended as a continuation of a speed run
- Utilizes the external _monster clicker_

Limitations:
**Limitations:**

* Without the support from visual cues, it is critically important that the [recommended game state](#minimum-recommended-game-state) is adhered to.

Expand All @@ -51,34 +52,40 @@ Limitations:
- Picks up *clickables* without breaking idle
- Does a Midas start if no clickable
- Can automatically resume
- Can be set to run in early game mode
* Enhanced Midas starts
* Can auto-level Solomon
* Hotkeys for raiding

Limitations:
**Limitations:**

* Only supported in the browser client (in low quality)
* Window must be visible in the foreground

### Minimum recommended game state

To operate as intended, the (background) Speed run needs a certain minimum game state:
**To operate as intended, the (background) Speed run needs a certain minimum game state:**

* Atlas or higher ranger gilded
- Any transitional hero/ranger used by the script must also be gilded
- Any transitional hero used by the script must also be gilded
* _Optimal zone_ > 1000
* Iris > 145 (and within 1001 levels of the _optimal zone_)
* Siyalatas > 200
- All other ancients must follow the [Rules of Thumb][]. Use the [Ancients Calculator][] to balance your ancients optimally.

These recommendations should give you enough gold after ascending with a *[clickable][Clickables]*, to instantly unlock, level and buy all upgrades for every hero down to and including Frostleaf.

Recommended minimum for the (foreground) Vision run:
**_Minimum Iris lvl formula_:** `x * 250 + 29`, where `x = 1` for Terra (279), `x = 2` for Phthalo (529) and so on. This allows you to use a transitional hero 3 steps above you main gilded ranger. E.g. with Lilin gilded and an Iris above `4 * 250 + 29 = 1029`, you can use Terra as your transitional hero (having 1 gild).

**Recommended minimum for the (foreground) Vision run:**

* Samurai gilded
- If the gilded hero is not visible after a clickable or Midas start, a transitional hero must be gilded

Midas start requirements:
* [Early Game Mode] World Ascensions > 2
- Need the Progression Mode option and the Buy Available Upgrades button

**Midas start requirements:**

* A maxed Khrysos
* Iris equal or higher than the _zone 2_ setting
Expand All @@ -101,10 +108,13 @@ Unless they already exist, three user settings files will be created as copies o

`ch_bot_lib_settings.ahk`, `ch_bot_settings.ahk` and `monster_clicker_settings.ahk`.

Note: If your Windows account don't have administrator rights, you might have to start the script by right-clicking it and select **Run as Administrator**.
**Note:** If your Windows account don't have administrator rights, you might have to start the script by right-clicking it and select **Run as Administrator**.

## Configuration

* In Windows:
- Set display scaling to 100% (96 DPI)
- Use True Color (32 bit)
* In Clicker Heroes, turn off:
- __Show damage texts__ (can cause progression mode issues if left on)
- __Show relic found popups__
Expand All @@ -121,16 +131,26 @@ These only need to be changed if you run the browser client.

| Variable | Explanation |
| -------- | ----------- |
`SetTitleMatchMode` | **`3`** for Steam or **`regex`** for browser version <sup>(1)</sup>
`browser` | Browser name (e.g. Opera)
`SetTitleMatchMode` | **3** for Steam or **regex** for browser version <sup>(1)</sup>
`browser` | Browser name (e.g. Opera)
`browserTopMargin` | Browser top margin <sup>(2)</sup>

(1) Browser recommendation: Run Clicker Heroes in Opera, then use Chrome or some other browser for your normal surfing activities.

(2) Make sure the Clicker Heroes window have focus, then click <kbd>Ctrl+Middle Mouse Button</kbd> dead center in the ancient tab eye like this: ![](images/ancient_eye_click.png?raw=true). Update the top margin and reload the script with <kbd>Alt+F5</kbd>, then position your mouse cursor at the top left corner (of the CH area) and click <kbd>Alt+Middle Mouse Button</kbd>. If the setting is correct, it should look like this:
![](images/top_corner_alt_mmb.png?raw=true)

Known issues:
### Optional lib settings

| Variable | Explanation |
| -------- | ----------- |
`fullScreenOption` | [**true**/**false**] Steam borderless fullscreen
`showSeverityLevel` | **0**:OFF, **1**:WARN, **2**:USER, **3**:INFO, **4**:DEBUG
`logSeverityLevel` | **0**:OFF, **1**:WARN, **2**:USER, **3**:INFO, **4**:DEBUG

Setting a level to X, will show or log all messages from that level and below. E.g. setting `showSeverityLevel` to **1** and `logSeverityLevel` to **4**, will only show warning messages as splash texts, but will log everything to file.

**Known issues:**

* If active, the power savings setting turning of your monitor(s) can cause issues with AHK's image recognition. When last tested, only Firefox continued to run without any issues.
* The script can't handle any extra _stuff_ on the left side, e.g. a bookmark list.
Expand All @@ -142,38 +162,38 @@ Known issues:
| Variable | Explanation |
| -------- | ----------- |
`irisLevel` | Set to your Iris level in game
`gildedRanger` | The number of your main gilded ranger <sup>(3)</sup>

(3) **1**:Dread Knight, **2**:Atlas, **3**:Terra, **4**:Phthalo, **5**:Banana, **6**:Lilin, **7**:Cadmia, **8**:Alabaster, **9**:Astraea, **10**:Chiron, **11**:Moloch, **12**:Bomber Max, **13**:Gog, **14**:Wepwawet

#### Mandatory Speed run settings

| Variable | Explanation |
| -------- | ----------- |
`speedRunTime` | The duration of the speed run <sup>(3)</sup>
`gildedRanger` | The number of your gilded ranger <sup>(4)</sup>
`speedRunTime` | The duration of the speed run <sup>(4)</sup>

(3) Set according to the [Ancients Optimizer][] (open with <kbd>Ctrl+F5</kbd>).
(4) Set according to the [Ancients Optimizer][] (open with <kbd>Ctrl+F5</kbd>).

(4) **1**:Dread Knight, **2**:Atlas, **3**:Terra, **4**:Phthalo, **5**:Banana, **6**:Lilin, **7**:Cadmia, **8**:Alabaster, **9**:Astraea, **10**:Chiron, **11**:Moloch, **12**:Bomber Max, **13**:Gog, **14**:Wepwawet
**Important!** Use the Siyalatas [regilding chart][] to make sure you are gilded correctly. Any transitional hero used by the bot must also be gilded.

**Important!** Use the Siyalatas [regilding chart][] to make sure you are gilded correctly. Any transitional hero/ranger used by the bot must also be gilded.

#### Mandatory Deep run settings
#### Mandatory Vision run settings

| Variable | Explanation |
| -------- | ----------- |
`deedRunTime` | The duration of the deep run
`deepRunClicks` | [`true`/`false`] Actively click?
`useImageSearch` | Set to **true**
`endLvlIdle` | Idle end level
`endLvlActive` | Active end level

Note: With `deepRunClicks` set to true, the separate _monster clicker_ script will be automatically started and controlled by the main bot script.
Set `endLvlActive` to zero for idle, `endLvlIdle` to zero for active and `endLvlActive` higher than `endLvlIdle` for hybrid.

#### Mandatory Vision run settings
#### Mandatory Deep run settings

| Variable | Explanation |
| -------- | ----------- |
`useImageSearch` | Set to `true`
`endLvlIdle` | Idle end level
`endLvlActive` | Active end level
`deedRunTime` | The duration of the deep run
`deepRunClicks` | [**true**/**false**] Actively click?

Set `endLvlActive` to zero for idle, `endLvlIdle` to zero for active and `endLvlActive` higher than `endLvlIdle` for hybrid.
**Note:** With `deepRunClicks` set to true, the separate _monster clicker_ script will be automatically started and controlled by the main bot script.

### Optional bot settings

Expand All @@ -197,9 +217,9 @@ The Vision run is usually not that picky about game state, just try start it wit
| State | Error | Solution |
| ----- | ----- | -------- |
-3 | No Clicker Heroes window found | Open the client
-2 | No vision | Set `useImageSearch` to `true`
-2 | No vision | Set `useImageSearch` to **true**
-1 | Vision, but not in browser | Use the browser client
0 | Vision, but not finding anything | Use standard (100%) Windows sizes
0 | Vision, but not finding anything | In Windows, use standard 100% (96 DPI) display scaling in (32 bit) True Color

## Main Hotkeys

Expand All @@ -215,7 +235,7 @@ The Vision run is usually not that picky about game state, just try start it wit
<kbd>Shift+Ctrl+F5</kbd> | Schedule a script reload after finishing the current run, then restart it
<kbd>Alt+F6</kbd> | Re-initialize coordinates (needed after moving or re-sizing the client window)

(5) Requires `useImageSearch` set to `true`.
(5) Requires `useImageSearch` set to **true**.

#### Supplementary Hotkeys

Expand All @@ -234,12 +254,9 @@ These hotkeys can be executed while a speed, deep or vision run is active.
<kbd>Win+F7</kbd> | One paid raid <sup>(5)</sup>
<kbd>Win+F8</kbd> | `raidAttempts` paid raids <sup>(5)</sup>
<kbd>Shift+Ctrl+F1</kbd> | Toggle the `autoAscend` flag
<kbd>Shift+Ctrl+F2</kbd> | Toggle the `screenShotRelics` flag
<kbd>Shift+Ctrl+F6</kbd> | Toggle the `playNotificationSounds` flag
<kbd>Shift+Ctrl+F7</kbd> | Toggle the `playWarningSounds` flag
<kbd>Shift+Ctrl+F8</kbd> | Toggle the `showSplashTexts` flag
<kbd>Shift+Ctrl+F11</kbd> | Toggle the `saveBeforeAscending` flag
<kbd>Shift+Ctrl+F12</kbd> | Toggle the `debug` flag

(6) Will pause the monster clicker if running.

Expand All @@ -248,7 +265,7 @@ These hotkeys can be executed while a speed, deep or vision run is active.
| Hotkey | Function |
| ------ | -------- |
<kbd>Ctrl+Alt+F1</kbd> | Should scroll down to the bottom
<kbd>Ctrl+Alt+F2</kbd> | Should switch to the relics tab and then back
<kbd>Ctrl+Alt+F2</kbd> | Should switch between all used tabs
<kbd>Alt+F1</kbd> | Test the `getClickable()` function
<kbd>Alt+F2</kbd> | Test the `initRun()` function
<kbd>Alt+F3</kbd> | Test the `speedRun()` function
Expand All @@ -265,7 +282,7 @@ Check the [FAQ](FAQ.md) or visit the original script [home][] on Reddit.
[Steam]: http://store.steampowered.com/app/363970/
[Web]: https://www.clickerheroes.com/
[AutoHotkey]: http://ahkscript.org/
[Rules of Thumb]: http://redd.it/339m3j
[Rules of Thumb]: https://redd.it/3y57jd
[Ancients Calculator]: http://hsoptimizer.github.io/ancient/
[Ancients Optimizer]: http://philni.neocities.org/ancientssoul.html
[regilding chart]: https://redd.it/3frj62
Expand Down
Loading

0 comments on commit 7a16c28

Please sign in to comment.