How to open a part in KOMPAS-3D

The “KOMPAS script” is a macro that builds the part right inside KOMPAS, with a feature tree and variables. You can change dimensions through the variables in KOMPAS and the part rebuilds.

Tested on KOMPAS-3D v25 Home

What you need

KOMPAS-3DHome or full edition. Tested on v25 Home; other versions should work, but we don’t guarantee it.
KOMPAS-MacroShips with KOMPAS. No separate install; sometimes it only needs to be enabled.
Script file .m3mThe “KOMPAS script” button on a part page. One file per part with the chosen dimensions.

Four steps

1Download the “KOMPAS script”

On the part page set the dimensions, wait for the build and press the blue “KOMPAS script” button. You get a file like flange_kompas.m3m.

Put it in a separate folder: the part files will appear next to it.

2Open KOMPAS-Macro

Start KOMPAS-3D. No need to open or create a document. In the menu choose Applications → KOMPAS-Macro.

No such item? Enable it: Applications → Configurator, tick “KOMPAS-Macro”.

3Add the script and press “Run”

The “Macro” window opens with a list of macros.

  1. Press “Add” and pick the downloaded .m3m.
  2. The script appears in the list. Select it.
  3. Press “Run”.

You add a script once: next time it is already in the list. The build takes a few seconds.

✓The part is ready

KOMPAS opens the built part. It is also saved next to the script together with two service files.

The log and the report help if something went wrong: you can send them to us.

D:\Parts\
  • flange_kompas.m3mscript
  • flange.m3dpart
  • flange.kompas_log.txtlog
  • flange.kompas_report.jsonreport
The main difference from STEP

Change dimensions right in KOMPAS

Open the Variables panel (the fx icon on the vertical bar on the left). The names are the same as on the site: DO, P1, N1. Change the number in the “Expression” column and press Enter: the part rebuilds.

Calculated variables update by themselves. The site’s checks don’t run in KOMPAS, so keep the dimensions valid yourself.

If something goes wrong

There is no KOMPAS-Macro in the Applications menu
Open Applications → Configurator, find KOMPAS-Macro and tick “Load”. If it isn’t listed, add the component with the KOMPAS installer.
The script ran, but there is no part file next to it
Open the log .kompas_log.txt and find the line Папка результатов: … (results folder). If the script folder is write-protected (e.g. “Program Files”), the files go elsewhere.
The log ends with an error
Send us .kompas_log.txt and .kompas_report.json and tell us your KOMPAS version. Meanwhile you can take the STEP: it is built independently of KOMPAS.
I have a different KOMPAS version
Give it a try: the script uses the basic API, which changes little between versions. Tell us how it went and we’ll add the version to the tested list.

What’s inside the script

Plain Python text: the build plan (variables and operations) and a small player that passes them to KOMPAS. It downloads nothing and doesn’t touch other files.

Open it in any text editor to check it before running.

# Matilda 3D · flange
PLAN = {
  "vars": [
    ["DO", 140, "outer diameter"],
    ["P1", 90, "hole circle"],
    …
  ],
  "ops": [ … ]
}
play(PLAN)