mcstructure

Name	mcstructure JSON
Version	0.0.1b5 JSON
	download
home_page
Summary	Read and write Minecraft .mcstructure files.
upload_time	2023-07-05 21:46:19
maintainer
docs_url	None
author
requires_python	>=3.8
license	MIT
keywords	mcstructure minecraft
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            <p align="center">
  <img
    src="https://raw.githubusercontent.com/phoenixr-codes/mcstructure/main/logo.png"
    width="120px"
    align="center" alt="mcstructure logo"
  />
  <h1 align="center">mcstructure</h1>
  <p align="center">
    Read and write Minecraft <code>.mcstructure</code> files.
  </p>
</p>

🌍 This README is also available in the following
languages:

* [🇨🇳 Chinese](./README_CN.md)
* [🇩🇪 German](./README_DE.md)

<!-- Not really accessible ♿️ but we get a better line
than the default "<hr/>" or "---" --> 
<h2></h2>

[![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge)](https://github.com/psf/black)
[![Documentation Status](https://readthedocs.org/projects/mcstructure/badge/?style=for-the-badge&version=latest)](https://mcstructure.readthedocs.io/en/latest/?badge=latest)
[![PyPI](https://img.shields.io/pypi/v/mcstructure?style=for-the-badge)](https://pypi.org/project/mcstructure)

_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 "Bedrock Edition"._

_Features that this library provide are only
useful for the above named edition of Minecraft._

> **Warning**
> This project is currently in the **BETA** version. Some
> features may not work as expected.

<!-- start elevator-pitch -->

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.

<!-- end elevator-pitch -->

Installation
------------

```bash
pip install mcstructure
```


Basic Usage
-----------

```python
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)
```

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


Useful Links
------------

* [👋 Introduction to Structure Blocks](https://learn.microsoft.com/en-us/minecraft/creator/documents/introductiontostructureblocks)
* [📖 Bedrock Wiki](https://wiki.bedrock.dev/nbt/mcstructure.html#file-format)
* [📖 Documentation](https://mcstructure.readthedocs.io/en/latest/)
* [📁 Source Code](https://github.com/phoenixr-codes/mcstructure)
* [🐍 PyPI](https://pypi.org/project/mcstructure/)

--------------------------------------------

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

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "mcstructure",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "mcstructure,Minecraft",
    "author": "",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/4c/f8/78707f8d39a0e6f115a552179bf22b1f73b0222842322c3e22cec67e0968/mcstructure-0.0.1b5.tar.gz",
    "platform": null,
    "description": "<p align=\"center\">\n  <img\n    src=\"https://raw.githubusercontent.com/phoenixr-codes/mcstructure/main/logo.png\"\n    width=\"120px\"\n    align=\"center\" alt=\"mcstructure logo\"\n  />\n  <h1 align=\"center\">mcstructure</h1>\n  <p align=\"center\">\n    Read and write Minecraft <code>.mcstructure</code> files.\n  </p>\n</p>\n\n\ud83c\udf0d This README is also available in the following\nlanguages:\n\n* [\ud83c\udde8\ud83c\uddf3 Chinese](./README_CN.md)\n* [\ud83c\udde9\ud83c\uddea German](./README_DE.md)\n\n<!-- Not really accessible \u267f\ufe0f but we get a better line\nthan the default \"<hr/>\" or \"---\" --> \n<h2></h2>\n\n[![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge)](https://github.com/psf/black)\n[![Documentation Status](https://readthedocs.org/projects/mcstructure/badge/?style=for-the-badge&version=latest)](https://mcstructure.readthedocs.io/en/latest/?badge=latest)\n[![PyPI](https://img.shields.io/pypi/v/mcstructure?style=for-the-badge)](https://pypi.org/project/mcstructure)\n\n_In the entire project (and officially since \nthe \"Better Together Update\") the term\n\"Minecraft\" refers to the edition of Minecraft\nthat is also known as \"Bedrock Edition\"._\n\n_Features that this library provide are only\nuseful for the above named edition of Minecraft._\n\n> **Warning**\n> This project is currently in the **BETA** version. Some\n> features may not work as expected.\n\n<!-- start elevator-pitch -->\n\nThis library lets you programmatically create\nand edit Minecraft structures. You are able to\nsave these as ``.mcstructure`` files and for\nexample use them in behavior packs.\n\nYou may as well read them to identify blocks and\nand entities that were saved with a Structure\nBlock in-game.\n\n<!-- end elevator-pitch -->\n\nInstallation\n------------\n\n```bash\npip install mcstructure\n```\n\n\nBasic Usage\n-----------\n\n```python\nfrom mcstructure import Block, Structure\n\nstruct = Structure(\n    (7, 7, 7),\n    Block(\"minecraft:wool\", color = \"red\")\n)\n\n(struct\n    .set_block((1, 1, 1), Block(\"minecraft:grass\"))\n    .set_block((2, 2, 2), Block(\"minecraft:grass\"))\n    .set_block((3, 3, 3), Block(\"minecraft:grass\"))\n    .set_block((4, 4, 4), Block(\"minecraft:grass\"))\n    .set_block((5, 5, 5), Block(\"minecraft:grass\"))\n    .set_block((6, 6, 6), Block(\"minecraft:grass\"))\n)\n\nwith open(\"house.mcstructure\", \"wb\") as f:\n    struct.dump(f)\n```\n\n```python\nwith open(\"house.mcstructure\", \"rb\") as f:\n    struct = Structure.load(f)\n```\n\n\nUseful Links\n------------\n\n* [\ud83d\udc4b Introduction to Structure Blocks](https://learn.microsoft.com/en-us/minecraft/creator/documents/introductiontostructureblocks)\n* [\ud83d\udcd6 Bedrock Wiki](https://wiki.bedrock.dev/nbt/mcstructure.html#file-format)\n* [\ud83d\udcd6 Documentation](https://mcstructure.readthedocs.io/en/latest/)\n* [\ud83d\udcc1 Source Code](https://github.com/phoenixr-codes/mcstructure)\n* [\ud83d\udc0d PyPI](https://pypi.org/project/mcstructure/)\n\n--------------------------------------------\n\nNOT AN OFFICIAL MINECRAFT PRODUCT.\nNOT APPROVED BY OR ASSOCIATED WITH MOJANG.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Read and write Minecraft .mcstructure files.",
    "version": "0.0.1b5",
    "project_urls": {
        "Documentation": "https://mcstructure.readthedocs.io/en/latest/",
        "Source Code": "https://github.com/phoenixr-codes/mcstructure/"
    },
    "split_keywords": [
        "mcstructure",
        "minecraft"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a1e3bc66082a9a9b88e0bfc81ad56371988d2ec2938f02f2606a1d744d436ecc",
                "md5": "c4b1535f5e0ad517225009ed9ef93a2a",
                "sha256": "8356a96d4127f2d5b0005232c256f202b41b27fa29c25751e037acf04fe15bd1"
            },
            "downloads": -1,
            "filename": "mcstructure-0.0.1b5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c4b1535f5e0ad517225009ed9ef93a2a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 7787,
            "upload_time": "2023-07-05T21:46:17",
            "upload_time_iso_8601": "2023-07-05T21:46:17.193239Z",
            "url": "https://files.pythonhosted.org/packages/a1/e3/bc66082a9a9b88e0bfc81ad56371988d2ec2938f02f2606a1d744d436ecc/mcstructure-0.0.1b5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4cf878707f8d39a0e6f115a552179bf22b1f73b0222842322c3e22cec67e0968",
                "md5": "49a78a79a8f69f1cd3ba504a2bbd02f0",
                "sha256": "fdcb728b9d7fc61b649c182cb4fcadc345c4dcc628b68a8fffeaf13881654979"
            },
            "downloads": -1,
            "filename": "mcstructure-0.0.1b5.tar.gz",
            "has_sig": false,
            "md5_digest": "49a78a79a8f69f1cd3ba504a2bbd02f0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 28141,
            "upload_time": "2023-07-05T21:46:19",
            "upload_time_iso_8601": "2023-07-05T21:46:19.049181Z",
            "url": "https://files.pythonhosted.org/packages/4c/f8/78707f8d39a0e6f115a552179bf22b1f73b0222842322c3e22cec67e0968/mcstructure-0.0.1b5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-05 21:46:19",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "phoenixr-codes",
    "github_project": "mcstructure",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mcstructure"
}