Aller au contenu

Structure des composants

Un composant est, à sa base, un objet JSON contenant les exports de fonctions habituels qu’un plugin aurait, comme le nom, la taille, le nombre de LEDs, etc.

Ces fichiers sont récupérés depuis l’un des deux répertoires suivants. Les fichiers intégrés sont stockés dans :

C:\Users\[VOTRE NOM D'UTILISATEUR]\AppData\Local\VortxEngine\app-[VERSION ACTUELLE]\Signal-x64\Components

Et les fichiers créés par l’utilisateur doivent être stockés dans le répertoire utilisateur. Par défaut, il se trouve dans les documents :

C:\Users\[VOTRE NOM D'UTILISATEUR]\Documents\WhirlwindFX\Components

Les fichiers stockés dans AppData sont écrasés à chaque mise à jour, tandis que ceux stockés dans le répertoire Documents de l’utilisateur persisteront entre les versions. Les fichiers qui s’y trouvent remplaceront également tout ce qui se trouve dans le répertoire AppData avec un nom de produit correspondant. Ces composants utilisateur personnalisés apparaîtront comme un composant intégré, avec des filtres de marque et de type générés automatiquement.

Structure JSON

Voici un exemple d’un kit d’amélioration de chaise “Vertagear” exprimé en tant que composant avec tous les attributs nécessaires.

  • Remarque : Les erreurs et avertissements courants lors du chargement de ces fichiers seront imprimés dans les journaux de débogage.
{
"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": ""
}
ParamètreDescriptionTypeExemple
ProductNameLe ProductName utilisé pour la persistance en tant que nom du composantStringCorsair LL Fan
BrandChaîne représentant la marque du composant pour le filtrageStringCorsair
TypeChaîne représentant le type du composant pour le filtrageStringFan
LedCountEntier représentant le nombre total de LEDs du composantInt16
WidthEntier représentant la largeur du tampon de pixels du composantInt5
HeightEntier représentant la hauteur du tampon de pixels du composantInt5
LedMappingTableau contenant l’ordre dans lequel les informations de couleur des LEDs doivent être retournéesTableau 1D[0,1,2]
LedCoordinatesTableau contenant la position [X,Y] de toutes les LEDsTableau 2D[[0,0],[0,1]]
LedNamesTableau contenant le nom de chaque LEDTableau 1D[“Led 1”,“Led 2”]
ImageUrlChaîne URL d’image utilisée comme miniature du composantString