Aller au contenu principal

Configuration de FreeMinecraftModels

Cette page couvre les paramètres actuels de config.yml et shop_config.yml qui affectent matériellement l'installation, le rendu, l'interaction des joueurs et la boutique de mobilier optionnelle.

Emplacements des fichiers

plugins/FreeMinecraftModels/config.yml
plugins/FreeMinecraftModels/shop_config.yml

shop_config.yml est généré à la première exécution ; la boutique elle-même reste désactivée jusqu'à ce que vous y adhériez.

Paramètres de config.yml

setupDone

  • Défaut : false
  • Contrôle si les conseils de configuration initiale sont considérés comme terminés
  • Les joueurs disposant de permissions FreeMinecraftModels larges sont invités à exécuter /fmm setup tant que cela reste à false
  • Le flux de configuration bascule cette valeur pour vous ; vous n'avez pas besoin de l'éditer à la main lors de l'onboarding normal

nightbreak.autoDownloadPluginUpdates

  • Défaut : false
  • Paramètre MagmaCore partagé (vit sous la section nightbreak: de config.yml)
  • Lorsque true, FreeMinecraftModels télécharge automatiquement les mises à jour disponibles du jar du plugin et les fichiers de mise à jour de contenu au démarrage
  • Les mises à jour téléchargées du plugin et du contenu ne sont appliquées qu'après le redémarrage du serveur
  • C'est l'équivalent en clé de config d'exécuter /fmm downloadpluginupdate / /fmm downloadall à chaque démarrage ; basculez-le depuis le menu /fmm setup ou à la main

useDisplayEntitiesWhenPossible

  • Défaut : true
  • Indique à FreeMinecraftModels de préférer le rendu via display-entity lorsque le serveur et le client le permettent
  • Le plugin retombe toujours sur les affichages via armor-stand lorsque les display entities ne sont pas disponibles (versions antérieures à 1.19.4 ou Bedrock)
  • Les clients Bedrock sont un cas particulier, donc ne supposez pas que cela force le même chemin de rendu pour tous les joueurs

maxModelViewDistance

  • Défaut : 60
  • Limite la distance à laquelle les entités modélisées sont envoyées aux observateurs
  • Des valeurs plus faibles réduisent la charge de paquets et de rendu client dans les zones denses en modèles
  • Les entités individuelles peuvent surcharger cette valeur au runtime via ModeledEntity.setViewDistanceOverride(int) — voir le guide de l'API

maxInteractionAndAttackDistance

  • Défaut : 3
  • S'applique aux entités modélisées statiques et dynamiques
  • Utilisé par les vérifications d'interaction et de détection de coup runtime

maxInteractionAndAttackDistanceForProps

  • Défaut : 6
  • S'applique aux entités prop
  • Cette valeur est distincte de la distance d'interaction des entités statiques/dynamiques

sendCustomModelsToBedrockClientsV2

  • Défaut : true
  • Contrôle si FreeMinecraftModels tente d'envoyer des modèles personnalisés aux clients Bedrock
  • Cette clé remplace l'ancienne sendCustomModelsToBedrockClients (qui avait pour défaut false). Le renommage en V2 inverse le défaut afin que les joueurs Bedrock voient les modèles par défaut ; si vous aviez auparavant défini explicitement l'ancienne clé, vous pouvez la supprimer et la nouvelle clé V2 prend le relais
  • Si désactivé, les joueurs Bedrock retombent sur l'entité vanilla sous-jacente lorsqu'elle existe (et les déguisements ne s'affichent pas pour eux)
  • Si vous l'activez, assurez-vous que votre chaîne resource-pack Bedrock/Geyser/Floodgate est réellement prête pour ces clients
  • Le logging de diagnostic runtime pour le pipeline d'affichage Bedrock n'est pas une clé de config — il est basculé au runtime via /fmm debug bedrock on|off afin qu'il ne reste jamais accidentellement activé en production. Voir Commandes

preventPropPlacementInProtectedRegions

  • Défaut : true
  • Lorsque true, un joueur qui clique droit pour placer un prop (objet de modèle personnalisé) à l'intérieur d'une région WorldGuard ou d'un claim GriefPrevention est bloqué
  • Les joueurs disposant de la permission freeminecraftmodels.bypassregionprotection (défaut : op) ne sont jamais bloqués
  • Cela dépend de l'installation de WorldGuard (plus WorldEdit) ou de GriefPrevention ; sans plugin de protection présent, cela n'a aucun effet

shop_config.yml

La boutique de mobilier optionnelle adossée à Vault vit dans sa propre config afin de pouvoir être activée ou ajustée indépendamment du comportement principal du plugin. La boutique refuse de s'enregistrer si Vault ou un fournisseur d'économie manque.

Clés de haut niveau

CléDéfautDescription
enabledfalseInterrupteur principal pour /fmm shop. La commande ne s'enregistre que lorsque ceci est true et que Vault + un fournisseur d'économie sont tous deux présents
defaultPrice100.0Prix écrit dans les fichiers de recette qui ne définissent pas leur propre shopPrice lors du prochain chargement
menuTitle&8FMM - Furniture ShopTitre affiché en haut de l'inventaire de la boutique (supporte les codes de couleur &)
priceLoreFormat&7Price: &e{price}Ligne de lore ajoutée à chaque objet de la boutique montrant son prix. Placeholder : {price}
clickToBuyLoreFormat&aClick to purchaseLigne de lore ajoutée à chaque objet de la boutique invitant à l'achat

Clés de messages (messages.*)

Toutes les chaînes de message supportent les codes de couleur &.

CléDéfautPlaceholders
messages.purchaseSuccess&aPurchased &f{item} &afor &e{price}&a. Balance: &e{balance}&a.{item}, {price}, {balance}
messages.insufficientFunds&cYou need &e{price} &cto buy &f{item}&c. Balance: &e{balance}&c.{item}, {price}, {balance}
messages.shopDisabled&cThe furniture shop is currently unavailable.aucun
messages.itemNotForSale&cThat item is not currently for sale.{item}
messages.inventoryFull&eYour inventory was full; &f{item} &ehas been dropped at your feet.{item}

Champs de boutique par recette

Chaque fichier de recette dans plugins/FreeMinecraftModels/recipes/<model_id>.yml reçoit deux champs supplémentaires :

ChampDéfautDescription
shopEnabledtrueIndique si cette recette est visible dans /fmm shop. Les recettes avec shopEnabled: false sont toujours craftables mais jamais listées à l'achat
shopPricedefaultPrice depuis shop_config.ymlCoût en monnaie Vault pour cet objet spécifique

L'éditeur de recettes (/fmm craftify) écrit ces deux champs à l'enregistrement, donc ajuster le prix se fait par une simple édition de texte.

Permissions

Enregistrées dans plugin.yml

PermissionDéfautDescription
freeminecraftmodels.*opWildcard accordant les permissions admin, deleteall et de déguisement self/others
freeminecraftmodels.adminopAccès à /fmm admin (le navigateur de contenu admin) et /fmm giveitem. Les autres commandes admin/debug (/fmm location, /fmm spawn, /fmm mount, /fmm itemify, /fmm craftify, /fmm reload, /fmm stats, /fmm hitbox visualize, /fmm debug bedrock, /fmm setup, /fmm recommendedplugins, /fmm downloadall, /fmm downloadallcontent, /fmm updatecontent, /fmm downloadpluginupdate) vérifient le wildcard freeminecraftmodels.* à la place
freeminecraftmodels.deleteallopEnfant du wildcard ; accès à /fmm deleteall
freeminecraftmodels.disguise.selfopAutorise /fmm disguise / /fmm undisguise sur l'expéditeur
freeminecraftmodels.disguise.othersopAutorise le déguisement/dé-déguisement ciblé plus /fmm disguiselist
freeminecraftmodels.bypassregionprotectionopPlacer/interagir avec les props à l'intérieur des régions WorldGuard ou des claims GriefPrevention même lorsque preventPropPlacementInProtectedRegions est activé
freeminecraftmodels.menutrueAccès au menu d'objets craftables /fmm
freeminecraftmodels.shoptrueAccès à /fmm shop

Configuration YML du modèle

Chaque fichier .bbmodel peut avoir un fichier .yml compagnon (même nom, même répertoire) qui contrôle les paramètres spécifiques au modèle. Le format YML unifié supporte les champs suivants :

isEnabled: true
voxelize: true
solidify: true
scripts:
- my_script.lua
material: DIAMOND_SWORD
name: "&bFrost Blade"
lore:
- "&7A sword forged in ice"
- "&7Deals frost damage"
enchantments:
- SHARPNESS,3
- UNBREAKING,2
ChampTypeDescription
isEnabledbooleanIndique si le modèle est chargé (défaut : true)
scriptsliste de chaînesNoms de fichiers de scripts Lua à attacher depuis plugins/FreeMinecraftModels/scripts/. Incluez .lua pour plus de clarté ; les entrées de config sans .lua sont acceptées et résolues vers des fichiers .lua.
voxelizebooleanLorsque true, le prop s'aligne sur des incréments de rotation de 90 degrés et s'aligne sur la grille de blocs au placement. L'empreinte est calculée à partir des dimensions de hitbox du modèle (arrondies à des blocs entiers). Le placement vérifie que tous les blocs de l'empreinte sont non solides.
solidifybooleanLorsque true (nécessite voxelize: true), des blocs barrières uniquement par paquets sont placés dans chaque bloc de l'empreinte du prop, lui donnant une collision côté client. Ces barrières sont invisibles et n'existent que dans les paquets — elles ne sont pas placées dans le monde. Les barrières sont automatiquement retirées lorsque le prop est ramassé ou détruit.
materialstringUn nom de matériau Bukkit (par ex. DIAMOND_SWORD, PAPER). Lorsqu'il est défini, le modèle devient un objet personnalisé que les joueurs peuvent tenir et équiper
namestringNom d'affichage de l'objet personnalisé (supporte les codes de couleur &)
loreliste de chaînesLignes de lore pour l'objet personnalisé (supporte les codes de couleur &)
enchantmentsliste de chaînesEnchantements au format ENCHANTMENT_NAME,LEVEL (par ex. SHARPNESS,3)

Lorsque material est défini, le modèle est enregistré comme un objet personnalisé. Les joueurs peuvent le recevoir via /fmm giveitem, le fabriquer si une recette est configurée, et il obtient l'accès aux 22 hooks Lua d'objet.

Les props exécutent chaque script listé sous scripts: en tant qu'instances indépendantes. Les objets personnalisés n'utilisent actuellement que le premier script valide de la liste ; les entrées supplémentaires après la première sont ignorées pour le binding runtime de l'objet.

Notes opérationnelles

  • /fmm reload ré-importe le contenu et régénère le pack de sortie, donc les changements de configuration qui affectent le comportement de rendu sont plus simples à valider après un reload. Un FmmReloadedEvent est dispatché à chaque reload afin que les plugins dépendants puissent ré-attacher leurs modèles.
  • FreeMinecraftModels ne fait que générer le resource pack ; il ne l'héberge pas de lui-même.
  • ResourcePackManager reste le chemin de livraison recommandé pour les clients Java et le chemin documenté le plus sûr pour les configurations mixtes.
  • WorldGuard, WorldEdit, GriefPrevention et Vault sont déclarés softdepend dans plugin.yml — aucun d'eux n'est requis pour démarrer le plugin, mais ils débloquent des fonctionnalités spécifiques lorsqu'ils sont présents (prédicats Lua conscients de la protection et boutique de mobilier).

Quand modifier ces valeurs

Utilisez cette config pour ajuster le comportement runtime, pas pour la gestion des packs de contenu.

  • Utilisez /fmm setup, /fmm downloadall et /fmm updatecontent pour le cycle de vie des packs officiels
  • Utilisez le dossier imports pour l'import manuel de .bbmodel ou d'autres contenus locaux
  • Utilisez config.yml lorsque vous devez ajuster le mode de rendu, la distance de visibilité, la distance d'interaction, le comportement Bedrock, l'application de la protection des régions ou les téléchargements automatiques de mises à jour
  • Utilisez shop_config.yml (et les champs par recette shopEnabled/shopPrice) pour ajuster la boutique de mobilier sans toucher au code

Limitations connues

  • Le comportement Bedrock dépend à la fois de sendCustomModelsToBedrockClientsV2 et de votre configuration Floodgate/Geyser/resource pack plus large, donc restez prudent dans vos affirmations à moins d'avoir testé votre stack exacte.
  • La boutique se désactive silencieusement si Vault ou un fournisseur d'économie manque. Utilisez /fmm version et vérifiez la console au démarrage si /fmm shop est inexplicablement absent.