| Name | textureminer JSON |
| Version |
4.1.0
JSON |
| download |
| home_page | None |
| Summary | Library and CLI program to extract and scale Minecraft item and block textures. |
| upload_time | 2024-10-28 13:56:21 |
| maintainer | None |
| docs_url | None |
| author | 4MBL |
| requires_python | >=3.12 |
| license | MIT License Copyright (c) 2023 4MBL 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. |
| keywords |
cli
minecraft
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# [textureminer](https://4mbl.link/gh/textureminer)
> Library and CLI program to extract and scale Minecraft item and block textures.
## Table of Contents
* [Table of Contents](#table-of-contents)
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Installation](#installation)
* [Usage](#usage)
* [Supported Versions](#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](https://git-scm.com/download/) from the official website.
Install if you plan on using the Bedrock edition.
Either download the [installer](https://git-scm.com/download/) from the official website or use a package manager like [winget](https://learn.microsoft.com/en-us/windows/package-manager/winget/#install-winget).
```sh
winget install Git.Git
```
Install Python, the latest version is recommended.
<https://www.python.org/downloads/>
Install/update the [pip](https://pip.pypa.io/en/stable/) package manager.
```sh
python3 -m pip install --upgrade pip
```
### Installation
Use pip to install [`textureminer`](https://pypi.org/project/textureminer) package.
```sh
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.
```sh
textureminer
```
Add `--bedrock` or `-b` to use the Bedrock edition.
```sh
textureminer --bedrock
```
You can also pick a specific update or update channel of Minecraft to download textures for.
```sh
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.
```sh
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](https://github.com/4mbl/textureminer/issues).
Currently Python 3.12 and 3.13 are supported.
Raw data
{
"_id": null,
"home_page": null,
"name": "textureminer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "cli, minecraft",
"author": "4MBL",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/38/02/03a19fbfbec7853b029def37a909b08d7d11036ff64b299fd0ca07ff69d7/textureminer-4.1.0.tar.gz",
"platform": null,
"description": "# [textureminer](https://4mbl.link/gh/textureminer)\n\n> Library and CLI program to extract and scale Minecraft item and block textures.\n\n## Table of Contents\n\n* [Table of Contents](#table-of-contents)\n* [Getting Started](#getting-started)\n * [Prerequisites](#prerequisites)\n * [Installation](#installation)\n* [Usage](#usage)\n* [Supported Versions](#supported-versions)\n\n## Getting Started\n\n### Prerequisites\n\nYou need to have Git installed if you plan on using the Bedrock edition.\n\nGit can be installed using your system's package manager, or by downloading the [installer](https://git-scm.com/download/) from the official website.\n\nInstall if you plan on using the Bedrock edition.\nEither download the [installer](https://git-scm.com/download/) from the official website or use a package manager like [winget](https://learn.microsoft.com/en-us/windows/package-manager/winget/#install-winget).\n\n```sh\nwinget install Git.Git\n```\n\nInstall Python, the latest version is recommended.\n\n<https://www.python.org/downloads/>\n\nInstall/update the [pip](https://pip.pypa.io/en/stable/) package manager.\n\n```sh\npython3 -m pip install --upgrade pip\n```\n\n### Installation\n\nUse pip to install [`textureminer`](https://pypi.org/project/textureminer) package.\n\n```sh\npip install --upgrade textureminer\n```\n\nAfter installing the package, `textureminer` will be available as a command line tool.\n\n## Usage\n\nThe 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.\n\nTo download and scale textures for the most recent Java version, run the following command.\n\n```sh\ntextureminer\n```\n\nAdd `--bedrock` or `-b` to use the Bedrock edition.\n\n```sh\ntextureminer --bedrock\n```\n\nYou can also pick a specific update or update channel of Minecraft to download textures for.\n\n```sh\ntextureminer 1.17.1 # a java stable release\ntextureminer 22w14a # a java snapshot\ntextureminer v1.20.0.1 # a bedrock release\ntextureminer v1.20.50.22-preview # a bedrock preview\n\n# update channels, gets latest version from channel\n# by default using java edition if no edition is specified\n\ntextureminer stable # stable version\ntextureminer experimental # snapshot/preview version depending on edition\ntextureminer snapshot # java snapshot\ntextureminer preview # bedrock preview, no need to specify edition\n\n```\n\nThere is also some options to customize how textureminer works, use the help flag to get more information.\n\n```sh\ntextureminer --help\n```\n\n## Supported Versions\n\nCurrently `textureminer` is tested against the following versions of Minecraft:\n\n* Java\n * 1.16\n * 1.17\n * 1.18\n * 1.19\n * 1.20\n * 1.21\n* Bedrock\n * v1.21.0.3 (first version of the 1.21 release)\n\nOther 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](https://github.com/4mbl/textureminer/issues).\n\nCurrently Python 3.12 and 3.13 are supported.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 4MBL 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.",
"summary": "Library and CLI program to extract and scale Minecraft item and block textures.",
"version": "4.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/4mbl/textureminer/issues",
"Changelog": "https://github.com/4mbl/textureminer/blob/main/CHANGELOG.md",
"Documentation": "https://github.com/4mbl/textureminer/blob/main/README.md",
"Home": "https://github.com/4mbl/textureminer",
"Repository": "https://github.com/4mbl/textureminer"
},
"split_keywords": [
"cli",
" minecraft"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d3287518b3e85e8042596c435c711214b701896b4454b370b33be5f7c6d50ae4",
"md5": "053d7765297b83f9fae9ec6878b8a78f",
"sha256": "bb7d4db10d9eed155c629542ac35f8c6913098c97d343615dc3527a222aacbcd"
},
"downloads": -1,
"filename": "textureminer-4.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "053d7765297b83f9fae9ec6878b8a78f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 25516,
"upload_time": "2024-10-28T13:56:20",
"upload_time_iso_8601": "2024-10-28T13:56:20.110771Z",
"url": "https://files.pythonhosted.org/packages/d3/28/7518b3e85e8042596c435c711214b701896b4454b370b33be5f7c6d50ae4/textureminer-4.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "380203a19fbfbec7853b029def37a909b08d7d11036ff64b299fd0ca07ff69d7",
"md5": "416396fbbceb7b40a6a12ef23765e5cb",
"sha256": "57671a2d28b7aeee43666ceb9a95f55dddd8f36667adb9b42f5ac5ed3447d279"
},
"downloads": -1,
"filename": "textureminer-4.1.0.tar.gz",
"has_sig": false,
"md5_digest": "416396fbbceb7b40a6a12ef23765e5cb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 26262,
"upload_time": "2024-10-28T13:56:21",
"upload_time_iso_8601": "2024-10-28T13:56:21.756348Z",
"url": "https://files.pythonhosted.org/packages/38/02/03a19fbfbec7853b029def37a909b08d7d11036ff64b299fd0ca07ff69d7/textureminer-4.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-28 13:56:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "4mbl",
"github_project": "textureminer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "textureminer"
}
