Modul Entwicklung

Neues Modul erstellen

Module ermöglichen es Ihnen, modularisierte Assets, Dateien und Code hinzuzufügen und sie in Ihre Projekte zu importieren mit einem Versionierungssystem. Auf diese Weise können Sie Ihren Projektcode auf die wichtigsten Unterscheidungsmerkmale konzentrieren und über ein von Ihnen erstelltes Modul problemlos gemeinsame Funktionen importieren.

So erstellen Sie ein neues Modul in Ihrem Arbeitsbereich:

1. Klicken Sie in Ihrem Workspace Dashboard auf die Registerkarte "Module":

2. Klicken Sie auf der Registerkarte "Module" im Workspace Dashboard auf "Neues Modul erstellen"

Sie können ein neues Modul auch direkt im Kontext eines Projekts erstellen. Klicken Sie in Ihrem Cloud Editor Projekt auf die Schaltfläche "+" neben Module. Klicken Sie dann auf "Neue Module erstellen" und fahren Sie mit den Anweisungen unter fort.

3. Geben Sie grundlegende Informationen für das Modul ein: Geben Sie eine Modul-ID ein (diese ID erscheint in Ihrem Arbeitsbereich url und kann verwendet werden, um Ihr Modul im Projektcode zu referenzieren), und einen Modultitel. Der Modultitel kann später auf der Seite Moduleinstellungen bearbeitet werden.

4. Sobald Sie Ihr Modul erstellt haben, werden Sie im Cloud Editor zur Datei module.js weitergeleitet. Von hier aus können Sie mit der Entwicklung Ihrer Module beginnen. Weitere Einzelheiten zur Modulentwicklung finden Sie unter im Abschnitt Entwicklung Ihres Moduls.

Modulentwicklung

Die Entwicklung von Modulen unterscheidet sich etwas von der Projektentwicklung. Module können nicht eigenständig ausgeführt werden und können nur ausgeführt werden, nachdem sie in ein Projekt importiert wurden. Module können in einer modulspezifischen Ansicht des Cloud Editors oder im Kontext eines Projekts entwickelt werden. Module sind nur für den Arbeitsbereich verfügbar, in dem sie entwickelt wurden.

Wenn Sie ein Modul in der modulspezifischen Ansicht entwickeln, sehen Sie keine Schaltfläche "Vorschau" in der oberen Navigation von im Cloud Editor, da Module nur in der Vorschau angezeigt werden können, wenn sie in ein Projekt importiert werden.

Zu den Hauptkomponenten eines Moduls gehören:

manifest.json

In manifest.json können Sie Parameter erstellen, die über einen visuellen Konfigurator bearbeitet werden können, wenn Module in Projekte importiert werden. Ihr module.js Code kann die Parameter abonnieren, die Sie im Modulmanifest zur Verfügung stellen, um sie dynamisch auf der Grundlage von Benutzereingaben zu ändern, wenn Sie das Modul im Kontext eines Projekts konfigurieren.

Das Modul Config Builder startet automatisch mit einer verfügbaren Parametergruppe. Parametergruppen können für logische Unterteilungen von Parametern verwendet werden, die dann visuell ausgedrückt und gruppiert werden, wenn Ihr Modul in einem Projekt verwendet.

1. Benennen Sie eine Konfigurationsgruppe um, indem Sie auf den Titel der Gruppe doppelklicken.
2. Fügen Sie eine neue Konfigurationsgruppe hinzu, indem Sie auf die Schaltfläche "Neue Konfigurationsgruppe" klicken.
3. Fügen Sie einen Parameter zu einer Konfigurationsgruppe hinzu, indem Sie auf "+ Neuer Parameter" drücken.

4. Wenn Sie einen neuen Parameter erstellen, müssen Sie ihm einen Namen geben. Dieser Name kann im Modul- und Projektcode verwendet werden und sollte daher keine Leerzeichen oder Sonderzeichen enthalten.
5. Wählen Sie den Parametertyp. Derzeit unterstützte Parametertypen sind String, Nummer, Boolean, & Ressource.
6. Sobald Sie Ihre Auswahl getroffen haben, drücken Sie auf "Weiter".

HINWEIS: Die Reihenfolge der Konfigurationsgruppen und der Parameter innerhalb dieser Gruppen bestimmt die Reihenfolge, in der dem Benutzer angezeigt wird, wenn er ein Modul innerhalb eines Projekts verwendet. Sie können die Parameter innerhalb einer Gruppe ganz einfach neu anordnen und auch Konfigurationsgruppen neu anordnen, indem Sie sie in die von Ihnen gewünschte Reihenfolge ziehen. Zur Verschiebung eines Parameter von einer Gruppe in eine andere Gruppe drücken Sie das Pfeilsymbol auf dem Parameterfeld und wählen die Gruppe, in die Sie den Parameter verschieben möchten, aus dem Dropdown-Menü.

Modulparameter Typen & Optionen

Wenn Sie ein Modulmanifest für Ihr Modul erstellen, können Sie aus verschiedenen Parametertypen wählen, darunter String, Number, Boolean, & Resource. Details zu jedem Parameter typ:

String

String-Parameter haben die folgenden editierbaren Felder:

Parameterfelder	Typ	Beschreibung
Etikett (1)	String	Ein von Menschen lesbarer Name für Ihren Parameter, der in der Konfigurationsoberfläche angezeigt wird, wenn das Modul in ein Projekt importiert wird. Der Standardwert wird dynamisch auf der Grundlage des Parameternamens erzeugt.
Standard [Optional] (2)	String	Der Standard-Stringwert, wenn beim Import des Moduls in ein Projekt keiner angegeben wird. Die Standardeinstellung ist "".

Nummer

Zahlenparameter haben die folgenden bearbeitbaren Felder:

Parameterfelder	Typ	Beschreibung
Etikett (1)	String	Ein von Menschen lesbarer Name für Ihren Parameter, der in der Konfigurationsoberfläche angezeigt wird, wenn das Modul in ein Projekt importiert wird. Der Standardwert wird dynamisch auf der Grundlage des Parameternamens erzeugt.
Standard [Optional] (2)	Nummer	Der Standardwert für die Nummer, wenn beim Import des Moduls in ein Projekt kein Wert angegeben wurde. Die Voreinstellung ist null.
Min [Fakultativ] (3)	Nummer	Der maximale Zahlenwert, den ein Benutzer eingeben kann, wenn das Modul in ein Projekt importiert wird. Die Voreinstellung ist null.
Max [Fakultativ] (4)	Nummer	Der minimale Zahlenwert, den ein Benutzer eingeben kann, wenn das Modul in ein Projekt importiert wird. Die Voreinstellung ist null.

Boolesche

Boolesche Parameter haben die folgenden editierbaren Felder:

Parameterfelder	Typ	Beschreibung
Etikett (1)	String	Ein von Menschen lesbarer Name für Ihren Parameter, der in der Konfigurationsoberfläche angezeigt wird, wenn das Modul in ein Projekt importiert wird. Der Standardwert wird dynamisch auf der Grundlage des Parameternamens erzeugt.
Standard [Optional] (2)	Boolesche	Der boolesche Standardwert, wenn beim Import des Moduls in ein Projekt kein Wert angegeben wird. Die Voreinstellung ist Falsch.
Etikett, wenn wahr [Optional] (3)	String	Die Bezeichnung für die boolesche Option Wahr, die in der Konfigurationsoberfläche angezeigt wird, wenn das Modul in ein Projekt importiert wird. Die Standardeinstellung ist Wahr.
Etikett bei Falsch [Optional] (4)	String	Die Bezeichnung für die boolesche Option Falsch, die in der Konfigurationsoberfläche angezeigt wird, wenn das Modul in ein Projekt importiert wird. Die Voreinstellung ist Falsch.

Ressource

Ressourcenparameter haben die folgenden bearbeitbaren Felder:

Parameterfelder	Typ	Beschreibung
Etikett (1)	String	Ein von Menschen lesbarer Name für Ihren Parameter, der in der Konfigurationsoberfläche angezeigt wird, wenn das Modul in ein Projekt importiert wird. Der Standardwert wird dynamisch auf der Grundlage des Parameternamens erzeugt.
Keine erlauben (2)	Boolesche	Aktiviert/deaktiviert die Möglichkeit, die Ressource über die Konfigurationsoberfläche explizit auf Null zu setzen, wenn das Modul in das Projekt importiert wird. Die Voreinstellung ist Falsch.
Erlaubte Asset-Erweiterungen [Optional] (3)	Dateitypen	Ermöglicht das Hochladen bestimmter Dateitypen über die in der Konfigurationsoberfläche angezeigte Option, wenn das Modul in ein Projekt importiert wird. Die Standardeinstellung ist alle Dateitypen.
Standard-Ressource [Optional] (4)	Datei	Die Standardressource, wenn beim Import des Moduls in ein Projekt keine angegeben wurde. Die Voreinstellung ist null.

modul.js

module.js ist der Haupteinstiegspunkt für Ihr 8th Wall-Modul. Der Code in module.js wird ausgeführt, bevor das Projekt geladen wird. Sie können auch andere Dateien und Assets hinzufügen und diese innerhalb von module.js referenzieren.

Module können sehr unterschiedlich sein, je nach ihrem Zweck und Ihrem Entwicklungsstil. Typischerweise enthalten Module einige der folgenden Elemente:

Abonnement für Modulkonfigurationswerte

import {subscribe} von 'config' // Mit config greifen Sie auf Ihre Moduloptionen zu

subscribe((config) => {
  // Ihr Code macht hier etwas mit der config
})

Exportieren von Eigenschaften, die im Projektcode referenziert werden

export {
  // Eigenschaften hier exportieren
}

README.md

Sie können eine Readme-Datei in Ihr Modul einfügen, indem Sie einfach eine Datei namens README.md im Dateiverzeichnis Ihres Moduls erstellen. Genau wie die Readme-Module für Projekte können Readmes mit Markdown formatiert werden und Assets wie Bilder und Videos enthalten.

HINWEIS: Wenn Ihr Modul eine Readme-Datei enthält, wird diese automatisch mit dem Modul verpackt, wenn Sie eine Version bereitstellen. Die entsprechende Modul-Lektüre wird im Kontext des Moduls angezeigt, abhängig von der Version des Moduls, das im Projekt verwendet wird.

Entwicklung eines Moduls im Rahmen eines Projekts

Sie können den Entwicklungsmodus im Kontext eines Projekts für Module, die Ihrem Arbeitsbereich gehören, aktivieren, indem Sie auf der Modulkonfigurationsseite die Option "Entwicklungsmodus" (in der Abbildung unten rot dargestellt) aktivieren. Sobald der Entwicklungsmodus aktiviert ist, werden der zugrunde liegende Code und die Dateien des Moduls im linken Seitenbereich von sichtbar.

Wenn sich ein Modul im Kontext eines Projekts im Entwicklungsmodus befindet, sehen Sie auf der Konfigurationsseite zusätzliche Optionen, darunter: Modul-Client-Steuerelemente (in blaugrün), eine Schaltfläche für die Modulbereitstellung (in Pink) und einen Umschalter "Bearbeitungsmodus", mit dem Sie zwischen der Bearbeitung des Inhalts der Konfigurationsseite von visuell und der Verwendung der Konfiguration wechseln können.

Wenn Sie Module im Rahmen eines Projekts entwickeln und Änderungen an Grundstücken vornehmen, sehen Sie unter einen Grundstücksfluss, der Sie durch Projekt- und Moduländerungen führt. Sie können wählen, ob Sie landesspezifische Änderungen vornehmen möchten oder nicht. Für jedes Projekt oder Modul mit Änderungen, die Sie landen wollen, muss eine Commit-Nachricht hinzugefügt werden, bevor Sie Ihren Code vollständig landen können.

Wenn Sie Module im Rahmen eines Projekts entwickeln und Änderungen vornehmen, werden Sie auch die Aktualisierung der Optionen Abbrechen & Änderungen rückgängig machen im Cloud Editor bemerken. Sie können wählen, ob Sie nur Änderungen am Projekt oder sowohl an Ihrem Projekt als auch an den in Entwicklung befindlichen Modulen abbrechen/zurücknehmen möchten.

Modul bereitstellen

Erste Modulbereitstellung

Durch die Bereitstellung von Modulen können Sie stabile Versionen gemeinsam nutzen und gleichzeitig Projekten die Möglichkeit geben, Modulaktualisierungen innerhalb einer Versionsfamilie zu abonnieren. Auf diese Weise können Sie nicht-unterbrechende Modulaktualisierungen automatisch an Ihre Projekte weiterleiten.

So setzen Sie ein Modul zum ersten Mal ein

1. Wenn Sie von der modulspezifischen Ansicht des Cloud Editors aus entwickeln, klicken Sie auf die Schaltfläche "Bereitstellen" in der oberen rechten Ecke. Wenn Sie ein Modul im Rahmen eines Projekts entwickeln, klicken Sie auf die Schaltfläche "Bereitstellen" in der oberen rechten Ecke der Modulkonfigurationsseite.

2. Bestätigen Sie Ihren Modultitel.
3. Wählen Sie den gewünschten Commit für Ihre Modulversion.
4. Schreiben Sie eine Beschreibung der anfänglichen Modulfunktionalität in den Abschnitt Versionshinweise. Dieser Abschnitt akzeptiert die Markdown-Formatierung.
5. Klicken Sie auf "Weiter".

6. Optional können Sie eine Modulbeschreibung und/oder ein Titelbild hinzufügen. Die Modulbeschreibung und das Titelbild werden im Modulimportfluss angezeigt, wenn Sie ein Modul in ein Projekt bringen. Das Hinzufügen einer Beschreibung und eines Titelbildes kann helfen, das Modul zu differenzieren und anderen Mitgliedern Ihres Arbeitsbereichs einen Kontext über die Verwendung des Moduls zu geben.
7. Klicken Sie auf "Bereitstellen".

Bereitstellung von Modul-Updates

Die Bereitstellung von Modul-Updates erfolgt ähnlich wie die erstmalige Bereitstellung eines Moduls mit zwei zusätzlichen Bereitstellungsoptionen.

1. Versionstyp: Wenn Sie ein Modul-Update bereitstellen, werden Sie aufgefordert, auszuwählen, ob es sich um eine Fehlerbehebung, eine neue Funktion oder eine Hauptversion handelt.
   • Fehlerbehebung: Sollte für überarbeiteten Code und Korrekturen bestehender Probleme ausgewählt werden. Projekte mit Modulen, die auf Fehlerbehebungen oder New Features abonniert sind, erhalten automatisch ein Update, wenn eine neue Fehlerbehebung-Modulversion verfügbar ist.
   • Neue Funktionen: Sollte ausgewählt werden, wenn Sie Ihrem Modul zusätzliche, nicht unterbrechende Funktionen hinzugefügt haben. Projekte mit Modulen, die New Features abonniert haben, erhalten automatisch ein Update, wenn eine neue Version des Moduls "Neue Funktionen"verfügbar ist.
   • Major Release: Sollte für bahnbrechende Änderungen ausgewählt werden. Projekte mit Modulen erhalten keine automatischen Updates für Major Releases.
2. Als Vorabversion festlegen: Nachdem Sie einen Versionstyp ausgewählt haben, können Sie die Version als Vorabversion kennzeichnen. Dies fügt einen Vorabversions-Badge hinzu, um andere Benutzer darüber zu informieren, dass es sich bei der Modulversion um eine Vorabversion handelt. Wenn der Versionstyp Fehlerbehebungen oder neue Funktionen ist, erhalten Projekte auch keine automatische Aktualisierung , solange eine Version als Vorabversion gekennzeichnet ist. Um eine Vorabversion innerhalb eines Moduls zu verwenden, das manuell in Ihr Projekt importiert wurde, wählen Sie die Vorabversion aus dem Ziel der Versionsanbindung aus.

Modul-Vorabversion bearbeiten

Wenn eine Vorabversion aktiv ist, können Sie sie so lange aktualisieren, bis Sie entweder die Vorabversion herausgeben oder sie aufgeben.

So bearbeiten Sie ein Modul der Vorabversion:

1. Wenn Sie in der modulspezifischen Ansicht des Cloud Editors entwickeln, nachdem Sie zuvor eine neue Version als Vorabversion eingestellt haben, klicken Sie auf die Schaltfläche "Bereitstellen" in der oberen rechten Ecke. Wenn Sie ein Modul im Kontext eines Projekts entwickeln, nachdem Sie zuvor eine neue Version als Vorabversion eingestellt haben, klicken Sie auf die Schaltfläche "Bereitstellen" in der oberen rechten Ecke der Modulkonfigurationsseite.

2. Wählen Sie einen neuen Commit für Ihre Vorabversion oder behalten Sie den aktuellen Commit bei.
3. Ändern Sie die Beschreibung der Funktionalität der Modulversion im Abschnitt Versionshinweise. Dieser Abschnitt akzeptiert die Markdown-Formatierung.
4. Aktivieren Sie das Kontrollkästchen "Zur Veröffentlichung befördern", wenn Sie Ihre Vorabversion in eine Standardversion umwandeln möchten.
5. Drücken Sie auf "Vorabfreigabe aufheben", um die Vorabfreigabe zu löschen. Dies wird normalerweise verwendet, um einen anderen Versionstyp auszuwählen als den, auf den die Vorabversion derzeit eingestellt ist (z.B. Wechsel von Fehlerkorrekturen zu einer Hauptversion mit grundlegenden Änderungen). Projekte mit Modulen, die derzeit an die Vorabversion angeheftet sind, werden weiterhin mit der Vorabversion ausgeführt, bis sie ein abonniertes Update erhalten oder manuell geändert werden.
6. Die Schaltfläche "Bereitstellen" macht Ihre bearbeiteten Vorabversionen verfügbar (entweder als Aktualisierung der Vorabversion oder als Freigabe, wenn das Kontrollkästchen aktiviert ist):