Minecraft mod: tracks data, offers themes and settings to customize
- 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
Alright, got it downloaded? Sweet. Here's how to get it running.
- Make sure you have Python 3.11+ installed.
- Open a terminal in the extracted directory.
- Run
python engine.py. This will start the mod. - Configure your overlay and settings in the
config.yamlfile.
You'll need a few Python packages. Luckily, it's easy to install 'em.
pip install -r requirements.txt- This will install stuff like
PyYAMLandPillow.
The config.yaml file lets you tweak everything. Here's an example:
overlay:
enabled: true
font_size: 16
color: [255, 255, 255]
position: [10, 50]
crosshair:
enabled: true
color: [255, 0, 0]
size: 15
hotkeys:
toggle_overlay: "f10"
some_action: "ctrl+shift+a"
pixel_detection:
threshold: 20
target_color: [100, 150, 200]
region: [100, 100, 200, 200]
ports:
http_port: 8080
websocket_port: 8081Want to help out? Awesome!
- Fork the repo.
- Make your changes.
- Submit a pull request.
Please follow the existing code style. Also, add tests if you're adding new features.
Here's what's packed in:
- Screen analysis: figures out what's on your screen.
- Overlay: displays custom info on top of the game.
- Crosshair: custom crosshair overlay.
- Pixel detection: detects specific colors on the screen.
- Hotkey automation: triggers actions with hotkeys.
- Configuration: tweak all settings in the
config.yamlfile.
The overlay isn't showing up. What's wrong?
Make sure it's enabled in the config. Also, check if your game is running in windowed or borderless windowed mode. Sometimes fullscreen messes things up.Can I change the font used in the overlay?
Not yet, but it's on the TODO list! WIP: add custom font support.🔥 New features coming soon!