README.md

BHBot

What is BHBot?

BHBot is a program that automates the Bit Heroes game. It is a non intrusive program that works by opening up a Chromium window and controls the game by taking a screenshot every few seconds, detecting cues from the screenshot and then simulating mouse clicks. BHBot is a good example of how to create such bots to automate flash games or other browser games (it can be easily adjusted to play other games).

Once configured and running the bot is designed to run unattended indefinitely.

Features

This bot will automatically farm items, familiars and schematics running all current content:

• Dungeons
• World Bosses
• Raids
• Gauntlet / Trials
• PvP / GvG
• Expedition / Invasion

The level/difficulty for each activity can be defined in the settings file. The bot can also:

• Bribe specific familiars with gems
• Revive fallen party members
• Save shrines for use before the boss in Trials and Raids
• Switch runes based on activity
• Notify you on your mobile devices through Pushover on how it is doing and if any issue is present
• Use consumables to keep boosts running unattended
• Strip items for PvP/GvG
• Solo certain zones for bounty requirements
• Collect completed bounties
• Collect fishing baits
• Claim all weekly rewards
• Screenshot and close PMs
• Open skeleton chests
• Handle incomplete teams

If the bot detects a "Disconnected" dialog, it will pause its execution for an hour giving the user a chance to play manually. Disconnects are usually result of another instance logging into the game. This is why bot pauses in case it detects it.

Download

You can download the latest stable release BHBot.jar from the releases page.

For the latest functionality it is recommended to compile your own version as there are frequent commits with bug-fixes and new functionality between major releases.

First time setup

See the wiki for the first time setup guide.

Important

• While bot is running, do not interfere with the Chromium window that the bot has open via chromedriver. That means don't open menus and click around since that may confuse the bot and it could fail to do its tasks (which could lead to crashing it).
• If you want to continue using your computer while running the bot use, the 'hide' command to minimize the window. The bot clicks on certain buttons and cues and expects certain thing to pop up, and if they don't (due to user interaction), then it will fail to function properly.
• If you are running the bot in Windows, you may want to run it under a separate account in order for it to not interfere with your work.

Commands

Here is a list of most common commands used with the bot (must be typed in the console window, or, if you use web interface, in the command input box):

• do dungeon|expedition|gauntlet|gvg|pvp|raid|trials: force the bot to perform a dungeon . Example: "do raid". Used for debugging purposes more or less (bot will automatically attempt dungeons).
• hide: hides Chromium window.
• pause [mins]: pauses bot's execution. Useful when you want to play the game yourself (either from the same Chromium window, or by starting another Chromium window). The bots is paused untill are resue command is issued or, if specified, for a number of minutes equal to mins
• plan <plan_name>: if you have different configurations you can use this command to swith between them. BHBot will look for file named <plan_name.ini> in the plans/ subfolder
• pomessage [message]: use this command to verify that the Pushover integration is correctly configured. Message parameter is optional and if not specified, a standard messabe will be sent.
• print: Using this command, you can print different informations regarding the bot
  • familiars: output the full list of supported familiars in the encounter management system
  • version: output the version of BHBot. This is is useful when reporting a bug
• readouts: will reset readout timers (and hence immediately commence reading out resources).
• reload: will reload the 'settings.ini' file from disk and apply any changes on-the-fly.
• resetini: will reset your current ini file to the default content.
• restart: restarts the chromedriver (closes Chromium and opens a fresh Chromium window). Use only when something goes wrong (should restart automatically after some time in that case though).
• resume: resumes bot's execution.
• set: sets a setting line, just like from a 'settings.ini' file. Example: "set raids 1 3 100", or "set difficulty 70". Note that this overwritten setting is NOT saved to the 'settings.ini' file! Once you issue command, it will get discharged.
• shot [prefix]: takes a screenshot of the game and saves it to 'shot.png'. If a prefix is specified it will be used instead of the default shot one.
• show: shows Chromium window again after it has been hidden.
• stop: stops the bot execution (may take a few seconds. Once it is stopped, the console will close automatically).

Donate

BHBot is free and always will be. If you would like to make a donation towards the project you can use Paypal or Liberapay.

Authors

BHBot was originally created by Betalord. On 29th of September 2017 (the 1st year anniversary of the Bit Heroes game) he quit the game and released the bot to the public. In December 2018 Fortigate picked up the development and from March 2019 ilpersi joined him to make the bot what it is today. In June 2019 the project ownership was tranferred to ilpersi, granting autonomy moving forwards.

Special thanks

The bot would not exist without everybody who uses or contributes to it.

A special mention goes to the teams that created two amzing products:

• the IntelliJ team who granted us a free open-source IntelliJ Ultimate license that we use to code the bot.
• the JProfiler team, a Java profiler tool, that granted us a free open-source license to help make this tool even better.

Finally

Hopefully this bot will prove useful to you, if you have any questions just raise an issue or join our gitter room in which you can talk directly with the developers! Enjoy :-)

Made with love using and