Dead cross-platform companion: tracks data, has config profiles
- 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
Basic usage is pretty simple:
python main.pyYou can also specify a config file:
python main.py --config my_config.yamlThis is useful if you have multiple profiles.
This tool includes:
- Screen analysis: Analyzes screen regions to detect pixel changes.
- Overlay: Displays a customizable overlay.
- Crosshair: Draws a custom crosshair on the screen.
- Pixel detection: Detects specific pixel colors within regions.
- Hotkey automation: Automates actions based on hotkey presses.
- Configuion: Loads settings from a YAML file.
The config.yaml file lets you customize settings. Here's an example:
overlay:
enabled: true
color: "red"
thickness: 2
crosshair: true
monitor:
region: [0, 0, 1920, 1080]
pixel_threshold: 200
input_handler:
hotkey_toggle_overlay: "ctrl+shift+o"
hotkey_exit: "ctrl+shift+q"
paths:
log_file: "logs/application.log"
data_output: "data/output.csv"
ports:
web_server: 8080
data_stream: 5000Feel free to tweak these values to fit your needs.
If you're having issues, here are a few things to try:
- Check the
logs/application.logfile for errors. - Make sure all requirements are installed (
pip install -r requirements.txt). - Verify your
config.yamlfile is valid YAML (use a YAML validator). - Ensure you have the necessary permissions to access the screen.
- Restart the application.
WIP: Adding more detailed troubleshooting steps later.## FAQ
How do I change the overlay color?
Edit theconfig.yaml file and change the overlay.color value. Valid colors are "red", "blue", "green", etc.
The overlay isn't showing up. What do I do?
Make sureoverlay.enabled is set to true in the config file. Also, check your logs for any errors.
Can I use different hotkeys?
Yep! Just modify theinput_handler section of the config file.
Before running, make sure you have the following packages installed. You can install them using pip:
pip install -r requirements.txtHere's a breakdown:
pyyaml: For reading config files.Pillow: Used for image processing and screen analysis.pynput: Handles global hotkey input.numpy: For numerical opeions, good for pixel detection.
This project is licensed under the MIT License