[
Battlefield — Open-source BF HUD: HUD shown, display configurable
- Download the latest release from the link above
- Extract the archive (WinRAR / 7-Zip)
- Run
python main.py(or see Usage below) - Configure settings in
config.yaml
Make sure you've got Python 3.11 or higher installed. You'll also need these packages:
pip install -r requirements.txt
That should take care of everything. If it doesn't, double-check your Python version and that pip is up-to-date.
The config.yaml file holds all the settings. Here's an example:
overlay:
enabled: true
color: "red"
opacity: 0.75
analyzer:
port: 8080
threshold: 0.8
crosshair:
style: "dot"
size: 5
color: "white"
paths:
log_file: "C:\\path\\to\\game.log"
output_dir: "C:\\path\\to\\output"Adjust these values to fit your needs. The analyzer port is important if another app is trying to communicate with it.
To run the HUD:
python core.pyThat's the main entry point. It'll load the config, start the analyzer, and display the overlay. You can also run the individual modules if you need to debug or test something.
- Screen analysis: Analyzes the game screen in real-time.
- Overlay: Displays a configurable overlay on top of the game.
- Crosshair: Custom crosshair overlay.
- Pixel detection: Detect specific pixels on the screen.
- Hotkey automation: Automate actions using hotkeys.
- Configuration: All settings are configurable via a YAML file.
Why is the overlay not showing up?
Make sure the `overlay.enabled` option in `config.yaml` is set to `true`. Also, check that your game is running in windowed or borderless mode, as fullscreen mode can sometimes interfere with overlays.How do I change the crosshair color?
Edit the `crosshair.color` value in `config.yaml`. You can use standard color names (e.g., "red", "blue") or hexadecimal color codes (e.g., "#FF0000").Can I use this with multiple games?
It's designed for one game at a time. You might be able to modify it to work with others, but it's not officially supported. WIP: Multi-game profile support.Feel free to fork and modify!