Metadata-Version: 2.1
Name: minecraft-render
Version: 2.0.0a3
Summary: Minecraft block/texture rendering with node.js and Python via JSPyBridge.
Author-email: object-Object <object@objectobject.ca>, co3moz <doganderya59@gmail.com>
License: MIT License
        
        Copyright (c) 2023 object-Object <object@objectobject.ca>, co3moz <doganderya59@gmail.com>
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE.md
Requires-Python: >=3.11
Requires-Dist: importlib-resources~=6.0
Requires-Dist: javascript~=1!1.0
Provides-Extra: dev
Requires-Dist: black==23.7.0; extra == 'dev'
Requires-Dist: hatch; extra == 'dev'
Requires-Dist: isort==5.12.0; extra == 'dev'
Description-Content-Type: text/markdown

[![Rendered image](https://raw.githubusercontent.com/co3moz/minecraft-render/master/docs/soul_campfire_small.png)](https://github.com/co3moz/minecraft-render/blob/master/docs/soul_campfire.png)

minecraft-render
=======================

TODO: Update docs for minecraft-render-py.


Renders minecraft block models using `THREE.js`. 
Default output format is PNG `1000x1000`.


### Pre-rendered assets

You can find pre-rendered assets on Github Actions artifacts. By clicking the badge down below, you can access action list.

[![Render Test](https://github.com/co3moz/minecraft-render/actions/workflows/ci.yml/badge.svg)](https://github.com/co3moz/minecraft-render/actions/workflows/ci.yml)


### Headless render and CI

If you are automating generation process on github or similar CI environments, make sure you configured display server. `xvfb` can be used for this purpose.

```sh
sudo apt-get install xvfb
xvfb-run --auto-servernum minecraft-render ...
```


### Notes

<https://minecraft.fandom.com/wiki/Tutorials/Models#Block_states>

- Rework system
- Detach Jar from data reading (interface to provide info, allow for directory sources, or prioritized stacks)
- Incorporate blockstates to configure properly
- Rotate as needed (see: stairs etc)
