modforge-cli 0.2.3__tar.gz → 0.2.4__tar.gz

{modforge_cli-0.2.3 → modforge_cli-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: modforge-cli
-Version: 0.2.3
+Version: 0.2.4
 Summary: ModForge-CLI — a Modrinth-based Minecraft modpack builder
 License: MIT
 License-File: LICENSE
@@ -68,3 +68,56 @@ poetry install
 pip install -r requirements.txt
 ```
 
+## Example
+
+```bash
+modforge-cli setup --loader-version 0.18.4 TestPack
+cd TestPack
+modforge-cli add sodium
+modforge-cli add "Fabric API"
+modforge-cli add "Cloth Config"
+modforge-cli add "ferriteCore"
+modforge-cli add "Entity Culling"
+modforge-cli add "Mod Menu"
+modforge-cli add "Lithium"
+modforge-cli add "ImmediatelyFast"
+modforge-cli add "yacl"
+modforge-cli add "Xaero's minimap"
+modforge-cli add "Fabric Language Kotlin"
+modforge-cli add "JEI"
+modforge-cli add "3D Skin Layers"
+modforge-cli add "More Culling"
+modforge-cli add "Zoomify"
+modforge-cli add "Mouse Tweaks"
+modforge-cli add "Sound Physics Remastered"
+modforge-cli add "LambDynamicLights"
+modforge-cli add "Krypton"
+modforge-cli add "AmbientSounds"
+modforge-cli add "BadOptimizations"
+modforge-cli add "Debugify"
+modforge-cli add "Veinminer Enchantment"
+modforge-cli add "Packet Fixer"
+modforge-cli add "CustomSkinLoader"
+modforge-cli add "Cubes Without Borders"
+modforge-cli add "Particle Rain"
+modforge-cli add "Chunky"
+modforge-cli add "Fusion (Connected Textures)"
+modforge-cli add "Do a Barrel Roll"
+modforge-cli add "Resourcify"
+modforge-cli add "Particle Core"
+modforge-cli add "Drip Sounds"
+modforge-cli add "ScalableLux"
+modforge-cli add "Cull Leaves"
+modforge-cli add "rrls"
+modforge-cli add "ModernFix-mVUS"
+modforge-cli add "NoisiumForked"
+modforge-cli add "KryptonFNP Patcher"
+modforge-cli add "Podium"
+modforge-cli add "Iris"
+modforge-cli add "first-person-model"
+modforge-cli add "Helium"
+modforge-cli resolve
+modforge-cli build
+modforge-cli export
+```
+

modforge_cli-0.2.4/README.md

@@ -0,0 +1,90 @@
+# ModForge-CLI ⛏
+
+[![Python 3.13+](https://img.shields.io/badge/python-3.13%2B-blue)](https://www.python.org/)
+[![MIT License](https://img.shields.io/badge/license-MIT-green)](LICENSE)
+[![Modrinth API v2](https://img.shields.io/badge/Modrinth-API%20v2-orange)](https://docs.modrinth.com/api-spec)
+
+**ModForge-CLI** is a powerful CLI tool for building and managing custom Minecraft modpacks using the Modrinth API v2.
+
+Search for projects, fetch versions, validate manifests, download mods with hash checks, and generate complete files — all from the terminal.
+
+Ideal for modpack developers, server admins, and automation scripts.
+
+## Terminal Banner
+
+When you run ModForge-CLI, you'll be greeted with this colorful Minecraft-themed banner
+
+## Key Features
+
+- **Modrinth API v2 Integration**: Search projects, list versions, fetch metadata in bulk.
+- **Modpack Management**: Read/validate `modrinth.index.json`, build packs from metadata.
+- **Validation**: Full JSON Schema checks + optional Pydantic models for strict typing.
+
+## Installation
+
+Requires **Python 3.13+**.
+
+**Recommended (Poetry)**:
+
+```bash
+poetry install
+```
+
+**Alternative (pip)**:
+
+```bash
+pip install -r requirements.txt
+```
+
+## Example
+
+```bash
+modforge-cli setup --loader-version 0.18.4 TestPack
+cd TestPack
+modforge-cli add sodium
+modforge-cli add "Fabric API"
+modforge-cli add "Cloth Config"
+modforge-cli add "ferriteCore"
+modforge-cli add "Entity Culling"
+modforge-cli add "Mod Menu"
+modforge-cli add "Lithium"
+modforge-cli add "ImmediatelyFast"
+modforge-cli add "yacl"
+modforge-cli add "Xaero's minimap"
+modforge-cli add "Fabric Language Kotlin"
+modforge-cli add "JEI"
+modforge-cli add "3D Skin Layers"
+modforge-cli add "More Culling"
+modforge-cli add "Zoomify"
+modforge-cli add "Mouse Tweaks"
+modforge-cli add "Sound Physics Remastered"
+modforge-cli add "LambDynamicLights"
+modforge-cli add "Krypton"
+modforge-cli add "AmbientSounds"
+modforge-cli add "BadOptimizations"
+modforge-cli add "Debugify"
+modforge-cli add "Veinminer Enchantment"
+modforge-cli add "Packet Fixer"
+modforge-cli add "CustomSkinLoader"
+modforge-cli add "Cubes Without Borders"
+modforge-cli add "Particle Rain"
+modforge-cli add "Chunky"
+modforge-cli add "Fusion (Connected Textures)"
+modforge-cli add "Do a Barrel Roll"
+modforge-cli add "Resourcify"
+modforge-cli add "Particle Core"
+modforge-cli add "Drip Sounds"
+modforge-cli add "ScalableLux"
+modforge-cli add "Cull Leaves"
+modforge-cli add "rrls"
+modforge-cli add "ModernFix-mVUS"
+modforge-cli add "NoisiumForked"
+modforge-cli add "KryptonFNP Patcher"
+modforge-cli add "Podium"
+modforge-cli add "Iris"
+modforge-cli add "first-person-model"
+modforge-cli add "Helium"
+modforge-cli resolve
+modforge-cli build
+modforge-cli export
+```

{modforge_cli-0.2.3 → modforge_cli-0.2.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "modforge-cli"
-version = "0.2.3"
+version = "0.2.4"
 description = "ModForge-CLI — a Modrinth-based Minecraft modpack builder"
 authors = [{ name = "Frank1o3", email = "jahdy1o3@gmail.com" }]
 license = { text = "MIT" }

modforge_cli-0.2.4/src/modforge_cli/__init__.py

@@ -0,0 +1,3 @@
+"""
+CLI package for ModForge-CLI
+"""

{modforge_cli-0.2.3 → modforge_cli-0.2.4}/src/modforge_cli/__main__.py

@@ -102,9 +102,6 @@ def main_callback(
         console.print("  [green]validate[/green]    Check .mrpack for issues")
         console.print("  [green]sklauncher[/green]  Create SKLauncher profile (no .mrpack)")
         console.print("  [green]remove[/green]      Remove a modpack project")
-        console.print("\n[bold cyan]Utility:[/bold cyan]")
-        console.print("  [green]self-update[/green] Update ModForge-CLI")
-        console.print("  [green]doctor[/green]      Validate installation")
         console.print("\nRun [white]ModForge-CLI --help[/white] for details.\n")
 
 
@@ -119,8 +116,6 @@ app.command()(modpack.build)
 app.command()(export.export)
 app.command()(export.validate)
 app.command()(sklauncher.sklauncher)
-app.command()(utils.doctor)
-app.command("self-update")(utils.self_update_cmd)
 
 
 def main() -> None:

{modforge_cli-0.2.3 → modforge_cli-0.2.4}/src/modforge_cli/__version__.py

@@ -1,5 +1,5 @@
 """
 Auto-generated file. DO NOT EDIT.
 """
-__version__ = "0.2.3"
+__version__ = "0.2.4"
 __author__ = "Frank1o3"

{modforge_cli-0.2.3 → modforge_cli-0.2.4}/src/modforge_cli/cli/export.py

@@ -4,8 +4,6 @@ Export and validation commands
 
 import json
 from pathlib import Path
-import shutil
-import tempfile
 import zipfile
 from zipfile import ZIP_DEFLATED, ZipFile
 
@@ -21,6 +19,7 @@ app = typer.Typer()
 def export(pack_name: str | None = None) -> None:
     """Create final .mrpack file"""
 
+    # Resolve pack name
     if not pack_name:
         manifest = get_manifest(console, Path.cwd())
         if manifest:
@@ -41,65 +40,54 @@ def export(pack_name: str | None = None) -> None:
 
     console.print("[cyan]Exporting modpack...[/cyan]")
 
-    mods_dir = pack_path / "mods"
     index_file = pack_path / "modrinth.index.json"
 
-    if not mods_dir.exists() or not any(mods_dir.iterdir()):
-        console.print("[red]No mods found. Run 'ModForge-CLI build' first[/red]")
-        raise typer.Exit(1)
-
     if not index_file.exists():
         console.print("[red]No modrinth.index.json found[/red]")
         raise typer.Exit(1)
 
-    # Validate index has files
-    index_data = json.loads(index_file.read_text())
+    # Validate index JSON before export
+    try:
+        index_data = json.loads(index_file.read_text())
+    except json.JSONDecodeError as e:
+        console.print("[red]Invalid modrinth.index.json[/red]")
+        console.print(f"[dim]{e}[/dim]")
+        raise typer.Exit(1) from e
+
     if not index_data.get("files"):
         console.print("[yellow]Warning: No files registered in index[/yellow]")
-        console.print("[yellow]This might cause issues. Run 'ModForge-CLI build' again.[/yellow]")
-
-    # Create .mrpack
-    with tempfile.TemporaryDirectory() as tmpdir:
-        tmp_path = Path(tmpdir)
-
-        # Copy modrinth.index.json to root
-        shutil.copy2(index_file, tmp_path / "modrinth.index.json")
+        console.print("[yellow]Run 'ModForge-CLI build' if this is unintended.[/yellow]")
 
-        # Copy overrides if they exist
-        overrides_src = pack_path / "overrides"
-        if overrides_src.exists():
-            overrides_dst = tmp_path / "overrides"
-            shutil.copytree(overrides_src, overrides_dst)
-            console.print("[green]✓ Copied overrides[/green]")
+    # Output file (.mrpack extension)
+    mrpack_path = pack_path.parent / f"{pack_name}.mrpack"
 
-        # Create .mrpack
-        mrpack_path = pack_path.parent / f"{pack_name}.mrpack"
+    # Create archive
+    with ZipFile(mrpack_path, "w", ZIP_DEFLATED) as zipf:
+        for file_path in pack_path.rglob("*"):
+            if file_path.is_file():
+                arcname = file_path.relative_to(pack_path)
+                zipf.write(file_path, arcname)
 
-        with ZipFile(mrpack_path, "w", ZIP_DEFLATED) as zipf:
-            # Add modrinth.index.json at root
-            zipf.write(tmp_path / "modrinth.index.json", "modrinth.index.json")
+    console.print(f"[green bold]✓ Exported to {mrpack_path}[/green bold]")
 
-            # Add overrides folder if exists
-            if overrides_src.exists():
-                for file_path in (tmp_path / "overrides").rglob("*"):
-                    if file_path.is_file():
-                        arcname = str(file_path.relative_to(tmp_path))
-                        zipf.write(file_path, arcname)
+    # ---- Summary ----
+    file_count = len(index_data.get("files", []))
 
-        console.print(f"[green bold]✓ Exported to {mrpack_path}[/green bold]")
+    console.print("\n[cyan]Summary:[/cyan]")
+    console.print(f"  Files registered in index: {file_count}")
+    console.print(f"  Minecraft: {index_data['dependencies'].get('minecraft')}")
 
-        # Show summary
-        file_count = len(index_data.get("files", []))
-        console.print("\n[cyan]Summary:[/cyan]")
-        console.print(f"  Files registered: {file_count}")
-        console.print(f"  Minecraft: {index_data['dependencies'].get('minecraft')}")
+    for loader in ["fabric-loader", "quilt-loader", "forge", "neoforge"]:
+        if loader in index_data["dependencies"]:
+            console.print(f"  Loader: {loader} {index_data['dependencies'][loader]}")
 
-        # Show loader
-        for loader in ["fabric-loader", "quilt-loader", "forge", "neoforge"]:
-            if loader in index_data["dependencies"]:
-                console.print(f"  Loader: {loader} {index_data['dependencies'][loader]}")
+    has_env = any("env" in f for f in index_data.get("files", []))
+    if has_env:
+        console.print("  [green]✓ Environment data included[/green]")
+    else:
+        console.print("  [yellow]⚠ No environment data (older format)[/yellow]")
 
-        console.print("\n[dim]Import this in SKLauncher, Prism, ATLauncher, etc.[/dim]")
+    console.print("\n[dim]Import this in SKLauncher, Prism, ATLauncher, etc.[/dim]")
 
 
 @app.command()
@@ -153,6 +141,13 @@ def validate(mrpack_file: str | None = None) -> None:
                     else:
                         console.print(f"[green]✅ {field}: {value}[/green]")
 
+            # Check optional summary
+            if "summary" not in index_data:
+                warnings.append("Missing optional summary field")
+                console.print("[yellow]⚠️  Missing summary (optional but recommended)[/yellow]")
+            else:
+                console.print(f"[green]✅ summary: {index_data['summary'][:50]}...[/green]")
+
             # Check dependencies
             deps = index_data.get("dependencies", {})
             if "minecraft" not in deps:
@@ -192,6 +187,13 @@ def validate(mrpack_file: str | None = None) -> None:
                 else:
                     console.print("[green]✅ File structure looks good[/green]")
 
+                # Check path security
+                for file_entry in files_list:
+                    path = file_entry.get("path", "")
+                    if ".." in path or path.startswith(("/", "\\")):
+                        issues.append(f"Security: invalid path: {path}")
+                        console.print(f"[red]❌ SECURITY: Invalid path: {path}[/red]")
+
                 # Check hashes
                 if "hashes" in sample:
                     if "sha1" not in sample["hashes"]:
@@ -206,12 +208,31 @@ def validate(mrpack_file: str | None = None) -> None:
                     else:
                         console.print("[green]✅ sha512 hashes present[/green]")
 
-                # Check env field
+                # Check env field (NEW)
                 if "env" not in sample:
                     warnings.append("Files missing env field")
                     console.print("[yellow]⚠️  Missing env field (recommended)[/yellow]")
                 else:
-                    console.print("[green]✅ env field present[/green]")
+                    env = sample["env"]
+                    if "client" in env and "server" in env:
+                        console.print("[green]✅ env field present[/green]")
+                    else:
+                        warnings.append("env field incomplete")
+                        console.print("[yellow]⚠️  env field incomplete[/yellow]")
+
+            # Check for overrides and server-overrides
+            has_overrides = any(f.startswith("overrides/") for f in files)
+            has_server_overrides = any(f.startswith("server-overrides/") for f in files)
+
+            if has_overrides:
+                console.print("[green]✅ overrides/ folder present[/green]")
+            else:
+                console.print("[dim]No overrides/ folder (optional)[/dim]")
+
+            if has_server_overrides:
+                console.print("[green]✅ server-overrides/ folder present[/green]")
+            else:
+                console.print("[dim]No server-overrides/ folder (optional)[/dim]")
 
         # Summary
         console.print("\n" + "=" * 60)
@@ -237,10 +258,10 @@ def validate(mrpack_file: str | None = None) -> None:
             console.print("[yellow]Run 'ModForge-CLI build' again to fix[/yellow]")
             raise typer.Exit(1)
 
-    except zipfile.BadZipFile:
+    except zipfile.BadZipFile as e:
         console.print("[red]❌ ERROR: Not a valid ZIP/MRPACK file[/red]")
-        raise typer.Exit(1)
+        raise typer.Exit(1) from e
     except json.JSONDecodeError as e:
         console.print("[red]❌ ERROR: Invalid JSON in modrinth.index.json[/red]")
         console.print(f"[dim]{e}[/dim]")
-        raise typer.Exit(1)
+        raise typer.Exit(1) from e

{modforge_cli-0.2.3 → modforge_cli-0.2.4}/src/modforge_cli/core/downloader.py

@@ -5,6 +5,7 @@ from collections.abc import Iterable
 import hashlib
 import json
 from pathlib import Path
+from pprint import pprint
 
 import aiohttp
 from rich.console import Console
@@ -15,6 +16,21 @@ from modforge_cli.api import ModrinthAPIConfig
 console = Console()
 
 
+def validate_filename(filename: str) -> None:
+    """
+    Validate filename to prevent directory traversal attacks.
+
+    Per Modrinth spec: "make sure this field doesn't exit the Minecraft
+    instance directory for security reasons. To do this, make sure it
+    doesn't contain .. or start with a drive name"
+    """
+    if ".." in filename:
+        raise ValueError(f"Security: filename contains '..': {filename}")
+
+    if filename.startswith(("/", "\\", "\\\\")) or (len(filename) >= 2 and filename[1] == ":"):
+        raise ValueError(f"Security: filename is absolute path: {filename}")
+
+
 class ModDownloader:
     def __init__(
         self,
@@ -104,16 +120,19 @@ class ModDownloader:
 
     async def _download_project(self, project_id: str) -> None:
         # 1. Fetch all versions for this project
+        project_url = self.api.project(project_id)
         url = self.api.project_versions(project_id)
+        self.api.environments()
 
         try:
-            async with self.session.get(url) as r:
-                if r.status != 200:
+            async with self.session.get(url) as r, self.session.get(project_url) as rs:
+                if r.status != 200 or rs.status != 200:
                     console.print(
                         f"[red]Failed to fetch versions for {project_id}: HTTP {r.status}[/red]"
                     )
                     return
                 versions = await r.json()
+                project = await rs.json()
         except Exception as e:
             console.print(f"[red]Error fetching {project_id}: {e}[/red]")
             return
@@ -146,6 +165,13 @@ class ModDownloader:
             )
             return
 
+        # SECURITY: Validate filename
+        try:
+            validate_filename(primary_file["filename"])
+        except ValueError as e:
+            console.print(f"[red]{e}[/red]")
+            return
+
         # 4. Download file to mods/ directory
         dest = self.output_dir / primary_file["filename"]
 
@@ -188,10 +214,29 @@ class ModDownloader:
                 f"  Got:      {sha1}"
             )
 
-        # 6. Register in index (Modrinth format)
+        # 6. Extract environment info from version
+        # Per Modrinth spec, env can be: required, optional, unsupported
+        client_side = project.get("client_side", "required")
+        server_side = project.get("server_side", "required")
+
+        # Normalize values (Modrinth API uses different terms)
+        env_map = {
+            "required": "required",
+            "optional": "optional",
+            "unsupported": "unsupported",
+            "unknown": "required",  # Default to required if unknown
+        }
+
+        env = {
+            "client": env_map.get(client_side, "required"),
+            "server": env_map.get(server_side, "required"),
+        }
+
+        # 7. Register in index (Modrinth format)
         file_entry = {
             "path": f"mods/{primary_file['filename']}",
             "hashes": {"sha1": sha1, "sha512": sha512},
+            "env": env,  # NEW: Environment specification
             "downloads": [primary_file["url"]],
             "fileSize": primary_file["size"],
         }

{modforge_cli-0.2.3 → modforge_cli-0.2.4}/src/modforge_cli/core/resolver.py

@@ -173,8 +173,12 @@ class ModResolver:
                     if not dep_id:
                         continue
 
-                    if dtype == "incompatible":
-                        raise RuntimeError(f"Incompatible dependency detected: {pid} ↔ {dep_id}")
+                    if dtype == "incompatible" and dep_id in resolved:
+                        resolved.remove(dep_id)
+                        print(
+                            f"Warning: Removed incompatible dependency '{dep_id}' "
+                            f"(conflicts with '{pid}') — it may have been added earlier."
+                        )
 
                     if dtype in ("required", "optional") and dep_id not in resolved:
                         resolved.add(dep_id)

modforge_cli-0.2.4/src/modforge_cli/test.py

@@ -0,0 +1,18 @@
+import asyncio
+
+from modforge_cli.api import ModrinthAPIConfig
+from modforge_cli.core import get_api_session
+
+api = ModrinthAPIConfig()
+
+url = api.search("Fabric API", game_versions=["1.21.11"], loaders=["fabric"])
+
+async def run() -> None:
+    async with await get_api_session() as session, await session.get(url) as res:
+        if res.status != 200:
+            print("Error on request")
+            return
+        data = await res.json()
+        print(data["hits"][0]["server_side"], data["hits"][0]["client_side"])
+
+asyncio.run(run())

modforge_cli-0.2.3/README.md

@@ -1,37 +0,0 @@
-# ModForge-CLI ⛏
-
-[![Python 3.13+](https://img.shields.io/badge/python-3.13%2B-blue)](https://www.python.org/)
-[![MIT License](https://img.shields.io/badge/license-MIT-green)](LICENSE)
-[![Modrinth API v2](https://img.shields.io/badge/Modrinth-API%20v2-orange)](https://docs.modrinth.com/api-spec)
-
-**ModForge-CLI** is a powerful CLI tool for building and managing custom Minecraft modpacks using the Modrinth API v2.
-
-Search for projects, fetch versions, validate manifests, download mods with hash checks, and generate complete files — all from the terminal.
-
-Ideal for modpack developers, server admins, and automation scripts.
-
-## Terminal Banner
-
-When you run ModForge-CLI, you'll be greeted with this colorful Minecraft-themed banner
-
-## Key Features
-
-- **Modrinth API v2 Integration**: Search projects, list versions, fetch metadata in bulk.
-- **Modpack Management**: Read/validate `modrinth.index.json`, build packs from metadata.
-- **Validation**: Full JSON Schema checks + optional Pydantic models for strict typing.
-
-## Installation
-
-Requires **Python 3.13+**.
-
-**Recommended (Poetry)**:
-
-```bash
-poetry install
-```
-
-**Alternative (pip)**:
-
-```bash
-pip install -r requirements.txt
-```

modforge_cli-0.2.3/src/modforge_cli/__init__.py

@@ -1,7 +0,0 @@
-"""
-CLI package for ModForge-CLI
-"""
-
-from . import main
-
-__all__ = ["main"]