Skip to main content

Library and CLI program to extract and scale Minecraft item and block textures.

Project description

textureminer

Library and CLI program to extract and scale Minecraft item and block textures.

Table of Contents

Getting Started

Prerequisites

You need to have Git installed if you plan on using the Bedrock edition.

Git can be installed using your system's package manager, or by downloading the installer from the official website.

Install if you plan on using the Bedrock edition. Either download the installer from the official website or use a package manager like winget.

winget install Git.Git

Install Python, the latest version is recommended.

https://www.python.org/downloads/

Install/update the pip package manager.

python3 -m pip install --upgrade pip

Installation

Use pip to install textureminer package.

pip install --upgrade textureminer

After installing the package, textureminer will be available as a command line tool.

Usage

The base syntax for textureminer is textureminer [version] [flags]. If version is omitted, the latest version of Minecraft will be used. If no edition flags are specified, the Java edition will be used.

To download and scale textures for the most recent Java version, run the following command.

textureminer

Add --bedrock or -b to use the Bedrock edition.

textureminer --bedrock

You can also pick a specific update or update channel of Minecraft to download textures for.

textureminer 1.17.1 # a java stable release
textureminer 22w14a # a java snapshot
textureminer v1.20.0.1 # a bedrock release
textureminer v1.20.50.22-preview # a bedrock preview

# update channels, gets latest version from channel
# by default using java edition if no edition is specified

textureminer stable # stable version
textureminer experimental # snapshot/preview version depending on edition
textureminer snapshot # java snapshot
textureminer preview # bedrock preview, no need to specify edition

There is also some options to customize how textureminer works, use the help flag to get more information.

textureminer --help

Supported Versions

Currently textureminer is tested against the following versions of Minecraft:

  • Java
    • 1.16
    • 1.17
    • 1.18
    • 1.19
    • 1.20
    • 1.21
  • Bedrock
    • v1.21.0.3 (first version of the 1.21 release)

Other versions are likely to work, but are not tested against every release of textureminer. If you find a version that doesn't work, please open an issue on the GitHub repository.

Currently Python 3.12 and 3.13 are supported.

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

textureminer-4.1.0.tar.gz (26.3 kB view details)

Uploaded Source

Built Distribution

textureminer-4.1.0-py3-none-any.whl (25.5 kB view details)

Uploaded Python 3

File details

Details for the file textureminer-4.1.0.tar.gz.

File metadata

  • Download URL: textureminer-4.1.0.tar.gz
  • Upload date:
  • Size: 26.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.13.0

File hashes

Hashes for textureminer-4.1.0.tar.gz
Algorithm Hash digest
SHA256 57671a2d28b7aeee43666ceb9a95f55dddd8f36667adb9b42f5ac5ed3447d279
MD5 416396fbbceb7b40a6a12ef23765e5cb
BLAKE2b-256 380203a19fbfbec7853b029def37a909b08d7d11036ff64b299fd0ca07ff69d7

See more details on using hashes here.

File details

Details for the file textureminer-4.1.0-py3-none-any.whl.

File metadata

  • Download URL: textureminer-4.1.0-py3-none-any.whl
  • Upload date:
  • Size: 25.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.13.0

File hashes

Hashes for textureminer-4.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bb7d4db10d9eed155c629542ac35f8c6913098c97d343615dc3527a222aacbcd
MD5 053d7765297b83f9fae9ec6878b8a78f
BLAKE2b-256 d3287518b3e85e8042596c435c711214b701896b4454b370b33be5f7c6d50ae4

See more details on using hashes here.

Supported by

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