View on GitHub

⚡ stewbeet.plugins.datapack.loading

📄 Source Code: stewbeet/plugins/datapack/loading/__init__.py 🔗

🔗 Dependencies

  • ✅ Required: None (but works best with other StewBeet plugins)
  • 🔗 Requires Later: stewbeet.plugins.finalyze.dependencies (to complete setup)
  • 📍 Position: Should be placed after item definitions and before finalization plugins
    (see basic/beet.yml for an example)

📋 Overview

The datapack.loading plugin sets up the versioned loading system for Minecraft datapacks.
It creates version checking functions, load management, and item storage systems following the LanternLoad convention.
The plugin ensures proper datapack initialization with dependency validation and prevents duplicate loading.
(This plugin requires stewbeet.plugins.finalyze.dependencies later in the pipeline to complete the setup.)

Some Features Showcase

Lantern Load Setup (#load, #enumerate, #resolve, etc.):

All item definitions stored into a storage:

Confirm datapack load for players with convention.debug tag:

🎯 Purpose

  • ⚡ Sets up versioned datapack loading system
  • 🔍 Implements version checking and validation
  • 📦 Creates item storage systems for definitions
  • 🔄 Prevents duplicate datapack loading
  • 🏷️ Follows LanternLoad convention standards
  • 📋 Manages load status tracking with scoreboards

⚙️ Configuration

🎯 Basic Example Configuration

version: "1.0.0"  # Required: semantic version (major.minor.patch)
id: "your_namespace"  # Required: project namespace
name: "Your Project Name"  # Required: display name for load messages

pipeline:
  - ...
  - stewbeet.plugins.datapack.loading  # Place this plugin in the pipeline
  - ...  # Other plugins follow
  - stewbeet.plugins.finalyze.dependencies  # Required later for completion

📋 Configuration Options

OptionTypeDefaultDescription
versionstringRequiredSemantic version in format "major.minor.patch" for version checking
idstringRequiredProject namespace used for function and storage generation
namestringRequiredDisplay name used in load confirmation messages

✨ Features

⚡ Versioned Loading System

  • 🔢 Version Parsing - Splits semantic version into major.minor.patch components
  • 📊 Version Checking - Creates enumerate function for version validation
  • 🎯 Load Resolution - Generates resolve function for proper version loading
  • 🏷️ Function Tags - Sets up enumerate and resolve function tags

🔄 Load Management

  • 🚫 Duplicate Prevention - Prevents multiple executions of load functions
  • 📋 Status Tracking - Uses scoreboards to track loading state
  • 💬 Load Confirmation - Displays load messages to players with convention.debug tag
  • ⚙️ Secondary Function - Manages actual load execution flow

📦 Item Storage System

  • 🗄️ Storage Initialization - Creates namespace:items storage system
  • 🔧 Component Processing - Handles item components and minecraft: namespace prefixing
  • 🎯 Data Filtering - Excludes non-component data from storage
  • 📝 JSON Serialization - Converts definitions to storage commands