Plugin_en - ghzserg/zmod GitHub Wiki

Plugins in zMod

This documentation is outdated. The latest version is available here

Any user can create and connect their own plugin to zmod.

Plugins included with zMod:

  1. Recommend - Settings recommended for immediate use after installing the mod.
  2. G28_tenz – Z-axis parking using load cells
  3. Nopoop - Maximum waste reduction by ninjamida
  4. TimeLapse - Moonraker Timelapse
  5. Notify - Receive notifications in Telegram and over 100 other different services

External plugins not developed by the zMod author.

  1. Bambufy - Compatible with Bambu Studio, improves feed tower control, provides accurate time and material consumption estimates, reduces waste, supports Mainsail, quick color changes, and advanced printing features. CANNOT BE USED WITH THE NATIVE SCREEN.
  2. lessWaste - a fork of BamBufy

To enable the repository of external plugins not developed by the zMod author, run the command ENABLE_EXTRA_PLUGINS.

Plugin Management

This documentation is outdated. The latest version is available here

Enable plugin:

ENABLE_PLUGIN name=g28_tenz

— downloads the plugin and restarts Klipper on success.

Disable plugin:

DISABLE_PLUGIN name=g28_tenz

Installing Classic Klipper Plugins with Python Modules

This documentation is outdated. The latest version is available here

For classic Klipper plugins that work with Python modules (e.g., klipper-led_effect), a special installation process is required that involves creating a symbolic link to the Klipper module.

Example: Installing led_effect

This documentation is outdated. The latest version is available here

led_effect is a plugin for controlling WS2812 RGB LED strips through Klipper.

Step 1: Clone the repository

Run these commands in the chroot environment:

# For AD5M:

This documentation is outdated. [The latest version is available here](https://wiki.zmod.link/Plugin/#for-ad5m)
chroot /data/.mod/.zmod/
# For AD5X:

This documentation is outdated. [The latest version is available here](https://wiki.zmod.link/Plugin/#for-ad5x)
chroot /usr/data/.mod/.zmod/

# Same for all models:

This documentation is outdated. [The latest version is available here](https://wiki.zmod.link/Plugin/#same-for-all-models)
cd /opt/config/mod_data/plugins/
git clone https://github.com/julianschill/klipper-led_effect.git

Step 2: Add an entry to the Moonraker config

In the file mod_data/user.moonraker.conf, add the following section:

[update_manager led_effect]
type: git_repo
channel: stable
path: /opt/config/mod_data/plugins/klipper-led_effect
origin: https://github.com/julianschill/klipper-led_effect.git
is_system_service: False
primary_branch: master

Step 3: Create a symbolic link to the Klipper module

Create a symbolic link to connect the module to Klipper:

ln -s /opt/config/mod_data/plugins/klipper-led_effect/src/led_effect.py /usr/prog/klipper/klippy/extras/led_effect.py

Replace:

  • klipper-led_effect with your plugin's folder name
  • led_effect.py with the module name (may differ depending on the plugin)

Step 4: Restart Klipper

After creating the symbolic link, you need to restart Klipper using the restart button in the Fluidd/Mainsail web interface.

Important Notes

This documentation is outdated. The latest version is available here

The module must be compatible with your Klipper version Ensure that the plugin version is compatible with your installed Klipper version.

Creating Your Own Plugin

This documentation is outdated. The latest version is available here

Plugin example: https://github.com/ghzserg/g28_tenz (In all examples below, the name g28_tenz is used — replace it with your plugin’s name.)

Adding a Plugin

This documentation is outdated. The latest version is available here

In the file mod_data/user.moonraker.conf add the following section:

[update_manager g28_tenz]
type: git_repo
channel: dev
path: /root/printer_data/config/mod_data/plugins/g28_tenz
origin: https://github.com/ghzserg/g28_tenz.git
is_system_service: False
primary_branch: main
  • Plugin path: /root/printer_data/config/mod_data/plugins/g28_tenz
  • Source: https://github.com/ghzserg/g28_tenz.git

Stable plugins may be included in the zmod distribution, but are updated and maintained by their respective authors.

Installation Script

This documentation is outdated. The latest version is available here

After calling ENABLE_PLUGIN, the file install.sh will be executed automatically. After calling DISABLE_PLUGIN, the file uninstall.sh will be executed automatically.

Single-language Plugin

This documentation is outdated. The latest version is available here Must contain the file:

g28_tenz.cfg

All functionality goes inside this file.

Multi-language Plugin

This documentation is outdated. The latest version is available here Files are placed in language-specific subdirectories:

en/g28_tenz.cfg
ru/g28_tenz.cfg
de/g28_tenz.cfg
...

All output strings must be escaped, for example:

RESPOND PREFIX="info" MSG="===Cutting the filament==="

Translation

This documentation is outdated. The latest version is available here

Translations are stored in the translate/ directory in files like de.csv:

Cutting the filament;Filament schneiden

Format:

English phrase;Translation in target language

To generate language files, run:

./Make.sh

The script will create the required directories and .cfg files.