📂 stewbeet.plugins.copy_to_destination

📄 Source Code: stewbeet/plugins/copy_to_destination/__init__.py 🔗

🔗 Dependencies

• ✅ Required: Generated pack archives from archive plugin
• ✅ Required: Configured destination paths in project metadata
• 📍 Position: Should run after archive and merge_smithed_weld plugins
• 🔧 Optional: Custom libraries in libs folder
• 🔧 Optional: Official libraries (copies only used ones)
• 📋 Related: Works with output from archive and merge plugins

📋 Overview

The copy_to_destination plugin automatically copies generated packs to configured destinations.
It handles copying datapacks, resource packs, library dependencies, and official libraries
to multiple destination folders with intelligent merge detection, retry logic for permission
handling, and proper directory structure management for development and testing workflows.

Some Features Showcase

Datapack and all dependencies are copied to destination

🎯 Purpose

• 📂 Copies generated packs to configured destination folders
• 🔗 Handles both individual datapacks and merged resource packs
• 📚 Automatically copies library dependencies and official libraries
• 🔄 Provides retry logic for handling permission errors
• 🎯 Supports multiple destinations for different environments (local and remote)
• 🌐 Supports SFTP remote destinations with optional credentials file
• 🛠️ Facilitates development workflows with automatic deployment

⚙️ Configuration

🎯 Basic Example Configuration

pipeline:
  - ...
  - stewbeet.plugins.copy_to_destination

meta:
  stewbeet:
    build_copy_destinations:
      datapack:
        - "path/to/minecraft/saves/world/datapacks"
        - "path/to/development/datapacks"
        - "sftp://user@host/remote/path/datapacks"
      resource_pack:
        - "path/to/minecraft/resourcepacks"
        - "path/to/server/resourcepacks"
        - "sftp://user@host/remote/path/resourcepacks"
    libs_folder: "libs"  # Optional: custom libraries folder

📋 Configuration Options

🔐 SFTP Credentials

SFTP destinations use the URL format sftp://user@host/remote/path. The password is resolved in this order:

1. Inline in the URL — sftp://user:password@host/remote/path (not recommended for version-controlled files)
2. Credentials file — ~/stewbeet/credentials.yml (recommended)

~/stewbeet/credentials.yml structure

sftp:
  user@host:       # must match the user@host part of the SFTP URL exactly
    password: "your_password"

⚠️ If the remote directory does not exist, the copy is skipped with a warning. The plugin will not create remote directories.

✨ Features

📦 Datapack Distribution System

Copies main datapacks and library dependencies to configured destinations:

• 📁 Copies main project datapack to all configured destinations
• 📚 Automatically includes all library datapacks from libs folder
• 🔍 Scans for .zip files in the libraries datapack directory
• ✅ Creates destination directories if they don't exist

🎨 Resource Pack Management

Handles resource pack copying with merge detection:

• 🔗 Prioritizes merged resource packs over individual ones
• 📦 Falls back to normal resource pack if merged version unavailable
• 🏷️ Preserves appropriate naming for merged vs normal packs
• 📁 Maintains proper file organization in destination folders

🏛️ Official Library Distribution

Copies used official libraries to datapack destinations:

• 📚 Only copies libraries marked as used in the project
• 🔍 Validates library existence before copying
• 📁 Organizes libraries in appropriate destination folders
• ✅ Provides informative logging for each copied library

🔄 Retry Logic System

Implements robust file copying with error handling:

• 🛡️ Handles permission errors with automatic retry logic
• ⏰ Uses configurable delay between retry attempts
• 🧹 Attempts to remove existing files before copying
• ⚠️ Provides warnings during retry attempts with clear messaging

🌐 SFTP Remote Destinations

Copies files to remote servers over SFTP:

• 🔗 Accepts sftp://user@host/path URLs alongside local paths
• 🔐 Resolves passwords from inline URL or ~/stewbeet/credentials.yml
• ⚠️ Skips copy with a warning if the remote directory does not exist
• 🚫 No retry logic for SFTP (handled by the underlying fsspec library)

📊 Smart Copy Detection

Intelligently determines which files to copy based on availability:

• 🔍 Checks for pack existence before attempting copies
• 📋 Skips operations when no destinations are configured
• 🎯 Validates project configuration requirements
• ✅ Provides early exit for efficiency when no work is needed