textureminer 4.0.0

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

textureminer

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

Table of Contents

• Table of Contents
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Supported Versions

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.