Komponentenstruktur

Eine Komponente ist im Kern ein JSON-Objekt, das die üblichen Funktionsexporte enthält, die ein Plugin haben würde, wie Name, Größe, LED-Anzahl usw.

Verzeichnisse

Diese Dateien werden aus einem von zwei Verzeichnissen geladen. Integrierte Dateien sind gespeichert in:

C:\Users\[YOUR USERNAME]\AppData\Local\VortxEngine\app-[CURRENT VERSION]\Signal-x64\Components

Und benutzerdefinierte Dateien sollten im Benutzerverzeichnis gespeichert werden. Standardmäßig befindet sich dieses in den Dokumenten:

C:\Users\[YOUR USERNAME]\Documents\WhirlwindFX\Components

Dateien, die in AppData gespeichert sind, werden bei jedem Update überschrieben, während Dateien im Dokumentenverzeichnis des Benutzers zwischen den Versionen erhalten bleiben. Dort gespeicherte Dateien überschreiben außerdem alle Dateien im AppData-Verzeichnis mit einem übereinstimmenden Produktnamen. Diese benutzerdefinierten Komponenten erscheinen genauso wie eine integrierte Komponente, mit automatisch generierten Marken- und Typfiltern.

JSON-Struktur

Nachfolgend ist ein Beispiel für ein „Vertagear”-Stuhl-Upgrade-Kit angegeben, das als Komponente mit allen erforderlichen Attributen ausgedrückt wird.

Hinweis: Häufige Fehler und Warnungen beim Laden dieser Dateien werden in den Debug-Logs ausgegeben.

{
    "ProductName": "VertaGear PL4500 RGB Top Kit (Chair Back)",
    "DisplayName": "VertaGear PL4500 RGB Top Kit (Chair Back) - 5 Zone",
    "Brand" : "Vertagear",
    "Type" : "Chair",
    "LedCount" : 5,
    "Width": 5,
    "Height": 5,
    "LedMapping" : [
        0,1,2,3,4
        ],
    "LedCoordinates" : [
        [0,0], [0,1], [1,0], [2,0], [2,1]
    ],
    "LedNames" : [
        "Back Side - Top","Back Side - Bottom","Center Acrylic","Front Side - Top", "Front Side - Bottom"
    ],
    "ImageUrl": ""
}

Parameter	Beschreibung	Typ	Beispiel
ProductName	Der ProductName, der zur Persistenz als Name der Komponente verwendet wird	String	Corsair LL Fan
Brand	String, der die Marke der Komponente zur Filterung repräsentiert	String	Corsair
Type	String, der den Typ der Komponente zur Filterung repräsentiert	String	Fan
LedCount	Ganzzahl, die die Gesamtzahl der LEDs der Komponente repräsentiert	Int	16
Width	Ganzzahl, die die Breite des Pixel-Puffers der Komponente repräsentiert	Int	5
Height	Ganzzahl, die die Höhe des Pixel-Puffers der Komponente repräsentiert	Int	5
LedMapping	Array, das die Reihenfolge enthält, in der LED-Farbinformationen zurückgegeben werden sollen	1D Array	[0,1,2]
LedCoordinates	Array, das die [X,Y]-Position aller LEDs enthält	2D Array	[[0,0],[0,1]]
LedNames	Array, das den Namen jeder LED enthält	1D Array	[“Led 1”,“Led 2”]
ImageUrl	URL-Bildstring, der als Vorschaubild der Komponente verwendet wird	String