mcstructure

Read and write Minecraft .mcstructure files.

🌍 This README is also available in the following languages:

• 🇨🇳 Chinese
• 🇩🇪 German

In the entire project (and officially since the "Better Together Update") the term "Minecraft" refers to the edition of Minecraft that is also known as the "Bedrock Edition".

Features that this library provides are only useful for the above named edition of Minecraft.

This library lets you programmatically create and edit Minecraft structures. You are able to save these as .mcstructure files and for example use them in behavior packs.

You may as well read them to identify blocks and and entities that were saved with a Structure Block in-game.

Installation

pip install mcstructure

Basic Usage

from mcstructure import Block, Structure

struct = Structure(
    (7, 7, 7),
    Block("minecraft:wool", color = "red")
)

(struct
    .set_block((1, 1, 1), Block("minecraft:grass"))
    .set_block((2, 2, 2), Block("minecraft:grass"))
    .set_block((3, 3, 3), Block("minecraft:grass"))
    .set_block((4, 4, 4), Block("minecraft:grass"))
    .set_block((5, 5, 5), Block("minecraft:grass"))
    .set_block((6, 6, 6), Block("minecraft:grass"))
)

with open("house.mcstructure", "wb") as f:
    struct.dump(f)

with open("house.mcstructure", "rb") as f:
    struct = Structure.load(f)

References

• 📖 Documentation
• 📁 Source Code
• 🐍 PyPI

External Resources

• 👋 Introduction to Structure Blocks
• 📖 Bedrock Wiki

NOT AN OFFICIAL MINECRAFT PRODUCT. NOT APPROVED BY OR ASSOCIATED WITH MOJANG.