Metadata-Version: 2.1
Name: sphinx-minecraft
Version: 1.0.5
Summary: Add different Minecraft-oriented components to Sphinx.
Author-Email: theogiraudet <theo.giraudet@altearn.xyz>, Aksiome <maxime.calmon@altearn.xyz>
License: MPL-2.0
Classifier: Intended Audience :: Developers
Classifier: Framework :: Sphinx :: Extension
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Programming Language :: Python :: 3.11
Project-URL: Repository, https://github.com/Gunivers/Sphinx-Minecraft/tree/main
Project-URL: Issues, https://github.com/Gunivers/Sphinx-Minecraft/issues
Requires-Python: >=3.11
Requires-Dist: sphinx
Requires-Dist: sphinx-treeview==1.1.1
Provides-Extra: docs
Requires-Dist: myst-parser; extra == "docs"
Requires-Dist: furo; extra == "docs"
Description-Content-Type: text/markdown

# Sphinx Minecraft

<!-- start-include-here -->

Add different Minecraft-oriented components to Sphinx.

## Installation

```bash
pip install sphinx-minecraft
```

Add the extension to your Sphinx `conf.py`:

```python
extensions = [
    'sphinx_minecraft'
]
```

<!-- end-include-here -->

## Available components

### Tree views

These components are based on [sphinx-treeview](https://github.com/Altearn/Sphinx-Tree-View).

#### Minecraft directory tree
**Usage:**
```rst
:::{treeview}
- {mcdir}`folder` folder
  - {mcdir}`mcfunction` function.mcfunction
  - {mcdir}`mcmeta` pack.mcmeta
  - {mcdir}`nbt` structure.nbt
- {mcdir}`folder` folder2
  - {mcdir}`file` file.txt
  - {mcdir}`audio` sound.ogg
  - {mcdir}`image` texture.png
  - {mcdir}`json` advancement.json
  - {mcdir}`yml` config.yml
:::
```
**Result:**

![Minecraft directory tree](https://raw.githubusercontent.com/Gunivers/Sphinx-Minecraft/main/docs/_static/mcdir.png)

#### NBT tree
**Usage:**
```rst
:::{treeview}
- {nbt}`compound` A compound tag
  - {nbt}`bool` A boolean tag
  - {nbt}`byte` A byte tag
  - {nbt}`short` A short tag
  - {nbt}`int` An integer tag
  - {nbt}`long` A long tag
  - {nbt}`float` A float tag
  - {nbt}`double` A double tag
  - {nbt}`string` A string tag
  - {nbt}`list` A list tag
  - {nbt}`number` A number tag
  - {nbt}`any` A tag to represent any type
- {nbt}`compound` A compound tag
  - {nbt}`long-array` A long array tag
  - {nbt}`byte-array` A byte array tag
  - {nbt}`int-array` An integer array tag
:::
```
**Result:**

![Minecraft NBT tree](https://raw.githubusercontent.com/Gunivers/Sphinx-Minecraft/main/docs/_static/nbt.png)

# License

This project is licensed under the MPL-2.0 License. See the [LICENSE](LICENSE) file for details.
File and folder icons came from [pictogrammers](https://pictogrammers.com/library/mdi/) and are under [Apache-2.0 License](https://pictogrammers.com/docs/general/license/).
Other icons of the Minecraft directory tree view are from [Material Icon Theme](https://github.com/material-extensions/vscode-material-icon-theme) and are under [MIT License](https://github.com/material-extensions/vscode-material-icon-theme/blob/main/LICENSE).
