ATLAS Plugin-Vorlage

Die offizielle ATLAS Plugin-Vorlage auf GitHub ist ein startfertiges Repository für ein einzelnes ATLAS-Plugin. GitHub erstellt daraus mit Use this template ein eigenes Repository.

Plugin-Generator in der Administration

Die ATLAS-Administration bietet einen Plugin-Generator. Neben ID, Name, Beschreibung, Version, Einstiegspfad und Fähigkeiten kannst du zwischen einem MDI-Icon aus dem lokal gebündelten Katalog und einem eigenen PNG-Icon wählen. Suche ein MDI-Icon und wähle es per Klick aus; das SVG und die zugehörigen Lizenzhinweise kommen ins Installationspaket. Eigene PNG-Dateien dürfen höchstens 512 KiB groß sein. Farben und Transparenz bleiben erhalten; die Bilddaten werden in das erzeugte Paket eingebettet. Das gilt für das Plugin-Icon, nicht für beliebige Binärdateien, die das Plugin selbst benötigt. Solche Dateien müssen separat bereitgestellt und per URL referenziert werden. Der Generator erstellt außerdem ein bearbeitbares HTML/CSS/JavaScript-Grundgerüst, eine repository.json-Katalogdatei und eine lokalisierte README.md mit Metadaten, Fähigkeiten, Dateiliste sowie Hinweisen zu Installation, Veröffentlichung und Entwicklung. Die Dokumentation kann zusätzlich einzeln heruntergeladen werden. Prüfe die erzeugten Inhalte und Pfade und ergänze die Dateien in deinem Repository; der Generator legt kein GitHub-Repository an und veröffentlicht nichts automatisch. Manuell importierte Pakete erscheinen im Plugin Hub. Ihre Dateien werden derzeit jedoch nicht als Plugin-Seite bereitgestellt oder ausgeführt; dafür muss das Plugin über ein Repository beziehungsweise einen lokal bereitgestellten Plugin-Ordner verfügbar sein.

Plugins mit eigener Sprachauswahl übernehmen die gespeicherte ATLAS-Sprachwahl beim Öffnen. Ein language-Parameter in der Plugin-URL hat Vorrang. Unterstützt ein Plugin die gewählte Sprache nicht, verwendet es seine konfigurierte Rückfallsprache.

Schnellstart

1. Öffne das Vorlagen-Repository und wähle Use this template → Create a new repository.

2. Klone das neue Repository und bearbeite plugins/atlas-plugin/atlas-plugin.json. Vergib eine eindeutige Plugin-ID und trage Name, Version, Beschreibung sowie nur die tatsächlich benötigten Fähigkeiten ein.

3. Ersetze die Beispielanwendung unter plugins/atlas-plugin/ sowie icon.svg, logo.svg und preview.svg durch deine Plugin-Inhalte.

4. Baue und prüfe das Paket lokal:

   npm run build
   npm run check

5. Passe repository.json und install.html an dein Repository an. Der Paketgenerator übernimmt ID, Name, Version, Beschreibungen und Asset-Pfade aus dem Manifest und hält den Katalog synchron.

6. Aktiviere GitHub Pages für den Branch main. Der Katalog ist dann unter https://raw.githubusercontent.com/<owner>/<repo>/main/repository.json erreichbar.

7. Füge die Katalog-URL in der ATLAS-Administration hinzu und installiere das Plugin zum Testen.

Was enthalten ist

Die Vorlage enthält ein kleines Beispielplugin, Manifest, Repository-Katalog, Installationsseite, Paketgenerator, Validierung und einen GitHub-Actions-Workflow. Der Workflow führt Build und Prüfung bei Pushes und Pull Requests aus.

Erhöhe bei jeder Veröffentlichung die Plugin-Version und führe anschließend npm run build aus. Die Plugin-ID sollte nach der Veröffentlichung stabil bleiben. Prüfe vor dem Veröffentlichen insbesondere Berechtigungen und deklarierte Fähigkeiten.

Aktueller Installationsumfang

Der generische Repository-Installer speichert Paketdateien derzeit lokal. Er führt beliebigen heruntergeladenen Plugin-Code noch nicht automatisch aus. Das Paketformat speichert Plugin-Dateien als Text; größere Binärdateien sollten separat gehostet und per URL referenziert werden.

Weitere Details zum Katalog und Paketformat stehen unter Repository-Format. Die Vorlage: rockbaer2007/atlas-plugin-template.