mcpywrap

# 🧰 mcpywrap **A full lifecycle management tool for ModSDK and resource packs of the Chinese version of Minecraft** [](https://pypi.org/project/mcpywrap/) [](LICENSE) mcpywrap is a full lifecycle management tool for the ModSDK/resource packs of the Chinese version of Minecraft, based on the Python ecosystem. It supports dependency management, syntax conversion, and automated builds, helping developers achieve efficient collaboration and code reuse. ## 🌟 Core Features - 🧩 **Modular Development** - Dependency management based on the Addons dimension (development and testing processes based on package management and dependencies) - 🔄 **Modern Syntax** - Supports modern syntax features of Python3, enhancing the development experience - 📦 **Ecosystem Compatibility** - Seamlessly integrates with the PyPI ecosystem, supporting standard `pyproject.toml` configuration - 🚀 **Intelligent Build** - One-click packaging of finished Addons that comply with MCStudio specifications - 🔥 **Hot Reload Development** - Real-time monitoring of code changes, supporting hot updates in MCStudio ## 📖 Why Choose This Tool? ### Traditional Development Pain Points - 📜 **Difficult Code Reuse** - Version management chaos caused by **file copying** - 🚧 **Low Collaboration Efficiency** - High maintenance costs for **duplicate code** across multiple projects - ⚠️ **Code Quality** - Lack of modern development tools and syntax support ### mcpywrap Solutions 1. **Standardized Development** Declare project metadata and dependencies through `pyproject.toml` to achieve true modular development. 2. **Directly Start Testing and Editing** - Start a game instance directly with `mcpy run`, supporting hot reload and real-time builds to enhance development efficiency. - Edit using the MC Studio Editor with the `mcpy edit` command. 3. **Ecosystem Integration** Relying on the pip package management system, it supports version locking and automatic resolution of dependencies. ## 🚀 Quick Start ### Prerequisites - Python ≥ 3.8 - pip ≥ 21.0 ### Installation ```bash pip install mcpywrap ``` ### Initialize Project ```bash # First, navigate to the project directory mcpy init ``` Interactively create the project structure and automatically generate a standard Mod framework. ### Run Tests ```bash mcpy run ``` ## 🛠 Workflow Guide ### Dependency Management | Command | Description | |----------------------------------|------------------------------| | `mcpy` | Maintain the project, installing it into the system site-package environment | | `mcpy add <package> [version]` | Add a specified version dependency | | `mcpy remove <package>` | Remove a dependency | ### Complete Command Reference ```bash mcpy --help ``` #### Dependency Management | Command | Description | |----------------------------------|------------------------------| | `mcpy add <package> [version]` | Add a specified version dependency and install it into the project | | `mcpy remove <package>` | Remove the dependency from the project configuration and optionally uninstall it | #### Project Initialization and Development | Command | Description | |----------------------------------|------------------------------| | `mcpy init` | Interactive project initialization, creating basic package information and configuration | | `mcpy mod` | Guided creation of the basic framework for Python Mod | | `mcpy build` | Build into an MCStudio project | | `mcpy dev` | Use watch mode for real-time builds and hot reload | | `mcpy edit` | Edit using the MC Studio Editor | #### ModSDK and Game Instance | Command | Description | |----------------------------------|------------------------------| | `mcpy modsdk` | Manage NetEase Minecraft ModSDK | | `mcpy run` | Run and manage game instances | #### Publish Project | Command | Description | |----------------------------------|------------------------------| | `mcpy publish` | Publish the project to PyPI | #### Game Instance Management Details ```bash # Start the latest game instance mcpy run # Create a new game instance mcpy run -n # List all available game instances mcpy run -l # Delete a specified game instance mcpy run -d <instance ID prefix> ``` ## 🤝 Contributing Feel free to submit Issues and PRs! Please read the [Contributing Guide](CONTRIBUTING.md) first. ## Open Source License [MIT License](LICENSE) © 2025 EaseCation