Help_en - ghzserg/zmod GitHub Wiki
How to Contact Developer Support
Open the Telegram bot @zmod_help_bot and ask it your question. It knows all the documentation.
- Update zMod and all plugins to the latest version
- Clearly describe the issue: provide screenshots, photos, and a detailed textual explanation.
- Run CLEAR_EMMC to clear previous logs.
- Power off the printer completely.
- Power the printer back on.
- Reproduce the issue.
- Run TAR_CONFIG to collect log files.
- Submit one post with your description and the generated
config.tar.gzfile. - Open the issue here.
Why I Ask You to Create Tickets — Explained Simply
Imagine your printer is a car.
And I’m a mechanic in a huge garage, repairing hundreds of different vehicles every day.
You pull in and shout:
“My car won’t drive!”
And I have to start with the most basic question:
“Okay — what make, model, and year is your car?”
Why This Matters — A Breakdown
Our “fleet” includes over 100 unique configurations. Just by major categories:
-
3 different printer models:
FF5M, FF5M Pro, AD5X
-
3 Klipper “engine” versions:
11, 12, 13
-
2 CPU architectures:
ARM and MIPS
-
Display options (“interior trim”):
-
Stock screen
-
GuppyScreen
-
Headless (no screen)
-
-
Primary UIs:
Fluidd and Mainsail
-
Print initiation methods:
Via stock screen, Guppy, OrcaSlicer (using FF protocol, Klipper protocol, etc.)
-
Optional “features” (plugins):
nopoop,recommend,bambufy,g28_tenz,timelapse,notifyand others -
Sensors and peripherals:
filament presence, filament motion, IFS, etc.
On top of that, some users modify hardware themselves, install outdated firmware, or follow advice from forums or AI models that have never seen their specific printer.
The Result
When you write just “doesn’t work”, I waste hours just trying to identify:
-
Which model you have
-
Which Klipper/firmware version
-
Whether you’re using a screen (and which one)
-
Which slicer, settings, and plugins are active
That’s inefficient, delays help, and frustrates everyone.
✅ How to “Bring Your Car to the Shop” — Ticket Checklist
To help me skip the guessing and start fixing, please follow this checklist:
1. Update to the latest version
Follow the official update guide.
2. Describe the issue clearly and concretely
❌ Bad: “It doesn’t work.”
✅ Good:
_“After updating zMod to v.X.Y.Z, when starting a print from the stock screen:
— the bed heats up,
— the extruder does NOT heat (screen shows 0°C),
— print aborts after ~2 minutes.”_
🔹 Attach screenshots, photos,
🔹 Describe exact steps leading to the issue,
🔹 Attach the G-code file (the problem may be in the file itself!).
3. Run full diagnostics
Do these steps in strict order:
CLEAR_EMMC— clear old logs
- Unplug the printer from mains → Wait 10 seconds
- Power it back on
- Reproduce the issue (start print, press button — trigger the error)
- Run
TAR_CONFIG— generatesconfig.tar.gzcontaining all logs
4. Submit the ticket correctly
- Go to Issues page
- Create one new issue
- Include:
- Your clear description (step 2 above)
- Attach
config.tar.gz
- Attach the G-code file, if applicable
⚠️ Without
config.tar.gz, diagnosis is impossible — it’s like submitting a blood test… without the blood.
What This Achieves
You stop shouting:
“My car won’t drive!”
And instead deliver:
🚗 Your exact vehicle,
📋 Full service history,
📊 Diagnostic reports.
Then I can start fixing — immediately, not speculating.
Thank you for your understanding and respect for others’ time.
This is not bureaucracy — it’s the only way to make support fast and effective.