Metadata-Version: 2.1
Name: anvil-parser
Version: 0.8.2
Summary: A Minecraft anvil file format parser
Home-page: https://github.com/matcool/anvil-parser
Author: mat
License: UNKNOWN
Description: # anvil-parser [![CodeFactor](https://www.codefactor.io/repository/github/matcool/anvil-parser/badge/master)](https://www.codefactor.io/repository/github/matcool/anvil-parser/overview/master) [![Documentation Status](https://readthedocs.org/projects/anvil-parser/badge/?version=latest)](https://anvil-parser.readthedocs.io/en/latest/?badge=latest) [![Build Status](https://travis-ci.org/matcool/anvil-parser.svg?branch=master)](https://travis-ci.org/matcool/anvil-parser)
        Simple parser for the [Minecraft anvil file format](https://minecraft.gamepedia.com/Anvil_file_format)
        # Installation
        This project is available on [PyPI](https://pypi.org/project/anvil-parser/) and can be installed with pip
        ```
        pip install anvil-parser
        ```
        or directly from github
        ```
        pip install git+https://github.com/matcool/anvil-parser.git
        ```
        # Usage
        ## Reading
        ```python
        import anvil
        
        region = anvil.Region.from_file('r.0.0.mca')
        
        # You can also provide the region file name instead of the object
        chunk = anvil.Chunk.from_region(region, 0, 0)
        
        # If `section` is not provided, will get it from the y coords
        # and assume it's global
        block = chunk.get_block(0, 0, 0)
        
        print(block) # <Block(minecraft:air)>
        print(block.id) # air
        print(block.properties) # {}
        ```
        ## Making own regions
        ```python
        import anvil
        from random import choice
        
        # Create a new region with the `EmptyRegion` class at 0, 0 (in region coords)
        region = anvil.EmptyRegion(0, 0)
        
        # Create `Block` objects that are used to set blocks
        stone = anvil.Block('minecraft', 'stone')
        dirt = anvil.Block('minecraft', 'dirt')
        
        # Make a 16x16x16 cube of either stone or dirt blocks
        for y in range(16):
            for z in range(16):
                for x in range(16):
                    region.set_block(choice((stone, dirt)), x, y, z)
        
        # Save to a file
        region.save('r.0.0.mca')
        ```
        # Todo
        *things to do before 1.0.0*
        - [x] Proper documentation
        - [ ] Biomes
        - [x] CI
        - [ ] More tests
          - [ ] Tests for 20w17a+ BlockStates format
        # Note
        Testing done in 1.14.4 and 1.15.2, should work fine for other versions.
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
