Skip to content

Configuration Generator

Follow this guide to create a custom configuration for your 3MS.

Base Configuration

First, find the case configuration for your mainboard. The best place to find these is in the official Klipper sample configurations.

In this example, a BTT SKR Mini E3 V3 will be used. A base configuration is available in the official configuration here.

Raw File

Now you have the configuration, but it isn't a raw file. It's a full webpage. To continue, you need the raw configuration. To do this, find the "Raw" button in the upper-right corner of the page.

Now, you will be redirected to a page with the raw configuration. Copy the URL.

Generating the Configuration - Web

Generating the Configuration - Shell

Now that you have the raw URL, you need to install the generator script.

Installation

  1. Clone the 3MS repository:

    cd ~
    git clone https://github.com/3DCoded/3MS
    
  2. Ensure Python 3 is installed (not Python 2).

  3. Install requests

    pip3 install requests
    

Running the Script

First, start the script:

cd ~/3MS
python3 generator.py

Now, you will be presented with several options.

Configuration URL

Paste in the URL you found earlier.

Local file configurations

You can also use a file configuration by passing the --file parameter:

python3 generator.py --file

Selected Steppers

The script will now list all the stepper motor configurations that were found in the configuration, with a number next to each. Enter the desired steppers, seperated by spaces.

TMC Drivers

For each stepper you selected, the script will ask you which TMC driver to use. For the SKR Mini E3 V3, there is only one option: TMC2209.

No TMC Drivers?

If you don't want to use TMC drivers in your configuration, pass the --no-tmc parameter:

python3 generator.py --no-tmc

MCU Name

Finally, the script will ask you for the name of the MCU controlling your 3MS. Follow the naming convention outlined in the prompt.


Your configuration will now be available in ~/3MS/mmu.cfg and ~/3MS/mmu_hardware.cfg.