Verwendung von Plugins

Plugins aktivieren

Aus diesem Grund ist die Ausführung von Plugins standardmäßig für jedes Projekt deaktiviert. Du kannst Plugins in Ansichten > Plugins aktivieren, indem Du “Plugins für dieses Projekt aktivieren” auswählst.

Aktiviere Plugins nur für Projekte, denen Du vertraust. Wenn Du dein Projekt verschiebst oder umbenennst, musst Du die Plugins erneut aktivieren.

Plugins installieren

Es gibt zwei Möglichkeiten, Plugins zu installieren: Über deine Projektabhängigkeiten oder als Dateien im plugins Ordner. Nach der Installation öffne Ansichten > Plugins, um sie pro Projekt zu aktivieren oder zu deaktivieren.

Über NPM

Du kannst Plugins über den Node Package Manager (NPM) installieren. Installiere ein Plugin mit folgendem Befehl:

1npm i --save-dev @wonderlandengine/not-a-real-plugin

Ersetze @wonderlandengine/not-a-real-plugin durch ein beliebiges Plugin, das Du installieren möchtest. Das Ausführen dieses Befehls erstellt einen neuen Eintrag im devDependencies Abschnitt deiner package.json Datei.

Das Plugin wird dann in der Plugins Ansicht angezeigt.

Plugins verwalten

Manchmal möchtest Du Plugins deaktivieren, um visuelle Unordnung zu reduzieren oder die Leistung des Editors zu verbessern.

Öffne Ansichten > Plugins, um alle verfügbaren Plugins zu sehen und sie zu verwalten:

Aktiviere Plugins für das aktuelle Projekt über das Kontrollkästchen oben “Plugins für dieses Projekt aktivieren”.
Verwende die Tabs, um zwischen “Editor-Bereich” (Plugins, die den Editor selbst erweitern) und “Projekt-Bereich” (Plugins, die durch dein Projekt über devDependencies oder den plugins/ Ordner installiert wurden) zu wechseln.
Schalte einzelne Plugins über die Kontrollkästchen an/aus. Änderungen werden sofort wirksam; einige Plugins können dich bitten, das Projekt neu zu laden.

Entwicklung

Das Erstellen von Plugins ist einfach. Es stehen dir drei Methoden zur Verfügung:

Plugin Script

Ein einzelnes Skript, das Abhängigkeiten mit deinem Hauptprojekt package.json teilen kann. Wir empfehlen, alle plugin-bezogenen Abhängigkeiten als devDependencies zu installieren (mit --save-dev).

Du kannst ein neues Plugin erstellen, indem Du den plugins Ordner im Hauptverzeichnis deines Projekts erstellst und dann rechtsklickst > Neues Plugin.

Stelle sicher, dass das @wonderlandengine/editor-api Paket in deinem Projektverzeichnis installiert ist:

1npm i --save-dev @wonderlandengine/editor-api

Plugin-Verzeichnis

Ähnlich wie bei Plugin Scripts erstelle zuerst einen plugins Unterordner, aber dann erstelle einen weiteren Unterordner, den du nach deinem Plugin benennst.

In diesem Ordner kannst Du eine neue package.json Datei erstellen (z.B. via npm init).

Stelle sicher, dass das @wonderlandengine/editor-api Paket in diesem Verzeichnis installiert ist:

1npm i --save @wonderlandengine/editor-api

Beachte --save anstelle von --save-dev, da Du nicht in dein Wonderland Engine Projekt installierst, sondern in ein separates Plugin-Projekt.

Plugin-Paket

Wenn Du dein Plugin teilen und verteilen möchtest, kannst Du npm init in einem separaten Ordner ausführen und die Plugineintragspunkte im "wonderlandengine" Schlüssel deiner package.json festlegen:

 1{
 2    // ...
 3    "wonderlandengine": {
 4        "plugins": [
 5            {
 6                "name": "Mein Plugin A",
 7                "main": "src/plugin-a.mjs"
 8            },
 9            {
10                "name": "Mein Plugin B",
11                "main": "src/plugin-b.mjs"
12            }
13        ]
14    },
15    // ...
16}

Stelle sicher, dass das @wonderlandengine/editor-api Paket in diesem Verzeichnis installiert ist:

1npm i --save-peer @wonderlandengine/editor-api

Um dieses lokale Plugin in deinem Projekt zu verwenden, npm i --save-dev <pfad-zum-verzeichnis>, oder veröffentliche es bei Fertigstellung und installiere es dann über das Package, siehe Installieren.