Ajouter des réglages

Cette API permet à un mod client Fabric de contribuer des options à l’écran de réglages d’ElytraF5 & more. Les composants suivent le thème visuel de l’écran et les valeurs restent contrôlées par votre mod.

Avant de commencer

Le mod ElytraF5 doit être présent dans l’environnement de jeu.
Votre intégration s’exécute dans un entrypoint ClientModInitializer.
Votre code doit être compilé contre l’API client ElytraF5.
Votre mod reste responsable du stockage et de la persistance des valeurs.

Démarrage rapide

Enregistrez une catégorie pendant l’initialisation cliente. Exemple minimal avec un interrupteur :

class ExampleClient : ClientModInitializer {
    private var enabled = true

    override fun onInitializeClient() {
        ElytraF5SettingsApi.registerCategory(
            SettingsCategory(
                id = "examplemod:visuals",
                title = Component.translatable("examplemod.settings.visuals"),
                options = listOf(
                    BooleanSettingOption(
                        id = "enabled",
                        title = Component.translatable("examplemod.settings.enabled"),
                        description = Component.translatable("examplemod.settings.enabled.tooltip"),
                        currentValue = { enabled },
                        onChanged = { enabled = it }
                    )
                )
            )
        )
    }
}

Quand le joueur ouvre ElytraF5, la catégorie apparaît dans la barre latérale. Le contrôle lit currentValue() et appelle onChanged quand sa valeur change.

Types de contrôles

BooleanSettingOption

Interrupteur cyclique ON/OFF. Les libellés sont fournis par les traductions d’ElytraF5.

ChoiceSettingOption

Sélecteur cyclique entre des valeurs identifiées, avec le nom d’affichage de votre choix.

ActionSettingOption

Bouton d’action, par exemple pour ouvrir une page de configuration dédiée.

Consultez la référence complète des types et contraintes, puis les exemples de stockage, Gradle, traductions et écrans avancés.

L’inscription est faite une fois au démarrage client. Ne réenregistrez pas la même catégorie après un changement de monde : les identifiants en double provoquent une erreur de validation.