Lexiconfig Mod pour Minecraft 1.20.1, 1.21.1

Aperçu

Il s'agit d'une API de configuration destinée à assurer la compatibilité entre plusieurs autres bibliothèques de configuration, tout en restant simple d'utilisation dans un projet multiloader, principalement pour une utilisation dans mes mods.

Elle propose une syntaxe simple basée sur des annotations, afin de rendre la création de nouveaux fichiers de configuration aussi facile que possible.

Si vous êtes un utilisateur de mods, ces informations ne vous seront probablement pas très utiles. Si vous êtes en revanche un développeur de mods et que vous souhaitez utiliser Lexiconfig dans vos propres projets, faites défiler jusqu'à la section Développement.

Elle ne prend actuellement pas en charge d'autres bibliothèques de configuration, mais au fur et à mesure de mes mises à jour, j'ajouterai davantage de compatibilités avec chacune d'elles afin de garantir qu'elle n'entre pas en conflit avec les autres et puisse au contraire s'y intégrer de manière transparente.

Voici une liste des intégrations actuelles ainsi que prévues avec différentes bibliothèques/API de configuration :

❌ - Non intégré ✅ - Intégré ❓ - En cours

Statut Mod

❌ Cloth Config

❌ oωo config

✅ Configured

❌ Forge Config Screens

Développement

Ce mod contient une API qui peut être utilisée pour enregistrer de nouveaux lexiques, écouter des événements, etc.

Dépendance

build.gradle

dependencies { implementation "com.codinglitch.lexiconfig:lexiconfig-api:APIVERSIONHERE" }

Vous pouvez vous rendre sur https://versions.codinglitch.com pour consulter la dernière version de l'API.

Utilisation

Pour enregistrer vos propres lexiques, vous devez d'abord créer votre propre Library. Cela peut se faire simplement en créant une nouvelle classe étendant la classe Library, et en l'annotant avec l'annotation LexiconLibrary.

@LexiconLibrary public class MyNewLibrary extends Library { @Override public void shelveLexicons() { } }

Dans une configuration Forge, aucune autre modification n'est nécessaire. Toutefois, si vous développez pour Fabric, vous devrez ajouter cette classe en tant qu'entrypoint dans votre fabric.mod.json.

fabric.mod.json

//... "entrypoints": { "lexiconfig": [ "com.path.to.MyNewLibrary" ] } //...

L'étape suivante consiste enfin à créer et enregistrer vos lexiques. Vous pouvez le faire simplement en créant une autre classe pour le lexique, et en lui fournissant les annotations appropriées, comme suit :

@Lexicon(name = MYLEXICONTITLE) // preferably use your mod id as a name public class MyLexicon extends LexiconData { @LexiconEntry(comment = "This is a comment for a simple field!") public String mySimpleField = "content"; @LexiconPage(comment = "This is a fancy new comment on the fancy new category!") public MyNewPage myNewPage = new MyNewPage(); public static class MyNewPage extends LexiconPageData { @LexiconEntry(comment = "This field is inside a lexicon page!") public Boolean myPageField = true; } }

L'étape suivante et dernière consiste à enregistrer le lexique, ce qui peut se faire simplement en ajoutant une instance de celui-ci en tant que champ dans la bibliothèque et en l'enregistrant dans la méthode donnée.

@LexiconLibrary public class MyNewLibrary extends Library { public static MyLexicon MYLEXICON = new MyLexicon(); @Override public void shelveLexicons() { LexiconfigApi.shelveLexicon(MYLEXICON); } }