📘 Tutorial: Erstellen von Addons für FreeCAD. Lektion 1. Vorbereitung der Entwicklungsumgebung

Lernziel: Alles Notwendige einrichten, um Addons mühelos zu erstellen, zu testen und zu debuggen.

🔧 Schritt 1. Stellen Sie sicher, dass FreeCAD installiert ist

Anforderungen:

FreeCAD Version 0.20 oder neuer (besser 1.0+)
Läuft unter Windows, Linux oder macOS

👉 Wenn Sie FreeCAD noch nicht haben, laden Sie es von der offiziellen Website herunter:
🔗 https://www.freecad.org/downloads.php

Wählen Sie:

Windows: .exe (Installer) oder .7z (portable)
Linux: AppImage oder Paket aus dem Repository
macOS: .dmg

💡 Tipp: Zum Lernen ist es besser, eine installierte Version (über den Installer) zu verwenden, da diese stabiler und einfacher einzurichten ist.

📁 Schritt 2. Suchen Sie den Addon-Ordner

FreeCAD sucht benutzerdefinierte Addons in einem speziellen Mod-Ordner.
Der Pfad hängt von Ihrem Betriebssystem und der Installationsart ab.

✅ Wie finde ich den Ordner genau?

Starten Sie FreeCAD.
Öffnen Sie die Python-Konsole:
Ansicht → Panels → Python-Konsole
Geben Sie den Befehl ein:

import FreeCAD
print(FreeCAD.getUserAppDataDir())

Drücken Sie Enter.

Sie sehen einen Pfad, zum Beispiel:

Windows (installierte Version):
C:\Users\IhrName\AppData\Roaming\FreeCAD\
Windows (portable):
D:\FreeCAD\data\
Linux:
/home/ihr_name/.local/share/FreeCAD/
macOS:
/Users\ihr_name/Library/Application Support/FreeCAD/

➕ Erstellen Sie den `Mod`-Ordner

Innerhalb dieses Verzeichnisses muss ein Mod-Ordner vorhanden sein.
Wenn er nicht existiert, erstellen Sie ihn manuell.

Beispiel für Windows:

C:\Users\IhrName\AppData\Roaming\FreeCAD\Mod\

💡 Schnelle Möglichkeit, den Ordner unter Windows zu öffnen:
Drücken Sie Win + R → geben Sie %APPDATA%\FreeCAD ein → Enter

🖥 Schritt 3. Konfigurieren Sie einen Texteditor (optional, aber sehr empfehlenswert)

Obwohl Sie Code im Editor schreiben können, ist es bequemer, einen Editor mit:

Python-Syntaxhervorhebung
Autovervollständigung
Möglichkeit zum Ausführen von Skripten

🔹 Wir empfehlen: Visual Studio Code (VS Code)

Herunterladen und installieren: https://code.visualstudio.com/
Installieren Sie die Python-Erweiterung (von Microsoft)
(Optional) Installieren Sie die Erweiterung FreeCAD for VS Code – sie fügt Hinweise zur FreeCAD-API hinzu

🔹 Wie öffne ich den Addon-Ordner in VS Code?

Starten Sie VS Code
Datei → Ordner öffnen
Wählen Sie den Mod-Ordner (oder ein einzelnes Addon darin)

Jetzt sehen Sie die Projektstruktur und können Dateien bequem bearbeiten.

🛠 Schritt 4. Erkunden Sie die integrierten FreeCAD-Tools

FreeCAD enthält bereits alles, was Sie für die Entwicklung benötigen.

1. Python-Konsole

Menü: Ansicht → Panels → Python-Konsole
Ermöglicht die Ausführung von Befehlen in Echtzeit
Beispiel: Geben Sie App.newDocument() ein → ein neues Dokument wird erstellt

2. Berichtsansicht

Menü: Ansicht → Panels → Berichtsansicht
Zeigt Fehler, Warnungen, Protokolle
Halten Sie sie unbedingt offen, wenn Sie ein Addon testen!

3. Makro-Recorder

Menü: Makro → Makros...
Schaltfläche Aufnehmen – zeichnet Ihre Aktionen als Python-Code auf
Eine hervorragende Möglichkeit, die FreeCAD-API zu lernen

💡 Probieren Sie dies aus:

Klicken Sie auf Makro → Aufnahme starten

Erstellen Sie eine Box (Part → Box)

Aufnahme stoppen

Öffnen Sie das Makro – Sie sehen den tatsächlichen Code zum Erstellen des Objekts!

🧪 Schritt 5. Überprüfung: Erstellen Sie einen Testordner

Um sicherzustellen, dass alles funktioniert:

Erstellen Sie im Mod-Ordner einen Unterordner:

   TestAddon

Erstellen Sie darin eine Datei __init__.py (sie kann leer sein) – dies teilt Python mit, dass der Ordner ein Modul ist.
Starten Sie FreeCAD neu.
Öffnen Sie die Berichtsansicht.

Wenn Sie keine Fehler sehen – bedeutet dies, dass FreeCAD den Mod-Ordner erfolgreich scannt.

❗ Wenn ein Fehler wie ImportError auftritt – überprüfen Sie:

Korrektheit des Ordnernamens (keine Leerzeichen oder kyrillischen Zeichen)

Vorhandensein von __init__.py (in neueren Versionen nicht immer zwingend, aber sicherer hinzuzufügen)

🗂 Struktur des Entwicklerordners (Ergebnis)

Am Ende dieser Lektion sollten Sie diese Struktur haben:

(FreeCAD Benutzerordner)
└── Mod/
    └── TestAddon/
        └── __init__.py   ← kann leer sein

Und Sie wissen:

Wo sich Mod befindet
Wie man die Python-Konsole und die Berichtsansicht öffnet
Wie man den Makro-Recorder verwendet
Wie man VS Code einrichtet (optional)

✅ Praktische Aufgabe

Suchen Sie den Mod-Ordner über FreeCAD.getUserAppDataDir()
Erstellen Sie den Ordner MyFirstAddon im Mod-Ordner
Fügen Sie eine leere Datei __init__.py hinzu
Starten Sie FreeCAD neu
Stellen Sie sicher, dass in der Berichtsansicht keine Fehler auftreten

🎯 Ziel: FreeCAD sollte fehlerfrei starten und Ihren Ordner „sehen“.

▶️ Was kommt als Nächstes?

In Lektion 2 werden wir ein echtes funktionierendes Addon erstellen:

Wir werden eine Schaltfläche hinzufügen
Wir werden sie etwas tun lassen
Wir werden lernen, Befehle und Arbeitsbereiche zu registrieren