Prickle Mod pour Minecraft 1.21, 26.3

Prickle est un format de configuration basé sur JSON. Ce mod permet d'utiliser ce format dans Minecraft ! Pour la documentation technique, veuillez consulter la page GitHub.

Quels avantages offre Prickle ? Prickle est basé sur JSON mais ajoute plusieurs fonctionnalités utiles comme les commentaires et les décorateurs. Prickle est 100 % rétrocompatible avec JSON et prend en charge toutes ses fonctionnalités, ses outils et sa coloration syntaxique.

Pourquoi cela s'appelle-t-il Prickle ? Prickle est le nom collectif désignant un groupe de hérissons. Les hérissons sont l'un de mes animaux préférés et je trouve qu'ils constituent une métaphore appropriée pour les fichiers de configuration. Par exemple, ils peuvent tous deux sembler intimidants au premier abord mais peuvent être agréables une fois qu'on apprend à les connaître et à les comprendre.

Pourquoi ne pas utiliser un format existant ? Par le passé, j'ai utilisé JSON pour mes fichiers de configuration mais plusieurs problèmes se posaient, comme l'absence de commentaires et de valeurs par défaut. Prickle ajoute ces fonctionnalités à JSON tout en restant 100 % rétrocompatible. J'ai essayé d'autres formats comme TOML mais j'ai été déçu par un grand nombre de leurs implémentations Java. Elles manquent souvent de fonctionnalités que je considère importantes, comportent de graves bugs et ne sont plus maintenues. Minecraft utilise déjà JSON pour les datapacks et les commandes, ce qui en fait un choix familier pour la plupart des joueurs.

Spécifications du format

Dans Prickle, les valeurs des propriétés sont encapsulées dans un objet JSON. Cela permet d'attribuer des métadonnées comme des commentaires à cette propriété.

Par exemple, un fichier JSON standard ressemblerait à ceci.

{ "databasehost": "192.168.1.222" }

Le même JSON sous forme de fichier Prickle ressemblerait à ceci.

{ "databasehost": { "//": "L'adresse IP de la base de données à laquelle se connecter.", "value": "192.168.1.222" } }

Commentaires

La clé // est réservée aux commentaires. Les commentaires servent uniquement à fournir un contexte supplémentaire au lecteur et ne doivent jamais influencer la façon dont le fichier est analysé. Les commentaires peuvent être une chaîne JSON ou un tableau de chaînes pour les commentaires multilignes.

{ "databasehost": { "//": [ "L'adresse IP de la base de données à laquelle se connecter.", "Le port peut être défini à la fin en utilisant un :" ], "value": "192.168.1.222:1273" } }

Décorateurs

Les décorateurs sont des commentaires nommés qui transmettent un attribut spécifique de la propriété. Un exemple courant de décorateur est //default qui peut être utilisé pour afficher la valeur par défaut de la propriété. Comme les commentaires, les décorateurs n'ont aucune influence sur la façon dont le fichier est analysé, ils décrivent seulement comment la propriété sera analysée.

Vous pouvez rencontrer certains des décorateurs suivants dans les fichiers prickle.

• //default - La valeur par défaut de la propriété.
• //reference - Une ressource pouvant être utilisée pour en savoir plus, comme un lien vers une page wiki.
• //range - La plage acceptable pour une valeur. Par exemple >=5.
• //regex - Un motif regex auquel la valeur doit correspondre.
• //empty-allowed - Si la valeur peut être vide ou non. (par défaut, true).

Sponsors

Ce projet est sponsorisé par Nodecraft. Utilisez le code DARKHAX pour obtenir 30 % de réduction sur votre premier mois de service !