Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Nick2bad4u authored Apr 12, 2024
1 parent dca009f commit 415c4d8
Showing 1 changed file with 20 additions and 29 deletions.
49 changes: 20 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# **BHBot**
#### **Gold/XP farming bot for Brawlhalla**

[![Semgrep](https://github.com/Nick2bad4u/BHBot/actions/workflows/semgrep.yml/badge.svg)](https://github.com/Nick2bad4u/BHBot/actions/workflows/semgrep.yml)
[![Upload Python Package](https://github.com/Nick2bad4u/BHBot/actions/workflows/python-publish.yml/badge.svg)](https://github.com/Nick2bad4u/BHBot/actions/workflows/python-publish.yml)
[![Python Package using Conda](https://github.com/Nick2bad4u/BHBot/actions/workflows/python-package-conda.yml/badge.svg)](https://github.com/Nick2bad4u/BHBot/actions/workflows/python-package-conda.yml)
Expand All @@ -14,39 +17,24 @@
[![Sobelow](https://github.com/Nick2bad4u/BHBot/actions/workflows/sobelow.yml/badge.svg)](https://github.com/Nick2bad4u/BHBot/actions/workflows/sobelow.yml)
[![Lint Code Base](https://github.com/Nick2bad4u/BHBot/actions/workflows/super-linter.yml/badge.svg)](https://github.com/Nick2bad4u/BHBot/actions/workflows/super-linter.yml)

# **BHBot**

[Latest Release](https://github.com/Nick2bad4u/BHBot/releases)
- **[Latest Release](https://github.com/Nick2bad4u/BHBot/releases)** - Download Python (Source Code) or Compiled EXE version for Windows here.
###### (Looking for a Mac user to compile it into a .DMG file, if you know any or would be willing to do this, let me know.)

Edit: USA users that want to use stealth mode, please do the following (otherwise everytime the "earn free rewards" pops up it will stop the bot until cleared)

1. %localappdata%\BHBot - Navigate to this folder
2. Edit the file "bhbot.cfg" and change the following from:
`"mute": true` to `"mute": false`
3. Save file.
4. If you change the settings in the bot again, you need to re-apply this. I plan to make a fix.
**USA** users that want to use stealth mode, please do the following: (otherwise everytime the *"earn free rewards"* pops up it will stop the bot until cleared)
- You need to go into the bot settings and unselect "mute" if you are using stealth mode in the USA.
- Manually mute the bot via Windows Volume Mixer

[Этот файл доступен на Русском языке](README_RU.md)

Gold/XP farming bot for Brawlhalla

Heavily inspired by [BrawlhallaEZ](https://github.com/jamunano/BrawlhallaEZ)

**WARNING:** Bot was initially made for personal use. It should not, but still can cause some unexpected consequences, including making purchases from mallhalla (with in-game currencies). Developer is
not responsible for any harm the program may case. Use at your own risk

[Virus Total Scan](https://www.virustotal.com/gui/file/af110c1886ba1a24c1122cfc527d0183a4650bb933a35d44c2389ed1d585b489?nocache=1)
![Results](https://github.com/Nick2bad4u/BHBot/assets/20943337/92bb7f30-e7ae-4e85-a13b-95a6530eeaf9)

[Submitted to Microsoft as a False Positive for Windows Defender, coming back clean as of 3-12-24.](https://www.microsoft.com/en-us/wdsi/submission/e9889ce6-6dc9-44bc-b7ba-c5759544b2a4)
![Windows Defender Results](https://i.gyazo.com/acbabb1aa492c86852e5ca2027044992.png)

(it should work fine tho, I tested it for >600 hours at this point)
- **WARNING:** Bot was initially made for personal use. It should not, but still can cause some unexpected consequences, including making purchases from mallhalla (with in-game currencies). Developer is not responsible for any harm the program may case.
- **Use at your own risk**
- ###### (It should work fine, I tested it for >2000 hours at this point along with a variety of other people)

# Installation
Latest release can always be downloaded [here](https://github.com/Nick2bad4u/BHBot/releases/)

Bot _should_ auto-update as soon as any updates are released according to selected branch in settings
Latest release can always be downloaded [here](https://github.com/Nick2bad4u/BHBot/releases/)

# Features

Expand All @@ -62,14 +50,17 @@ Bot _should_ auto-update as soon as any updates are released according to select
- ~~Brews you coffee~~ (only tea supported for now)

# Usage
Should be pretty straightforward. Just select needed settings and click "Start" :)

- Should be pretty straightforward. Just select needed settings and click "Start" :)

# Limitations
- Bot requires "Collapse crossovers" to be set to Yes.

- Bot requires "Collapse crossovers" to be set to Yes.
- Bot requires ingame language to be set to English.

# Internal stuff
You can always check the code, but basically bot uses windows SendMessage API to send inputs directly to Brawlhalla window and pixel detection to detect states and
decide what to do at any given point

You can use BrawlhallaBot class directly or write your own wrapper for it. It should be completely independent and gui.py is just a PySimpleGUI graphical wrapper
- You can always check the code, but basically the bot uses Windows SendMessage API to send inputs directly to a Brawlhalla window with pixel detection to detect states of the game and then decide what to do at any given point - depending on mode selected

- You can use BrawlhallaBot class directly or write your own wrapper for it.
- It is completely independent and gui.py is just a PySimpleGUI graphical wrapper

0 comments on commit 415c4d8

Please sign in to comment.