Fabric Language Python - Mod Template

Welcome to the Fabric Language Python Mod Template! This repository is designed to help you jumpstart your Python-based Minecraft Mod development in seconds.

🚀 Getting Started

This template is fully "Plug & Play". You do not need to install Python, configure complex Gradle scripts, or manually set up Mixins. Everything is pre-configured to work out-of-the-box using GraalVM.

1. Clone this repository or click "Use this template" on GitHub.
2. Open the project in your favorite IDE (IntelliJ IDEA, VS Code, etc.).
3. Write your Python Code inside the src/main/python directory.
4. Build the Mod: Open a terminal and run the standard Gradle build command:

   ./gradlew build

   Note on Windows: Use .\gradlew build

This will automatically compile your Python Mixins and generate a ready-to-distribute .jar file in the build/libs/ folder.

📚 Modding Documentation

For a comprehensive guide on how to use the framework, including how to register items, blocks, entities, and how to write Python Mixins (@Mixin), please read the official documentation:

👉 Read the Official MODDING.md Guide

⚖️ License

This framework and its proprietary bridging engine are protected by a custom license. By using this template, you agree to the terms specified in the official repository.

👉 Read the License