Skip to main content

Professional Minecraft Inventory Rendering and Asset Mirroring library

Project description

🎒 Exo-Inventory

PyPI version License: MIT Python versions

A powerful, high-performance Minecraft inventory rendering library for Python.

exo-inventory is a professional-grade library designed to fetch, mirror, and render Minecraft item icons and player inventories with 100% customizability. Whether you need a standard player inventory or a completely custom 9x6 chest layout, exo-inventory handles the assets and coordinates for you.


✨ Features

  • 🔄 Smart Asset Mirroring: Local mirror of Jemsire's Minecraft icons with automatic version detection (1.13.2 to 1.21.10+).
  • 🖼️ Flexible Rendering Engine: Support for arbitrary item placement (render_custom) or standard Minecraft layouts (render_player).
  • 🤖 Automated Maintenance: Integrated GitHub Actions workflow to sync assets and rebuild metadata daily.
  • 🎨 UI Assets Bundled: Core assets (backgrounds, empty slot icons) come pre-installed in the package.
  • 👤 Player Models: Automatic integration with mc-heads.net for rendering 3D player skins.
  • High Performance: Path caching, recursive item lookup, and asynchronous asset fetching.

🖼️ Visual Previews

Standard Inventory Custom Transparent Grid
Standard Custom

🚀 Installation

Install the library directly from PyPI (Recommended):

pip install exo-inventory

Or from the source:

pip install git+https://github.com/zKauaFerreira/Exo-Lib.git

Note: The library already comes with 1400+ Minecraft icons and UI assets bundled in the package. You can start rendering immediately after installation!


⚡ Quick Start (Plug & Play)

1. Minimalistic Rendering

Since assets are bundled, you can render an inventory in seconds!

import asyncio
from exo_inventory import InventoryRenderer

async def main():
    # Initializing with built-in assets
    renderer = InventoryRenderer()
    await renderer.initialize()

    player_data = {
        "uuid": "caf29aa7-b3f6-494f-b44f-66cdd3fb9a42",
        "armor": [{"id": "diamond_helmet", "slot": 39}],
        "hotbar": [{"id": "netherite_sword", "slot": 0}],
        "main_inventory": [],
        "off_hand": {"id": "shield"}
    }

    render = await renderer.render_player(player_data)
    # The 'render' object is a PIL Image
    render.save("inventory.png")

    await renderer.close()

asyncio.run(main())

📂 Examples Folder

We provided a dedicated examples/ directory in our repository to help you get started with common use cases.

  • standard_inventory.py: Demonstrates standard player inventory rendering.
  • custom_grid.py: Shows how to create custom grids with transparent backgrounds.
  • manage_assets.py: Advanced usage: how to sync assets to a custom external folder.

🛠️ Advanced Usage

🎨 Customizing Asset Locations

If you want to manage your icons in a specific shared folder across multiple projects:

# Pass a path to use an external cache
renderer = InventoryRenderer(assets_dir="./shared_assets")

🧩 Custom Layouts

# background=None generates a transparent PNG
image = await renderer.render_custom(
    items_map=[{"id": "apple", "x": 10, "y": 10}],
    width=100,
    height=100,
    background=None
)

📦 Asset Utilities & Exporting

Need the icons for something else? Export assets from the internal cache to any directory.

from exo_inventory import AssetsManager
assets = AssetsManager()
await assets.initialize()

await assets.export_assets(
    target_dir="./my_resource_pack",
    items_list=["diamond", "netherite_sword"],
    include_ui=True
)

👤 Advanced Player Rendering

Customizing the player model render (poses/angles).

# Get a 3D body render with a 45-degree rotation
body_img = await renderer.get_player_render(
    uuid="zKauaFerreira",
    render_type="body", # options: 'body', 'head', 'avatar', 'player'
    size=400,
    angle=45
)

🛰️ Remote Asset Synchronization

The library pulls UI themes and metadata from the official repository:

Asset Source
inventory_bg.png zKauaFerreira/Exo-Lib/main/src/exo_inventory/data
jemsire_index.json Remote metadata mirror (daily updated)
empty_armor_slots Exo-Lib official UI assets

🤖 Automation (CI/CD)

The library includes a pre-configured GitHub Action (.github/workflows/update_assets.yml) that:

  1. Runs every day at midnight.
  2. Checks Jemsire for new Minecraft versions.
  3. Downloads new ZIPs and extracts them recursively.
  4. Generates a new jemsire_index.json.
  5. Commits changes back to your repository automatically.

📂 Project Structure

exo-inventory/
├── src/
│   └── exo_inventory/
│       ├── __init__.py    # Main exports
│       ├── assets.py      # Jemsire & Remote Sync logic
│       └── renderer.py    # Pillow-based rendering engine
├── pyproject.toml         # Build & Dependency config
└── README.md              # You are here

🛠️ Requirements

  • Python 3.10+
  • Pillow: For image processing.
  • aiohttp: For asynchronous asset downloads.
  • discord.py: Compatible for bot integrations.

🖥️ CLI Commands

exo-inventory provides built-in CLI commands for easy maintenance and asset extraction.

# Sync all assets to the library's internal storage
python -m exo_inventory.assets sync

# Export all icons AND UI elements to your current project folder
python -m exo_inventory.assets export ./assets

📜 License & Acknowledgments


Maintained with ❤️ for the Minecraft Discord community.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

exo_inventory-0.1.13.tar.gz (8.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

exo_inventory-0.1.13-py3-none-any.whl (8.7 MB view details)

Uploaded Python 3

File details

Details for the file exo_inventory-0.1.13.tar.gz.

File metadata

  • Download URL: exo_inventory-0.1.13.tar.gz
  • Upload date:
  • Size: 8.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for exo_inventory-0.1.13.tar.gz
Algorithm Hash digest
SHA256 86774e0871736e366a4ccc001e7a31a5242b0b137d19b4c0bb07015d92701672
MD5 1cc9d791b3a6939cb676924bed601653
BLAKE2b-256 6adf3938e99ecf75968984fbe4568805cb52b5fe2ca0897f7d80fe2da880029c

See more details on using hashes here.

Provenance

The following attestation bundles were made for exo_inventory-0.1.13.tar.gz:

Publisher: publish.yml on zKauaFerreira/Exo-Lib

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file exo_inventory-0.1.13-py3-none-any.whl.

File metadata

  • Download URL: exo_inventory-0.1.13-py3-none-any.whl
  • Upload date:
  • Size: 8.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for exo_inventory-0.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 28b53d2896ef78c5d829319efe9ba5ecd358a26bf950e3b096715a3291c6e6d2
MD5 e94a15bdca39ec2fb2abb4af29f0f64d
BLAKE2b-256 70e8e14c5b3c489f927c609b2ae03d93689b7df40f3d94b0d114e5d4653821a2

See more details on using hashes here.

Provenance

The following attestation bundles were made for exo_inventory-0.1.13-py3-none-any.whl:

Publisher: publish.yml on zKauaFerreira/Exo-Lib

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page