modsmith-cli 0.1.1__py3-none-any.whl

modsmith_cli-0.1.1.dist-info/METADATA

@@ -0,0 +1,255 @@
+Metadata-Version: 2.5
+Name: modsmith-cli
+Version: 0.1.1
+Summary: Install Minecraft modpacks and mods for the official launcher.
+Project-URL: Homepage, https://modsmithmc.org/
+Project-URL: Source, https://github.com/ModsmithMC/modsmith-cli
+Project-URL: Documentation, https://modsmithmc.org/modsmith-cli/
+Project-URL: Issues, https://github.com/ModsmithMC/modsmith-cli/issues
+Author-email: MeNeither <pengyufeng2003@outlook.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Games/Entertainment
+Requires-Python: >=3.12
+Requires-Dist: modsmith<0.4,>=0.3.5
+Requires-Dist: platformdirs>=4.3
+Requires-Dist: rich>=13.9
+Requires-Dist: tomli-w>=1.1
+Requires-Dist: typer>=0.15
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="docs/assets/banner.svg" alt="Modsmith" width="100%">
+</p>
+
+<p align="center">
+  <strong>Modpacks from your terminal: find, install and update Minecraft modpacks, mods, resource packs and shaders for the official launcher.</strong>
+</p>
+
+<p align="center">
+  <a href="https://github.com/ModsmithMC/modsmith-cli/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/ModsmithMC/modsmith-cli/ci.yml?branch=main&style=flat-square&label=CI&logo=github" alt="CI"></a>
+  <a href="https://pypi.org/project/modsmith-cli/"><img src="https://img.shields.io/pypi/v/modsmith-cli?style=flat-square&color=3c8527" alt="PyPI"></a>
+  <a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/python-3.12%2B-3776AB?style=flat-square&logo=python&logoColor=white" alt="Python 3.12+"></a>
+  <img src="https://img.shields.io/badge/status-alpha-orange?style=flat-square" alt="Alpha">
+  <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-green?style=flat-square" alt="MIT license"></a>
+</p>
+
+<p align="center">
+  <a href="https://modsmithmc.org/">Website</a> · <a href="https://modsmithmc.org/modsmith-cli/">Documentation</a> · <strong>English</strong> · <a href="README_ZH.md">简体中文</a>
+</p>
+
+---
+
+Modsmith prepares the game files and adds an installation to the official Minecraft launcher. It does not sign in or start the game: you choose the installation in the launcher and play.
+
+<table>
+  <tr>
+    <td width="33%" valign="top">
+      <img src="https://raw.githubusercontent.com/ModsmithMC/modsmithmc.github.io/main/site/assets/pixel/package.svg" alt="" width="24" height="24">
+      <p><strong>Modpacks in one command</strong></p>
+      Install a pack from Modrinth, CurseForge or a file, with its mod loader and Minecraft.
+    </td>
+    <td width="33%" valign="top">
+      <img src="https://raw.githubusercontent.com/ModsmithMC/modsmithmc.github.io/main/site/assets/pixel/puzzle.svg" alt="" width="24" height="24">
+      <p><strong>Add what you like</strong></p>
+      Add mods, resource packs and shaders, with the mods they need.
+    </td>
+    <td width="33%" valign="top">
+      <img src="https://raw.githubusercontent.com/ModsmithMC/modsmithmc.github.io/main/site/assets/pixel/refresh.svg" alt="" width="24" height="24">
+      <p><strong>Updates that keep your changes</strong></p>
+      Update a pack and what you added, and see what changed in each release.
+    </td>
+  </tr>
+  <tr>
+    <td valign="top">
+      <img src="https://raw.githubusercontent.com/ModsmithMC/modsmithmc.github.io/main/site/assets/pixel/list.svg" alt="" width="24" height="24">
+      <p><strong>See before it happens</strong></p>
+      Every change is shown first and waits for your yes. <code>--dry-run</code> only shows it.
+    </td>
+    <td valign="top">
+      <img src="https://raw.githubusercontent.com/ModsmithMC/modsmithmc.github.io/main/site/assets/pixel/play.svg" alt="" width="24" height="24">
+      <p><strong>Ready in the launcher</strong></p>
+      Each instance gets its own installation, with the pack's icon, in the official launcher.
+    </td>
+    <td valign="top">
+      <img src="https://raw.githubusercontent.com/ModsmithMC/modsmithmc.github.io/main/site/assets/pixel/link.svg" alt="" width="24" height="24">
+      <p><strong>Bring your own</strong></p>
+      Take over an installation you made in the launcher, and the mods you put in it.
+    </td>
+  </tr>
+</table>
+
+## Installation
+
+Modsmith needs Python 3.12 or newer. Install it from PyPI as a tool with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv tool install modsmith-cli
+```
+
+Or with [pipx](https://pipx.pypa.io/):
+
+```bash
+pipx install modsmith-cli
+```
+
+Then check that it works:
+
+```bash
+modsmith --version
+```
+
+Coming from 0.1.0? It was installed under another name, so remove it first with `uv tool uninstall modsmith-app` or `pipx uninstall modsmith-app`. Your instances and settings stay where they are.
+
+## Quick start
+
+Find a modpack, install it, and play it from the official launcher:
+
+```bash
+modsmith search "fabulously optimized" --type modpack
+modsmith install fabulously-optimized --name fo
+```
+
+Add a mod and a shader pack, then see what the instance holds:
+
+```bash
+modsmith add fo iris
+modsmith add fo complementary-reimagined --type shader
+modsmith show fo
+```
+
+Keep it up to date:
+
+```bash
+modsmith update fo
+```
+
+When you have only one instance, you can leave its name out.
+
+## Commands
+
+| Command | What it does |
+| --- | --- |
+| `install` | Install a modpack as a new instance |
+| `create` | Start an empty instance, with or without a mod loader |
+| `import` | Manage an installation you made in the official launcher |
+| `list` | List your instances |
+| `show` | List the mods, resource packs and shaders in an instance |
+| `add` / `remove` | Add projects with what they need, or remove them |
+| `enable` / `disable` | Turn files on or off without removing them |
+| `pin` / `unpin` | Keep a project at its release, or let it update |
+| `adopt` | Recognise files you put in an instance yourself |
+| `update` | Update the pack and what you added |
+| `move` / `delete` | Rename, move or delete an instance |
+| `search` / `info` | Find projects and look at their releases |
+| `loaders` | List a mod loader's versions |
+| `config` | Show and change settings |
+
+Every command explains itself with `--help`, examples included.
+
+## Recipes
+
+<details>
+<summary><b>Use CurseForge</b></summary>
+
+CurseForge needs an API key, which you can get for free from the [CurseForge console](https://console.curseforge.com). Save it once:
+
+```bash
+modsmith config set curseforge_api_key '<key>'
+```
+
+In PowerShell, keep the single quotes: `$` starts a variable inside double quotes. Then name CurseForge projects with `curseforge:`:
+
+```bash
+modsmith install curseforge:all-the-mods-9 --name atm9
+modsmith add atm9 curseforge:jei
+```
+
+</details>
+
+<details>
+<summary><b>Install files that must be downloaded by hand</b></summary>
+
+Some CurseForge authors block downloads by other tools. Modsmith lists those files with a link to each. Download them into one folder, then run the same command again:
+
+```bash
+modsmith install curseforge:all-the-mods-9 --name atm9 --from Downloads/atm9-files
+```
+
+</details>
+
+<details>
+<summary><b>Choose optional files</b></summary>
+
+When a pack has optional files, Modsmith asks which ones you want. To decide on the command line instead:
+
+```bash
+modsmith install fabulously-optimized --optional shaders --optional zoom
+modsmith install fabulously-optimized --all-optional
+```
+
+Your choice is remembered, and `update` keeps it.
+
+</details>
+
+<details>
+<summary><b>Start from nothing</b></summary>
+
+```bash
+modsmith loaders fabric 1.21.1
+modsmith create survival --minecraft 1.21.1 --loader fabric
+modsmith add survival sodium lithium
+```
+
+Without `--loader-version`, the recommended version is used.
+
+</details>
+
+<details>
+<summary><b>Take over an existing installation</b></summary>
+
+Give the installation its own game directory in the official launcher, start it once, then:
+
+```bash
+modsmith import "My Fabric world"
+```
+
+Modsmith reads its Minecraft and loader versions, and recognises the mods in it so they can be updated.
+
+</details>
+
+<details>
+<summary><b>Use it in scripts</b></summary>
+
+Without a terminal, Modsmith never asks: it stops and tells you to add `--yes`. Deleting needs `--force` as well. For more than that, use the [Modsmith Python library](https://github.com/ModsmithMC/modsmith-python) directly.
+
+</details>
+
+## Where things go
+
+| What | Where |
+| --- | --- |
+| Instances | Your user data folder, under `Modsmith/instances`. Change it with `modsmith config set instances_dir <folder>` |
+| Settings | `config.toml` in your user config folder. `modsmith config path` prints it |
+| Launcher installations | The official launcher's `launcher_profiles.json`, one per instance |
+
+Set `MODSMITH_HOME` to keep everything in one folder instead.
+
+## Part of Modsmith
+
+The command line is built on the Python library, which does the real work: platforms, modpack formats, mod loaders and instances.
+
+| | What it is | Code |
+| :--- | :--- | :--- |
+| [Command line](https://modsmithmc.org/modsmith-cli/) | Modpacks from your terminal | [ModsmithMC/modsmith-cli](https://github.com/ModsmithMC/modsmith-cli) |
+| [Python library](https://modsmithmc.org/modsmith-python/) | Build your own modpack tools | [ModsmithMC/modsmith-python](https://github.com/ModsmithMC/modsmith-python) |
+| [Website](https://modsmithmc.org/) | The project's home | [ModsmithMC/modsmithmc.github.io](https://github.com/ModsmithMC/modsmithmc.github.io) |
+
+## License
+
+Modsmith is released under the [MIT License](LICENSE). It is not affiliated with Mojang, Microsoft, Modrinth or CurseForge.

modsmith_cli-0.1.1.dist-info/RECORD

@@ -0,0 +1,32 @@
+modsmith_cli/__init__.py,sha256=wmQAYOKCcZp-sXFfN6GqPlBhdIZK3MnxxAt-INpZIKA,258
+modsmith_cli/__main__.py,sha256=hUlJvdkNJi0a3OjyAkKS6weUJDj-7sXdNeGOvpSmxu0,134
+modsmith_cli/app.py,sha256=-e_ODsJHJdAY_KaOwFeZAq1hpq-Rwbc_am39DH9R-ic,6934
+modsmith_cli/context.py,sha256=hK1tmJGytnTyReKicVz2db19TZVkUlEMnSwKGUmp7GY,3563
+modsmith_cli/errors.py,sha256=DJA6-zwrSyVSOu-kfqCPySyqLvn0zUtPQmKTHA6qEGA,5923
+modsmith_cli/target.py,sha256=bYgiSKEFUXKTGeCQHjR_7id0Pk_ewMiMhc1FcobPlz0,1312
+modsmith_cli/ui.py,sha256=FXmAXurGiPGA5cD8zWw4iAo8bZ28HyrxtFlw1EQPP-I,7270
+modsmith_cli/commands/__init__.py,sha256=owe-HP_g31c-kpyi_OJ3UezfJusqJyXTFxjUfvewuQo,81
+modsmith_cli/commands/config.py,sha256=csOlyTwLLO7MBNW7ldxoDoodtFz1MfKAMX1JYmOn5RE,2530
+modsmith_cli/commands/contents.py,sha256=FEJtEFrhWblm11JXwZ38n3stqgP2GeDBqapSdlEKLW4,11665
+modsmith_cli/commands/discovery.py,sha256=hLBuIebOCnOUaJ-BSZpTI2sq82C1nFtxxsAxh6ladL8,4931
+modsmith_cli/commands/install.py,sha256=FbmkOTfFvY1WYbx5PWag32FI9vcRRR3EMiLtYhVZOd4,11588
+modsmith_cli/commands/instance.py,sha256=OmyvpmbR05z-7NJlaMYWUYftKAoI2OFyZZcqmddhANg,8330
+modsmith_cli/commands/list.py,sha256=Pg1o3xBBgDW_q3-9nCXcXlDpvkAYFQAtKNWLFQxHaYs,1572
+modsmith_cli/commands/search.py,sha256=XNz3yS0ahPTA26SCpKxUSHF6zue9QBVFHo52LfJYAwU,6261
+modsmith_cli/commands/update.py,sha256=1uUSRDt6PCMTETRrh_5VYuQPx7R5HcoTjS_MJ0RHBUc,10929
+modsmith_cli/core/__init__.py,sha256=O9YYe_3bsOQKuAeNhQACs9wdvoAaDH78_Hiva2JZEWo,219
+modsmith_cli/core/config.py,sha256=inv0_QcIC74BoXcRkdnWQrvfW5YnbdRj9Vuzx6j6lMw,6794
+modsmith_cli/core/contents.py,sha256=2zhaI9STB57M0ybZKvF3Owz6tg9kC8RbSQi_ycNJql8,2314
+modsmith_cli/core/errors.py,sha256=ri5QUTKUCBRCdZMAC4kcDF0pn5L2SQeyyBd_NmDjclI,484
+modsmith_cli/core/install.py,sha256=NV3hsJ79oMVFd7cDSqF4XcspFw3hVYls8xgvxJlxSVA,8283
+modsmith_cli/core/names.py,sha256=QqhHadyhNDdiYeIg7dERGswDjsiZxfISOUWjT5K__0I,915
+modsmith_cli/core/paths.py,sha256=bRBQsd5cW8HbvlFXCncI91Zp7LqEamvboXwiAV17SjY,1907
+modsmith_cli/core/platforms.py,sha256=IC9AECseDgfww3PHJyFLU-WiMuD7ZpSbf1lqwuB4WeU,3546
+modsmith_cli/core/records.py,sha256=_IDlu4_IPkRRKQM6-tR_RqoI2Wirecau0_aMJpx0mvM,2235
+modsmith_cli/core/refs.py,sha256=cYCCkYiDBa-Nlq7GuNX2AhjYGehHOUaNe-PEI2LRubw,2570
+modsmith_cli/core/registry.py,sha256=7IU82APQHnlKD536b5YvxlV07cd-08jwczqiI_MFaFU,6175
+modsmith_cli-0.1.1.dist-info/METADATA,sha256=x-WnuB2gmwk5D24SioKgNtAGLLmdJgsHhbC4SsukP8Q,9737
+modsmith_cli-0.1.1.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+modsmith_cli-0.1.1.dist-info/entry_points.txt,sha256=uOG8TIGUuQ7pPEu7bE1WAPgZ4G8Lv-edS3nrmqfJHHs,51
+modsmith_cli-0.1.1.dist-info/licenses/LICENSE,sha256=qHokVf-Kk3sukgcwuGaKF6RLeOfqj0dK6r_gJ96AKIE,1066
+modsmith_cli-0.1.1.dist-info/RECORD,,

modsmith_cli-0.1.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.33.0
+Root-Is-Purelib: true
+Tag: py3-none-any

modsmith_cli-0.1.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+modsmith = modsmith_cli.app:main

modsmith_cli-0.1.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 MeNeither
+
+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.