🎮 battlefield-kit

[

Live battlefield stats, screen analysis, and themes on a custom dashboard

📥 Download

1. Download the latest release from the link above
2. Extract the archive (WinRAR / 7-Zip)
3. Run python main.py (or see Usage below)
4. Configure settings in config.yaml

Configuion

The config.yaml file is where you set everything up. Here's a quick example:

overlay:
 enabled: true
 font_size: 16
 color: "#FFFFFF" # White
 position:
 x: 10
 y: 50

screen_analysis:
 enemy_threshold: 200
 ally_threshold: 150

hotkeys:
 toggle_overlay: "F9"
 _screen: "F10"

ports:
 web_interface: 8080

paths:
 log_file: "logs/application.log"

crosshair:
 enabled: true
 style: "dot"
 color: "red"
 size: 5

Feel free to mess around with these values. It's all pretty self-explanatory.

How to Run

Alright, so you've downloaded and extracted the thing. Now what?

1. Install dependencies: Open your command prompt or terminal. Then, navigate to the directory where you extracted the files (cd path/to/battlefield-kit). Run pip install -r requirements.txt. This gets all the Python stuff you need.
2. Run the launcher: Simply execute python engine.py. This should fire up the application.
3. Configure: Check the config.yaml file for settings. You might want to tweak things like hotkeys or display options to your liking.

That's basically it. If it doesn't work... check Troubleshooting below!

Features

• Screen Analysis: Analyzes the screen to detect enemies, allies, or other in-game elements using pixel detection.
• Overlay: Displays an in-game overlay with live stats and information.
• Crosshair: Provides a customizable crosshair overlay.
• Hotkey Automation: Allows you to automate tasks using hotkeys.
• Configuion: Everything is configurable through a YAML file.## FAQ

Why isn't the overlay showing up?

First, make sure overlay.enabled is set to true in your config file. Double-check that the hotkey for toggling the overlay is correctly configured and that you're pressing it in-game. Also, some games might block overlays. Try running the app as administor.

How do I change the crosshair color?

Open config.yaml. Find the crosshair section. Change the color value to your desired color (e.g., "red", "blue", "#00FF00").

Where are the logs saved?

The default location is logs/application.log. You can change this in the paths.log_file setting in config.yaml.

TODO: Add more FAQs based on user feedback.

Requirements

You'll need Python 3.11 or later. Also, these Python packages are required (they're in requirements.txt):

• PyYAML
• Pillow
• keyboard
• opencv-python
• Flask
• requests

Just run pip install -r requirements.txt to get them installed.

---

Contributions are welcome! Feel free to open a PR.