fabricpy documentation

fabricpy is a lightweight helper library for writing Fabric mods in Python. It provides a simple, Pythonic interface for creating Minecraft Fabric mods without needing to write Java directly.

Features

  • Item Registration: Easy creation of custom items, tools, and food items

  • Block Registration: Simple block creation with automatic BlockItem generation

  • Recipe Support: Built-in recipe JSON handling for crafting, smelting, etc.

  • Loot Tables: Native loot table support with builder methods for common drop patterns

  • Mining Configuration: Hardness, resistance, tool types, mining levels, and per-tool speed overrides

  • Creative Tabs: Support for both vanilla and custom creative inventory tabs

  • Automatic Compilation: Generates complete Fabric mod projects from Python code

  • Google Docstrings: Comprehensive documentation with examples

Quick Start

Here’s a simple example of creating a mod with fabricpy:

import fabricpy

# Create mod configuration
mod = fabricpy.ModConfig(
    mod_id="mymod",
    name="My Awesome Mod",
    version="1.0.0",
    description="Adds cool items to Minecraft",
    authors=["Your Name"]
)

# Create and register an item
item = fabricpy.Item(
    id="mymod:cool_sword",
    name="Cool Sword",
    item_group=fabricpy.item_group.COMBAT
)
mod.registerItem(item)

# Compile and run
mod.compile()
mod.run()

Helpful Tools

Examples

The examples directory contains runnable scripts showcasing fabricpy features, including a ToolItem demonstration.

Contents:

API Documentation:

Module Details: