Skip to content

thePixelmancer/regolith-filters

Repository files navigation

main banner

GitHub License Regolith

A curated collection of custom Regolith filters for Minecraft Bedrock Edition development. These filters help automate common tasks, streamline workflows, and enhance your Bedrock Edition project development experience.

🚀 Ready to supercharge your Minecraft development? Each filter is designed to solve real problems that Bedrock Edition developers face daily.

📦 Available Filters

Link Short Description
🎨 Aseprite Convert Convert Aseprite files into PNGs in multiple modes, including spritesheets and atlas.
🥚 Auto Spawn Egg Auto-generate spawn egg colors for custom entities based on dominant texture colors.
📦 Fetcher Download files or folders from GitHub into your Minecraft project.
Image Mixer Batch-generate composite images from layered PNGs with advanced positioning/scaling.
🌐 MCLocalize Manage localization files for multiple languages in Bedrock Edition.
🔄 Replacements Perform project-wide intelligent string replacements for identifiers and namespaces.
🗃️ Jsonify Convert YAML, JSON5, JSONC, and TOML files to JSON recursively.
MultiFeature Combine multiple feature definitions in one file and split into .json during build.
🍳 Recipe Image Gen Generate recipe images automatically from crafting recipe definitions.

Detailed filter documentation, installation guides, and configuration examples are provided below.

🚀 Quick Start

Installation

Each filter can be installed individually using Regolith:

# Install specific filters by folder name
regolith install aseprite_convert
regolith install auto_spawn_egg
regolith install fetcher
regolith install image_mixer
regolith install mclocalize
regolith install replacements
regolith install jsonify
regolith install multifeature
regolith install recipe_image_gen

Usage

Add filters to your Regolith profile in config.json:

{
  "regolith": {
    "profiles": {
      "default": {
        "filters": [
          {
            "filter": "filter-name",
            "settings": {
              // Filter-specific configuration
            }
          }
        ]
      }
    }
  }
}

📋 Requirements

General Requirements

  • Regolith - Bedrock Edition development framework
  • Python 3.7+ (for Python-based filters)

Filter-Specific Requirements

  • Aseprite Convert: Aseprite software
  • Auto Spawn Egg: colorthief Python library
  • Image Mixer: Pillow (PIL) Python library
  • Fetcher: requests Python library
  • Jsonify: ruamel.yaml, json5, tomllib Python libraries
  • MCLocalize: translators Python library
  • Recipe Image Gen: Pillow (PIL), reticulator Python libraries

Install Python dependencies:

pip install colorthief pillow requests ruamel.yaml json5 translators reticulator

🤝 Contributing

Contributions are welcome! Whether you want to:

  • 🐛 Report bugs
  • 💡 Suggest new features
  • 🔧 Submit pull requests
  • 📚 Improve documentation

Please feel free to open an issue or submit a pull request.

Development Guidelines

  1. Each filter should be self-contained in its own directory
  2. Include comprehensive README documentation
  3. Provide example configurations and test cases
  4. Follow Python best practices for code quality
  5. Test thoroughly with various Minecraft project setups

🌟 Why Choose These Filters?

  • Production-Ready: Battle-tested in real Minecraft projects
  • 🔧 Easy Integration: Simple installation and configuration
  • 📚 Comprehensive Docs: Detailed documentation and examples
  • 🎯 Focused Solutions: Each filter solves specific development challenges
  • 🤝 Community-Driven: Open source with active community support

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

  • Thanks to the Regolith team for creating an amazing development framework
  • The Minecraft Bedrock Edition community for inspiration and feedback
  • Contributors who help improve and maintain these filters

📞 Support

If you encounter issues or need help:

  1. Check the individual filter README files for specific documentation
  2. Search existing GitHub issues
  3. Create a new issue with detailed information about your problem

Star this repository if you find these filters helpful!

About

No description or website provided.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages