feat: Overhaul addon processing, and update docs #1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit introduces a major enhancement to the addon management system, resolves a critical logging bug, establishes an automated build and release pipeline, and updates the documentation. **1. Advanced Addon Processing & State Management:** - Implements recursive processing to fully support nested archives (e.g., .mcaddon files containing multiple .mcpacks). - Generates unique, hashed folder names for each pack to prevent conflicts and ensure safe installation. - Automatically detects file modifications to clean up old versions and reinstall updated ones. - Cleans up installed packs automatically if the source addon file is deleted. - Reinstalls packs if they are detected as missing from the world folders (e.g., after manual deletion). **2. Bug Fix:** - Resolves a TypeError that occurred when logging addon filenames with non-standard characters. - All filenames are now sanitized before being logged to ensure stability. **3. CI/CD Automation:** - Adds a GitHub Actions workflow to automate the build and release process. - The workflow triggers on new version tags (v*.*.*), builds the package, and creates a GitHub Release with the distributable files attached. **4. Documentation:** - Updates the README.md to reflect all new features, architecture, and usage instructions.
…ading, recursive processing, and cleanup of packs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Intelligent Addon & State Management
The core addon handling logic has been completely rewritten to be state-aware.
processed.jsonfile is used to store a "footprint" (a hash or modification date) and a list of installed pack folders for each addon file./addonsfolder, the plugin will automatically remove its corresponding packs from the world folder on the next server start.Robust Extraction & Processing
The method for extracting addons has been greatly improved.
.mcaddonfiles that contain multiple nested.mcpackor.zipfiles.MyAddon_a1b2c3d4). This prevents name collisions and ensures that cleaning up an addon only removes its specific files.Documentation and Usability
README.mdhas been significantly updated with a "Key Features" section and a "How It Works" section to clearly explain the new, powerful capabilities of the plugin.config.jsonif they are missing, improving the initial setup experience.