Utiliser des bibliothèques de datapack

Le système de dépendances de StewBeet a deux couches : les bibliothèques officielles auto-détectées depuis les fonctions (sans config), et les custom load_dependencies déclarées dans beet.yml. Les deux sont téléchargées au build et génèrent des vérifications de version au runtime avec des messages d'erreur cliquables.

Référence de configuration : extensive/beet.yml

Exemple réel : SimplEnergy/beet.yml

Code source : stewbeet/plugins/finalyze/dependencies/init.py

Requis : stewbeet.plugins.finalyze.dependencies dans le pipeline
Requis : stewbeet.plugins.datapack.loading doit s'exécuter avant
Position : Doit être placé après que toutes les fonctions utilisateur aient été écrites (les scanne pour détecter les bibliothèques)

  • Détecter et télécharger automatiquement les bibliothèques officielles: aucune configuration requise
  • Déclarer des custom dependencies dans beet.yml avec load_dependencies
  • Générer des vérifications de version au runtime et de compatibilité Minecraft
  • Fournir des messages d'erreur en jeu cliquables quand des dépendances sont manquantes

Déclarer une Dépendance: Partir d'un Exemple Réel

SimplEnergy déclare une bibliothèque externe dans son beet.yml :

yaml
meta:
  stewbeet:
    load_dependencies:
      energy:                                           # namespace de la dépendance (utilisé pour les vérifications de scoreboard au runtime)
        name: "DatapackEnergy"                         # nom affiché dans les messages d'erreur
        url: "https://github.com/ICY105/DatapackEnergy" # lien cliquable si la bibliothèque est manquante
        source: "smithed"                              # méthode de téléchargement
        smithed_id: "energy"                           # ID du pack Smithed

Au build, StewBeet interroge l'API Smithed pour la dernière version d'energy compatible avec la version Minecraft configurée, télécharge le zip et le fusionne dans la sortie. Au runtime, il vérifie que les scores #energy.major/minor/patch load.status respectent la version requise.

Référence des Champs

ChampRequisDescription
name✅Nom affiché dans les messages d'erreur au runtime
url✅Lien cliquable affiché quand la dépendance est manquante
source✅Méthode de téléchargement : "smithed", "modrinth", ou "static"
smithed_idSmithed onlyID du pack Smithed utilisé pour interroger l'API
has_resource_packSmithed onlyTélécharger également le resource pack (défaut : false)
modrinth_slugModrinth onlySlug du projet Modrinth
static_urlsStatic onlyAssocie des clés "((mc_ver), (dep_ver))" à des URLs de téléchargement
versionStatic onlyRésolu automatiquement depuis static_urls au moment du build

Autres Source Types

En dehors de "smithed", deux autres source types sont disponibles :

yaml
load_dependencies:
  # Modrinth: dernière release pour la version MC courante auto-récupérée
  "itemio":
    name: "ItemIO"
    url: "https://github.com/edayot/ItemIO"
    source: "modrinth"
    modrinth_slug: "itemio"

  # Static: URL zip figée, meilleure clé de version MC sélectionnée
  "common_signals":
    version: [0, 2, 0]
    name: "Common Signals"
    url: "https://github.com/Stoupy51/CommonSignals"
    source: "static"
    static_urls:
      "((1, 21, 7), (0, 2, 0))": "https://github.com/Stoupy51/CommonSignals/releases/download/v0.2.0/CommonSignals_datapack.zip"

Bibliothèques Officielles (Auto-détectées)

Pour les bibliothèques bien connues, aucune entrée load_dependencies n'est nécessaire: StewBeet les détecte en scannant les fonctions et les télécharge automatiquement.

  • Modules Bookshelf (bs.*) : détectés quand un appel de tag #bs.X:... apparaît dans n'importe quelle fonction.
  • Autres bibliothèques : détectées quand leur namespace apparaît dans n'importe quelle fonction.

Smithed: smithed.custom_block, smithed.crafter, smithed.actionbar, realistic_explosion
Modrinth: itemio, common_signals, furnace_nbt_recipes, smart_ore_generation
Bookshelf (tous les modules bs.* (bs.math, bs.block, bs.raycast, ...))voir Bookshelf releases
Gamemode 4: gm4_forceload, gm4_hooked_entity, gm4_lore, gm4_machines, gm4_potion_tracking, gm4_trees. Leur vérification de version lit les scores GM4 (gm4_forceload et gm4_forceload_minor dans load.status). lib_player_motion n'est pas détectée : utilisez player_motion à la place.

smart_ore_generation câble aussi automatiquement vos fonctions calls/smart_ore_generation/generate_ores, denied_dimensions et post_generation vers les tags smart_ore_generation:v1/signals/ correspondants.

Générer des minerais avec CustomOreGeneration

CustomOreGeneration écrit ces fonctions generate_ores pour vous, et l'utiliser ajoute smart_ore_generation aux dépendances. La bibliothèque scanne des régions de 96x96 autour des joueurs et démarre chaque filon à une position aléatoire à côté de l'air, pour que les joueurs trouvent les minerais.

python
from stewbeet import CustomOreGeneration

CustomOreGeneration.all_with_config({
    "steel_ore": [
        # Filons communs, de y=0 à y=50
        CustomOreGeneration(dimensions=["minecraft:overworld"], minimum_height=0, maximum_height=50, veins_per_region=1.2),
        # Filons en plus dans les badlands uniquement, remplaçant la terracotta qui a de la terracotta au-dessus
        CustomOreGeneration(
            dimensions=["minecraft:overworld"],
            minimum_height=60,
            maximum_height=120,
            veins_per_region=2,
            provider=["#minecraft:terracotta"],
            vein_conditions=["if biome ~ ~ ~ #minecraft:is_badlands"],
            block_conditions=["if block ~ ~1 ~ #minecraft:terracotta"],
        ),
    ],
    "deepslate_steel_ore": [
        CustomOreGeneration(dimensions=["minecraft:overworld"], maximum_height=0, veins_per_region=1.2),
    ],
})

Appelez-le depuis un plugin qui s'exécute après la création des blocs custom, comme src/link.py dans le template extensive. Les clés sont des ids de blocs custom (ou des objets Block), et un minerai avec plusieurs configurations obtient une fonction de filon par configuration.

ChampDéfautRôle
dimensionsrequisDimensions où générer, ex : ["minecraft:overworld", "stardust:cavern"]
minimum_heightNoney le plus bas d'un filon, None pour le fond de l'overworld
maximum_height70y le plus haut d'un filon
veins_per_region4Filons par région, la partie décimale étant une chance : 1.2 donne un filon plus 20% de chance d'un second
vein_size_logic0.4Taille des filons : 0.0 pour un seul bloc, 0.4 un petit filon, 1.0 un gros
providerblocs remplaçables par les carvers de l'overworldBloc, tag de blocs, ou liste des deux, que le minerai remplace
vein_conditions[]Conditions vérifiées une fois au départ du filon, qui l'annulent en entier
block_conditions[]Conditions vérifiées à chaque bloc du filon
placer_commandpose le bloc customSous-commandes execute finissant par run ..., posant un minerai en ~ ~ ~

Les conditions sont des sous-commandes execute commençant par if ou unless , et elles doivent toutes être vraies. Utilisez vein_conditions pour ce qui est identique sur tout un filon, comme un biome (if biome ~ ~ ~ #minecraft:is_badlands), et block_conditions pour ce qui dépend de chaque bloc, comme ses voisins (if block ~ ~-1 ~ minecraft:deepslate). Pour ne remplacer que certains blocs, changez provider plutôt que d'ajouter une condition de bloc.

Quand x_ore et deepslate_x_ore sont tous les deux définis, le placer par défaut ne pose pas x_ore sur de la deepslate ni deepslate_x_ore sur de la stone.


Comportement au Runtime

Au chargement du monde, les fonctions générées s'exécutent dans cet ordre :

  1. Lantern Load déclenche le tag #dep:load de chaque dépendance afin que les bibliothèques publient leurs scores de version dans load.status.
  2. check_dependencies: positionne le flag #dependency_error ns.data si un score de version est trop ancien.
  3. valid_dependencies: attend une entité joueur, lit DataVersion pour vérifier la version Minecraft (par rapport au minimum de mc_supports), puis envoie des tellraw @a avec des liens d'erreur cliquables en cas d'échec. N'appelle confirm_load que quand toutes les vérifications passent.

Messages d'erreur en jeu quand des dépendances sont manquantes :

Fonction check_dependencies générée :


Fichiers Générés

FichierTypeDescription
Tag minecraft:loadTagPoint d'entrée: déclenche #load:_private/load
Tag load:loadTagPointe vers #ns:load
Tag ns:loadTagAppelle [#ns:enumerate, #ns:resolve]
Tag ns:enumerateTagPréfixé avec #ns:dependencies
Tag ns:dependenciesTagListe #dep:load pour chaque dépendance
load:_private/initFunctionRéinitialise le scoreboard load.status
ns:vX.Y.Z/load/secondaryFunctionEnregistre le scoreboard ns.data, appelle check/valid
ns:vX.Y.Z/load/check_dependenciesFunctionPositionne #dependency_error via des vérifications de version
ns:vX.Y.Z/load/valid_dependenciesFunctionAttend un joueur, vérifie DataVersion, affiche les erreurs
ns:vX.Y.Z/load/confirm_loadFunctionAppelée uniquement quand toutes les vérifications passent
ns:vX.Y.Z/load/tick_verificationFunctionRoute la fonction tick uniquement quand la bonne version est chargée

Glossaire

TermeSignification
load_dependenciesUn dictionnaire dans beet.yml où déclarer les bibliothèques externes à télécharger automatiquement et vérifier en version au runtime.
Source typeLa méthode de résolution et téléchargement d'une bibliothèque: "smithed" (API Smithed), "modrinth" (API Modrinth), ou "static" (URL zip figée par version MC).
Bibliothèque officielleUne bibliothèque pré-enregistrée dans le registre OFFICIAL_LIBS de StewBeet, détectée automatiquement depuis les fonctions: aucune configuration requise.
Lantern LoadUn standard communautaire pour l'ordre de chargement des datapacks ; StewBeet le configure automatiquement.
DataVersionUn champ NBT d'entité utilisé pour détecter la version Minecraft au runtime ; comparé au minimum issu de mc_supports.

Prochaines étapes