Support for Biomes & Everything 1.18

.github/workflows/run-pytest.yml

@@ -24,7 +24,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install pytest
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        if [ -f tests/requirements.txt ]; then pip install -r tests/requirements.txt; fi
     - name: Test with pytest
       run: |
         pytest

.gitignore

@@ -7,3 +7,4 @@ build/
 .vscode/
 docs/_build/
 examples/test_112.py
+venv

.readthedocs.yml

@@ -7,4 +7,4 @@ python:
     version: 3.7
     install:
         - requirements: docs/requirements.txt
-        - requirements: requirements.txt
+        - requirements: tests/requirements.txt

MANIFEST.in

@@ -1 +1,2 @@
-include anvil/legacy_blocks.json
+include anvil/legacy_blocks.json
+include anvil/legacy_biomes.json

README.md

@@ -1,20 +1,14 @@
-# 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)
+# anvil-parser2
 [![Documentation Status](https://readthedocs.org/projects/anvil-parser/badge/?version=latest)](https://anvil-parser.readthedocs.io/en/latest/?badge=latest)
-[![Tests](https://github.com/matcool/anvil-parser/actions/workflows/run-pytest.yml/badge.svg)](https://github.com/matcool/anvil-parser/actions/workflows/run-pytest.yml)
-[![PyPI - Downloads](https://img.shields.io/pypi/dm/anvil-parser)](https://pypi.org/project/anvil-parser/)
+[![Tests](https://github.com/0xTiger/anvil-parser/actions/workflows/run-pytest.yml/badge.svg)](https://github.com/0xTiger/anvil-parser/actions/workflows/run-pytest.yml)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/anvil-parser)](https://pypi.org/project/anvil-parser2/)
 
-Simple parser for the [Minecraft anvil file format](https://minecraft.gamepedia.com/Anvil_file_format)
+A parser for the [Minecraft anvil file format](https://minecraft.wiki/w/Anvil_file_format). This package was forked from [matcool's anvil-parser](https://github.com/matcool/anvil-parser) in order to additionally support minecraft versions 1.18 and above.
 # 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
+pip install anvil-parser2
 ```
+
 # Usage
 ## Reading
 ```python
@@ -57,9 +51,10 @@ region.save('r.0.0.mca')
 # Todo
 *things to do before 1.0.0*
 - [x] Proper documentation
-- [ ] Biomes
+- [x] 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.
+Testing done in 1.14.4 - 1.19, should work fine for other versions. 
+Writing chunks and regions is broken from 1.16 onwards

anvil/__init__.py

@@ -1,5 +1,6 @@
 from .chunk import Chunk
 from .block import Block, OldBlock
+from .biome import Biome
 from .region import Region
 from .empty_region import EmptyRegion
 from .empty_chunk import EmptyChunk

anvil/biome.py

@@ -0,0 +1,75 @@
+from .legacy import LEGACY_BIOMES_ID_MAP
+
+class Biome:
+    """
+    Represents a minecraft biome.
+
+    Attributes
+    ----------
+    namespace: :class:`str`
+        Namespace of the biome, most of the time this is ``minecraft``
+    id: :class:`str`
+        ID of the biome, for example: forest, warm_ocean, etc...
+    """
+    __slots__ = ('namespace', 'id')
+
+    def __init__(self, namespace: str, biome_id: str=None):
+        """
+        Parameters
+        ----------
+        namespace
+            Namespace of the biome. If no biome_id is given, assume this is ``biome_id`` and set namespace to ``"minecraft"``
+        biome_id
+            ID of the biome
+        """
+        if biome_id is None:
+            self.namespace = 'minecraft'
+            self.id = namespace
+        else:
+            self.namespace = namespace
+            self.id = biome_id
+
+    def name(self) -> str:
+        """
+        Returns the biome in the ``minecraft:biome_id`` format
+        """
+        return self.namespace + ':' + self.id
+
+    def __repr__(self):
+        return f'Biome({self.name()})'
+
+    def __eq__(self, other):
+        if not isinstance(other, Biome):
+            return False
+        return self.namespace == other.namespace and self.id == other.id
+
+    def __hash__(self):
+        return hash(self.name())
+
+    @classmethod
+    def from_name(cls, name: str):
+        """
+        Creates a new Biome from the format: ``namespace:biome_id``
+
+        Parameters
+        ----------
+        name
+            Biome in said format
+        """
+        namespace, biome_id = name.split(':')
+        return cls(namespace, biome_id)
+
+    @classmethod
+    def from_numeric_id(cls, biome_id: int):
+        """
+        Creates a new Biome from the numeric biome_id format
+
+        Parameters
+        ----------
+        biome_id
+            Numeric ID of the biome
+        """
+        if biome_id not in LEGACY_BIOMES_ID_MAP:
+            raise KeyError(f'Biome {biome_id} not found')
+        name = LEGACY_BIOMES_ID_MAP[biome_id]
+        return cls('minecraft', name)

anvil/block.py

@@ -79,9 +79,7 @@ def from_palette(cls, tag: nbt.TAG_Compound):
             Raw tag from a section's palette
         """
         name = tag['Name'].value
-        properties = tag.get('Properties')
-        if properties:
-            properties = dict(properties)
+        properties = dict(tag.get('Properties', dict()))
         return cls.from_name(name, properties=properties)
 
     @classmethod
@@ -96,14 +94,15 @@ def from_numeric_id(cls, block_id: int, data: int=0):
         data
             Numeric data, used to represent variants of the block
         """
-        # See https://minecraft.gamepedia.com/Java_Edition_data_value/Pre-flattening
-        # and https://minecraft.gamepedia.com/Java_Edition_data_value for current values
+        # See https://minecraft.wiki/w/Java_Edition_data_value/Pre-flattening
+        # and https://minecraft.wiki/w/Java_Edition_data_value for current values
         key = f'{block_id}:{data}'
         if key not in LEGACY_ID_MAP:
             raise KeyError(f'Block {key} not found')
         name, properties = LEGACY_ID_MAP[key]
         return cls('minecraft', name, properties=properties)
 
+
 class OldBlock:
     """
     Represents a pre 1.13 minecraft block, with a numeric id.