Skip to content

Manual de Plugins para Herramientas de Diseño ​

El ecosistema OIM cuenta con plugins nativos para las herramientas de diseño vectorial estándar del sector, permitiendo a los equipos creativos diseñar en su software preferido y exportar directamente a contenedores .oim listos para producción.

Disponibilidad

El plugin de Penpot ya está disponible mediante su URL de manifiesto alojada (https://plugins.oim.media/penpot/manifest.json). Los plugins de Figma y Framer siguen en desarrollo; su comportamiento, campos y ejemplos describen el diseño previsto y pueden cambiar antes de publicarse.


1. Arquitectura Oficial del Plugin para Figma ​

El plugin para Figma (packages/plugin-figma) opera bajo la arquitectura de doble proceso de Figma:

  • Hilo Sandbox (code.ts):
    • Recorre el árbol de nodos del Frame seleccionado en Figma.
    • Identifica roles de capa automáticamente según convenciones de nombres:
      • [slot] o [oim]: Convertidas en capas vivas (el nombre de la etiqueta viene de 1.x).
      • [text]: Marcadas como texto localizado traducible.
      • [lottie]: Convertidas en capas de micro-animación Lottie.
      • Capas bloqueadas (node.locked === true): Fijadas en la imagen base (los píxeles del PNG).
  • Iframe de Interfaz (ui.html / ui.ts):
    • Muestra la previsualización interactiva en directo.
    • Expone campos para traducciones multilingües (en, es) y asignación de colores semánticos.
    • Solicita un renderizado PNG limpio de la imagen base y orquesta el empaquetado.

2. Flujo de Trabajo: De Figma a OIM ​

Exportar desde Figma requiere tres pasos sencillos:

  1. Preparación de la Jerarquía de Capas:
    • Organiza tus elementos vectoriales en un Frame raíz (ej. 1080x1080 o 1920x1080).
    • Prefija los textos o botones interactivos con [slot] Titular.
  2. Configuración de Propiedades de las Capas:
    • Abre el plugin de OIM desde el menú Plugins de Figma.
    • Introduce los textos traducidos para cada idioma soportado.
    • Asigna tokens semánticos (primary, surface, accent) de la paleta Dynamic Colors.
  3. Exportación y Empaquetado:
    • Haz clic en Package .oim.
    • El plugin construye el documento 2.0 en local con @oim-media/core, empaqueta la imagen base con metadata firmada vía /v1/oim/package y entrega el binario .oim.png.
json
{
  "figma_node_id": "12:456",
  "detected_type": "text",
  "name": "[slot] Summer Sale",
  "bounds": { "x": 120, "y": 340, "width": 480, "height": 80 },
  "content": {
    "en": "Summer Collection 2026",
    "es": "Colección de Verano 2026"
  }
}

3. Integración Oficial con el Plugin de Penpot ​

El plugin de Penpot (packages/plugins/penpot) lleva la autoría de OIM a la comunidad de código abierto y ya se puede instalar directamente mediante su URL de manifiesto:

Instalación en Penpot ​

  1. Abre Penpot y entra en Plugins → Instalar con URL (Ctrl+Alt+P / gestor de plugins).
  2. Pega la URL oficial del manifiesto:
    text
    https://plugins.oim.media/penpot/manifest.json
  3. Selecciona un tablero y abre OIM para traducir capas de texto, vincular tipografías web y exportar un .oim.png firmado.

Integración Técnica ​

  • Diseño Nativo Web: Se integra a través de la API de Extensiones de Penpot (plugin.js).
  • Persistencia en el Tablero: Serializa atributos personalizados en los metadatos del tablero mediante board.setPluginData("oim-config", ...).
  • Sincronización Automática de Fuentes: Vincula tipografías cargadas en Penpot con identificadores compatibles con <oim-player>.

4. Capas fijas y vivas en los plugins ​

Ambos plugins reparten el diseño entre la imagen base y las capas vivas:

  • Capas fijas: Cualquier capa sin prefijo interactivo o fijada como estática se acopla en la imagen base.
  • Vectores y Siluetas: Los trazados SVG marcados con [slot] se conservan como definiciones vectoriales y se pintan en el Shadow DOM del reproductor.
  • Recortes y Márgenes: Los marcos anidados con máscara se trasladan a definiciones SVG <clipPath>; cada máscara se hornea en la imagen base o queda viva.

5. Garantías de Seguridad y Verificación ​

Los plugins se comunican exclusivamente con los endpoints públicos autorizados:

  • Cero Exposición de Secretos: Los plugins solo requieren la clave API pública de desarrollador y operan solo con /v1/oim/package.
  • Validación Previa: Antes de enviar los datos, comprueban que el número de capas no supere 150 y que las cadenas de texto estén libres de scripts maliciosos.