Lección 1. Preparación del entorno de desarrollo

📘 Curso de formación: Creación de complementos para FreeCAD

Objetivo de la lección: configurar todo lo necesario para crear, probar y depurar complementos sin esfuerzo adicional.

---

🔧 Paso 1. Asegúrese de tener FreeCAD instalado

Requisitos:

• FreeCAD versión 0.20 o posterior (preferiblemente 1.0+)
• Funciona en Windows, Linux o macOS

👉 Si aún no tiene FreeCAD, descárguelo del sitio web oficial:
🔗 https://www.freecad.org/downloads.php

Elija:

• Windows: .exe (instalador) o .7z (portable)
• Linux: AppImage o paquete del repositorio
• macOS: .dmg

💡 Consejo: para aprender, es mejor usar la versión instalada (a través del instalador), ya que es más estable y fácil de configurar.

---

📁 Paso 2. Encuentre la carpeta de complementos

FreeCAD busca complementos de usuario en una carpeta especial llamada Mod.
La ruta depende de su sistema operativo y tipo de instalación.

✅ ¿Cómo encontrar la carpeta exactamente?

1. Inicie FreeCAD.
2. Abra la Consola de Python:
   Ver → Paneles → Consola de Python
3. Ingrese el comando:

import FreeCAD
print(FreeCAD.getUserAppDataDir())

4. Presione Enter.

Verá una ruta, por ejemplo:

• Windows (versión instalada):
  C:\Users\SuNombreDeUsuario\AppData\Roaming\FreeCAD\
• Windows (portable):
  D:\FreeCAD\data\
• Linux:
  /home/su_nombre_de_usuario/.local/share/FreeCAD/
• macOS:
  /Users/su_nombre_de_usuario/Library/Application Support/FreeCAD/

➕ Cree la carpeta Mod

Dentro de este directorio debe haber una carpeta Mod.
Si no existe, créela manualmente.

Ejemplo para Windows:

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

💡 Una forma rápida de abrir la carpeta en Windows:
Presione Win + R → escriba %APPDATA%\FreeCAD → Enter

---

🖥 Paso 3. Configure un editor de texto (opcional, pero muy recomendado)

Aunque puede escribir código en el Bloc de notas, es más conveniente usar un editor con:

• Resaltado de sintaxis de Python
• Autocompletado
• Capacidad para ejecutar scripts

🔹 Recomendamos: Visual Studio Code (VS Code)

1. Descargue e instale: https://code.visualstudio.com/
2. Instale la extensión Python (de Microsoft)
3. (Opcional) Instale la extensión FreeCAD for VS Code: agrega sugerencias para la API de FreeCAD

🔹 ¿Cómo abrir la carpeta de complementos en VS Code?

1. Inicie VS Code
2. Archivo → Abrir carpeta
3. Seleccione la carpeta Mod (o un complemento individual dentro de ella)

Ahora puede ver la estructura del proyecto y editar archivos cómodamente.

---

🛠 Paso 4. Explore las herramientas integradas de FreeCAD

FreeCAD ya contiene todo lo necesario para el desarrollo.

1. Consola de Python

• Menú: Ver → Paneles → Consola de Python
• Permite ejecutar comandos en tiempo real
• Ejemplo: escriba App.newDocument() → se creará un nuevo documento

2. Vista de informe

• Menú: Ver → Paneles → Vista de informe
• Muestra errores, advertencias, registros
• ¡Manténgala abierta obligatoriamente al probar un complemento!

3. Grabador de macros

• Menú: Macro → Macros...
• Botón Grabar: registra sus acciones en código Python
• Una excelente manera de aprender la API de FreeCAD

💡 Pruebe:

1. Haga clic en Macro → Iniciar grabación
2. Cree una caja (Part → Caja)
3. Detenga la grabación
4. Abra la macro: ¡verá el código real de creación del objeto!

---

🧪 Paso 5. Verificación: cree una carpeta de prueba

Para asegurarse de que todo funciona:

1. En la carpeta Mod, cree una subcarpeta:

   TestAddon

2. Dentro, cree un archivo __init__.py (puede estar vacío); esto le dice a Python que la carpeta es un módulo.
3. Reinicie FreeCAD.
4. Abra la Vista de informe.

Si no ve errores, significa que FreeCAD escanea correctamente la carpeta Mod.

❗ Si aparece un error como ImportError, verifique:

• La corrección del nombre de la carpeta (sin espacios ni caracteres cirílicos)
• La presencia de __init__.py (en las nuevas versiones no siempre es obligatorio, pero es más seguro agregarlo)

---

🗂 Estructura de la carpeta del desarrollador (resultado)

Al final de esta lección, debería tener la siguiente estructura:

(carpeta de usuario de FreeCAD)
└── Mod/
    └── TestAddon/
        └── __init__.py   ← puede estar vacío

Y sabe:

• Dónde se encuentra Mod
• Cómo abrir la Consola de Python y la Vista de informe
• Cómo usar el Grabador de macros
• Cómo configurar VS Code (opcional)

---

✅ Tarea práctica

1. Encuentre la carpeta Mod a través de FreeCAD.getUserAppDataDir()
2. Cree la carpeta MyFirstAddon dentro de Mod
3. Agregue un archivo vacío __init__.py en ella
4. Reinicie FreeCAD
5. Asegúrese de que no haya errores en la Vista de informe

🎯 Objetivo: FreeCAD debe iniciarse sin errores y «ver» su carpeta.

---

▶️ ¿Qué sigue?

En la Lección 2 crearemos un complemento de trabajo real:

• Agregaremos un botón
• Haremos que haga algo
• Aprenderemos a registrar comandos y entornos de trabajo