| Name | textureminer JSON |
| Version |
2.0.2
JSON |
| download |
| home_page | |
| Summary | Script that allows you to extract and scale Minecraft's item and block textures. |
| upload_time | 2024-01-24 20:27:24 |
| maintainer | |
| docs_url | None |
| author | 4MBL |
| requires_python | >=3.11 |
| 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)
A Python script that allows you to extract and scale Minecraft's item and block textures. It automates the process of downloading the necessary files and performing the required operations.
## Table of Contents
* [Table of Contents](#table-of-contents)
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Installation](#installation)
* [Usage](#usage)
## Getting Started
### Prerequisites
Install Git if you plan on using the Bedrock edition.
You can install Git using your system's package manager, or by downloading the [installer](https://git-scm.com/download/) from the official website.
* Linux
```sh
sudo apt install git
```
* MacOS
```sh
brew install git
```
* Windows
```sh
winget install Git.Git
```
Install/update the [pip](https://pip.pypa.io/en/stable/) package manager.
```sh
python3 -m pip install --upgrade pip
```
It's also recommended to use a [virtual environment](https://docs.python.org/3/library/venv.html).
* Linux / MacOS
```bash
python3 -m venv <venv-name>
source venv/bin/activate
```
* Windows
```bash
python3 -m venv <venv-name>
<venv-name>/Scripts/activate
```
### Installation
Use pip to install [`textureminer`](https://pypi.org/project/textureminer) package.
```shell
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.
```shell
textureminer
```
Add `--bedrock` or `-b` to use the Bedrock edition.
```shell
textureminer --bedrock # or -b
```
You can also pick a specific update or update channel of Minecraft to download textures for.
```shell
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 options for the scale factor and output directory. Get more information with the `--help` flag.
```shell
textureminer --help
```
At a high level, the script follows the following steps:
1. Download files.
* If Java edition, download the client `.jar` file for the specified version from Mojang's servers.
* If Bedrock edition, clone the [Mojang/bedrock-samples](https://github.com/Mojang/bedrock-samples) repository from GitHub.
2. Extract correct files.
1. If Java edition, extract the textures from the `.jar` file.
2. If Bedrock edition, change to the specified version tag.
3. Filter files, only leaving item and block textures to the specified output directory (default: `~/Downloads/textureminer/<edition>/<version>/`).
4. Scale textures by a specified factor (default: 100).
5. Merge block and item textures into a single directory by default.
Raw data
{
"_id": null,
"home_page": "",
"name": "textureminer",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "cli,minecraft",
"author": "4MBL",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/1a/d0/9fc59c5bed1d74d8cc8cf8bd933059a719435fa7b40d6f8d88c433313b51/textureminer-2.0.2.tar.gz",
"platform": null,
"description": "# [textureminer](https://4mbl.link/gh/textureminer)\n\nA Python script that allows you to extract and scale Minecraft's item and block textures. It automates the process of downloading the necessary files and performing the required operations.\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\n## Getting Started\n\n### Prerequisites\n\nInstall Git if you plan on using the Bedrock edition.\n\nYou can install Git using your system's package manager, or by downloading the [installer](https://git-scm.com/download/) from the official website.\n\n* Linux\n\n ```sh\n sudo apt install git\n ```\n\n* MacOS\n\n ```sh\n brew install git\n ```\n\n* Windows\n\n ```sh\n winget install Git.Git\n ```\n\nInstall/update the [pip](https://pip.pypa.io/en/stable/) package manager.\n\n ```sh\n python3 -m pip install --upgrade pip\n ```\n\nIt's also recommended to use a [virtual environment](https://docs.python.org/3/library/venv.html).\n\n* Linux / MacOS\n\n ```bash\n python3 -m venv <venv-name>\n source venv/bin/activate\n ```\n\n* Windows\n\n ```bash\n python3 -m venv <venv-name>\n <venv-name>/Scripts/activate\n ```\n\n### Installation\n\nUse pip to install [`textureminer`](https://pypi.org/project/textureminer) package.\n\n```shell\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```shell\ntextureminer\n```\n\nAdd `--bedrock` or `-b` to use the Bedrock edition.\n\n```shell\ntextureminer --bedrock # or -b\n```\n\nYou can also pick a specific update or update channel of Minecraft to download textures for.\n\n```shell\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, 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 options for the scale factor and output directory. Get more information with the `--help` flag.\n\n```shell\ntextureminer --help\n```\n\nAt a high level, the script follows the following steps:\n\n1. Download files.\n * If Java edition, download the client `.jar` file for the specified version from Mojang's servers.\n * If Bedrock edition, clone the [Mojang/bedrock-samples](https://github.com/Mojang/bedrock-samples) repository from GitHub.\n2. Extract correct files.\n 1. If Java edition, extract the textures from the `.jar` file.\n 2. If Bedrock edition, change to the specified version tag.\n3. Filter files, only leaving item and block textures to the specified output directory (default: `~/Downloads/textureminer/<edition>/<version>/`).\n4. Scale textures by a specified factor (default: 100).\n5. Merge block and item textures into a single directory by default.\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": "Script that allows you to extract and scale Minecraft's item and block textures.",
"version": "2.0.2",
"project_urls": {
"Bug Tracker": "https://github.com/4mbl/textureminer/issues",
"Changelog": "https://github.com/4mbl/textureminer/blob/main/CHANGELOG.md",
"Homepage": "https://github.com/4mbl/textureminer",
"Source Code": "https://github.com/4mbl/textureminer"
},
"split_keywords": [
"cli",
"minecraft"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9312d78005c1c0b9b5308e4746ad400cc4b29ead2d61c086ea14546a5e708a28",
"md5": "65d3da9da2e6b33823e6965a3f97828b",
"sha256": "ff447c346cd4b76cfe924bf9a1d84e14145cd503e22650cf9a3f168c76780cc2"
},
"downloads": -1,
"filename": "textureminer-2.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "65d3da9da2e6b33823e6965a3f97828b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 15071,
"upload_time": "2024-01-24T20:27:23",
"upload_time_iso_8601": "2024-01-24T20:27:23.048247Z",
"url": "https://files.pythonhosted.org/packages/93/12/d78005c1c0b9b5308e4746ad400cc4b29ead2d61c086ea14546a5e708a28/textureminer-2.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1ad09fc59c5bed1d74d8cc8cf8bd933059a719435fa7b40d6f8d88c433313b51",
"md5": "7d4c6d3787ed797d9e751ace3bc9ba8a",
"sha256": "da659aa71fb51397c44329a2314284634ae25e218e3768f7779f11da9c6c27ec"
},
"downloads": -1,
"filename": "textureminer-2.0.2.tar.gz",
"has_sig": false,
"md5_digest": "7d4c6d3787ed797d9e751ace3bc9ba8a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 13235,
"upload_time": "2024-01-24T20:27:24",
"upload_time_iso_8601": "2024-01-24T20:27:24.322248Z",
"url": "https://files.pythonhosted.org/packages/1a/d0/9fc59c5bed1d74d8cc8cf8bd933059a719435fa7b40d6f8d88c433313b51/textureminer-2.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-24 20:27:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "4mbl",
"github_project": "textureminer",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "textureminer"
}
