# mcpath
![Tests](https://github.com/legopitstop/mcpath/actions/workflows/tests.yml/badge.svg)
[![PyPI](https://img.shields.io/pypi/v/mcpath)](https://pypi.org/project/mcpath/)
[![Python](https://img.shields.io/pypi/pyversions/mcpath)](https://www.python.org/downloads//)
![Downloads](https://img.shields.io/pypi/dm/mcpath)
![Status](https://img.shields.io/pypi/status/mcpath)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
[![Issues](https://img.shields.io/github/issues/legopitstop/mcpath)](https://github.com/legopitstop/mcpath/issues)
Get paths to Minecraft Java, Bedrock, Preview, and Education Edition folders.
## Supported Platforms
| | Java | Bedrock | Preview/Beta | Education | Runtime |
| ----------------- | -------- | -------- | ------------ | --------- | -------- |
| **Android** _[1]_ | ❌ | ✅ | ❌ | ❌ | ❌ |
| **Darwin** | ✅ _[3]_ | ❌ | ❌ | ❌ | ✅ _[3]_ |
| **iOS** _[2]_ | ❌ | ✅ | ❌ | ❌ | ❌ |
| **Linux** | ✅ | ✅ _[4]_ | ❌ | ❌ | ✅ |
| **Windows** | ✅ | ✅ | ✅ | ✅ | ✅ |
1. With [Pydroid 3](https://play.google.com/store/apps/details?id=ru.iiec.pydroid3&hl=en_US)
2. With [Pyto](https://apps.apple.com/us/app/pyto-ide/id1436650069)
3. Has not been tested.
4. With [mcpelauncher](https://mcpelauncher.readthedocs.io/en/latest/).
## Paths
| Argument Name | Example |
| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| root | `C:\Users\USER\AppData\Roaming\.minecraft` |
| launcher | `C:\XboxGames\Minecraft Launcher\Content\Minecraft.exe` |
| executable | `minecraft://` |
| worlds | `C:\Users\USER\AppData\Roaming\.minecraft\saves` |
| resource_packs | `C:\Users\USER\AppData\Roaming\.minecraft\resourcepacks` |
| behavior_packs | `C:\Users\USER\AppData\Local\Packages\Microsoft.MinecraftUWP_8wekyb3d8bbwe\LocalState\games\com.mojang\behavior_packs` |
| development_resource_packs | `C:\Users\USER\AppData\Local\Packages\Microsoft.MinecraftUWP_8wekyb3d8bbwe\LocalState\games\com.mojang\development_resource_packs` |
| development_behavior_packs | `C:\Users\USER\AppData\Local\Packages\Microsoft.MinecraftUWP_8wekyb3d8bbwe\LocalState\games\com.mojang\development_behavior_packs` |
| screenshots | `C:\Users\USER\AppData\Roaming\.minecraft\screenshots` |
## Installation
Install the module with pip:
```bat
pip3 install mcpath
```
Update existing installation: `pip3 install mcpath --upgrade`
## Requirements
| Name | Usage |
| ------------------------------------------------ | ---------------------------------------------------- |
| [`requests`](https://pypi.org/project/requests/) | Get runtime component and version using mojang's API |
## Examples
```Python
from mcpath import java
print(java.worlds)
# C:\Users\USER\AppData\Roaming\.minecraft\saves
```
```Python
import mcpath
print(mcpath.get_runtime('1.21.3'))
# C:\Users\USER\AppData\Local\Packages\Microsoft.4297127D64EC6_8wekyb3d8bbwe\LocalCache\Local\runtime\java-runtime-delta\windows-x64\java-runtime-delta\bin\java.exe
```
Raw data
{
"_id": null,
"home_page": "https://github.com/legopitstop/mcpath/",
"name": "mcpath",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "minecraft, paths, java, bedrock, preview, education, world, screenshots, resourcepacks, behaviorpacks",
"author": "Legopitstop",
"author_email": "contact@lpsmods.dev",
"download_url": "https://files.pythonhosted.org/packages/57/cf/3e1d679288fdcdbe6bbc9008ad5b500e73fe20f0b9ac59df361e92ca6afa/mcpath-1.1.0.tar.gz",
"platform": null,
"description": "# mcpath\n\n![Tests](https://github.com/legopitstop/mcpath/actions/workflows/tests.yml/badge.svg)\n[![PyPI](https://img.shields.io/pypi/v/mcpath)](https://pypi.org/project/mcpath/)\n[![Python](https://img.shields.io/pypi/pyversions/mcpath)](https://www.python.org/downloads//)\n![Downloads](https://img.shields.io/pypi/dm/mcpath)\n![Status](https://img.shields.io/pypi/status/mcpath)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)\n[![Issues](https://img.shields.io/github/issues/legopitstop/mcpath)](https://github.com/legopitstop/mcpath/issues)\n\nGet paths to Minecraft Java, Bedrock, Preview, and Education Edition folders.\n\n## Supported Platforms\n\n| | Java | Bedrock | Preview/Beta | Education | Runtime |\n| ----------------- | -------- | -------- | ------------ | --------- | -------- |\n| **Android** _[1]_ | \u274c | \u2705 | \u274c | \u274c | \u274c |\n| **Darwin** | \u2705 _[3]_ | \u274c | \u274c | \u274c | \u2705 _[3]_ |\n| **iOS** _[2]_ | \u274c | \u2705 | \u274c | \u274c | \u274c |\n| **Linux** | \u2705 | \u2705 _[4]_ | \u274c | \u274c | \u2705 |\n| **Windows** | \u2705 | \u2705 | \u2705 | \u2705 | \u2705 |\n\n1. With [Pydroid 3](https://play.google.com/store/apps/details?id=ru.iiec.pydroid3&hl=en_US)\n2. With [Pyto](https://apps.apple.com/us/app/pyto-ide/id1436650069)\n3. Has not been tested.\n4. With [mcpelauncher](https://mcpelauncher.readthedocs.io/en/latest/).\n\n## Paths\n\n| Argument Name | Example |\n| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |\n| root | `C:\\Users\\USER\\AppData\\Roaming\\.minecraft` |\n| launcher | `C:\\XboxGames\\Minecraft Launcher\\Content\\Minecraft.exe` |\n| executable | `minecraft://` |\n| worlds | `C:\\Users\\USER\\AppData\\Roaming\\.minecraft\\saves` |\n| resource_packs | `C:\\Users\\USER\\AppData\\Roaming\\.minecraft\\resourcepacks` |\n| behavior_packs | `C:\\Users\\USER\\AppData\\Local\\Packages\\Microsoft.MinecraftUWP_8wekyb3d8bbwe\\LocalState\\games\\com.mojang\\behavior_packs` |\n| development_resource_packs | `C:\\Users\\USER\\AppData\\Local\\Packages\\Microsoft.MinecraftUWP_8wekyb3d8bbwe\\LocalState\\games\\com.mojang\\development_resource_packs` |\n| development_behavior_packs | `C:\\Users\\USER\\AppData\\Local\\Packages\\Microsoft.MinecraftUWP_8wekyb3d8bbwe\\LocalState\\games\\com.mojang\\development_behavior_packs` |\n| screenshots | `C:\\Users\\USER\\AppData\\Roaming\\.minecraft\\screenshots` |\n\n## Installation\n\nInstall the module with pip:\n\n```bat\npip3 install mcpath\n```\n\nUpdate existing installation: `pip3 install mcpath --upgrade`\n\n## Requirements\n\n| Name | Usage |\n| ------------------------------------------------ | ---------------------------------------------------- |\n| [`requests`](https://pypi.org/project/requests/) | Get runtime component and version using mojang's API |\n\n## Examples\n\n```Python\nfrom mcpath import java\n\nprint(java.worlds)\n# C:\\Users\\USER\\AppData\\Roaming\\.minecraft\\saves\n```\n\n```Python\nimport mcpath\n\nprint(mcpath.get_runtime('1.21.3'))\n# C:\\Users\\USER\\AppData\\Local\\Packages\\Microsoft.4297127D64EC6_8wekyb3d8bbwe\\LocalCache\\Local\\runtime\\java-runtime-delta\\windows-x64\\java-runtime-delta\\bin\\java.exe\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Get paths to Minecraft Java, Bedrock, Preview, and Education Edition folders.",
"version": "1.1.0",
"project_urls": {
"Documentation": "https://docs.lpsmods.dev/mcpath/",
"Download": "https://github.com/legopitstop/mcpath/releases",
"Homepage": "https://github.com/legopitstop/mcpath/",
"Source Code": "https://github.com/legopitstop/mcpath"
},
"split_keywords": [
"minecraft",
" paths",
" java",
" bedrock",
" preview",
" education",
" world",
" screenshots",
" resourcepacks",
" behaviorpacks"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "57cf3e1d679288fdcdbe6bbc9008ad5b500e73fe20f0b9ac59df361e92ca6afa",
"md5": "62aa4fdac88d5552c15cbb26a49d9589",
"sha256": "13691268b79ff920db4f8d06dbdd71e408e57a976a22b734c5cae8b798c263df"
},
"downloads": -1,
"filename": "mcpath-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "62aa4fdac88d5552c15cbb26a49d9589",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 7874,
"upload_time": "2024-10-28T00:45:49",
"upload_time_iso_8601": "2024-10-28T00:45:49.143788Z",
"url": "https://files.pythonhosted.org/packages/57/cf/3e1d679288fdcdbe6bbc9008ad5b500e73fe20f0b9ac59df361e92ca6afa/mcpath-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-28 00:45:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "legopitstop",
"github_project": "mcpath",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "mcpath"
}