AFC-Klipper-Add-On Software Installation Guide¶
This Klipper plugin is for use with modern filament control systems such as BoxTurtle, NightOwl etc.
More information about BoxTurtle can be found here
Note
All examples in this section assume that you are running the command on your SBC that the AFC-Klipper-Add-On software
is installed on.
Installation¶
Step 1: Prerequisites¶
The AFC-Klipper-Add-On has the following pre-requisites:
- Klipper 12 or later
- Moonraker
- WebUI (Mainsail or Fluidd)
- Python3 >= 3.8
The following software prerequisites should also be available on your system:
- jq
- crudini
- git
With a Debian based system, you can install these prerequisites with the following command:
Step 2: Software pre-configuration¶
The AFC-Klipper-Add-On software interfaces with Moonraker for many functions. To ensure complete compatibility, you should
ensure that the moonraker.conf file is configured correctly. Please ensure that the following is present in the [authorization]
section of your moonraker.conf file:
Other entries may be present, and should remain, but please ensure that the 127.0.0.1/8 entry is present. This allows the
AFC-Klipper-Add-On software to communicate with Moonraker without requiring additional authentication.
Step 3: Clone the git repository¶
The AFC-Klipper-Add-On software is available on GitHub. You can clone the repository with the following command:
Step 4: Start the installation process¶
From within the AFC-Klipper-Add-On directory, you can start the installation process with the following command:
Running this script will start the installation process and walk you through a guided series of prompts to help you configure the software on your system.
Runtime Options¶
If you need to configure your system for a non-standard installation, various run-time options are available. Further information on these runtime options is available here