litematic-to-schematic 1.0.0__tar.gz

litematic_to_schematic-1.0.0/LICENSE

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

litematic_to_schematic-1.0.0/PKG-INFO

@@ -0,0 +1,188 @@
+Metadata-Version: 2.4
+Name: litematic-to-schematic
+Version: 1.0.0
+Summary: Convert Minecraft Litematica (.litematic) schematics directly to WorldEdit Sponge V2 (.schem) format.
+Author: Ohualtex
+License: MIT License
+        
+        Copyright (c) 2026 Ohualtex
+        
+        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.
+        
+Project-URL: Homepage, https://github.com/Ohualtex/litematic-to-schematic
+Project-URL: Repository, https://github.com/Ohualtex/litematic-to-schematic
+Project-URL: Issues, https://github.com/Ohualtex/litematic-to-schematic/issues
+Keywords: minecraft,litematica,litematic,schematic,schem,worldedit,sponge,lithetic
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Games/Entertainment
+Classifier: Topic :: Utilities
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: litemapy
+Requires-Dist: nbtlib
+Dynamic: license-file
+
+# 🛠️ Litematica to Schematic Converter
+
+![PyPI Version](https://img.shields.io/pypi/v/litematic-to-schematic.svg)
+![Python Version](https://img.shields.io/badge/python-3.8%2B-blue.svg)
+![License](https://img.shields.io/badge/license-MIT-green.svg)
+![Minecraft Version](https://img.shields.io/badge/minecraft-1.13%2B-orange.svg)
+![WorldEdit Format](https://img.shields.io/badge/format-Sponge%20V2%20(.schem)-brightgreen.svg)
+
+> Read this document in another language:  
+> 🇹🇷 **[Türkçe (Turkish)](README_TR.md)**
+
+A fast, reliable Python CLI tool and library to convert Minecraft **Litematica** (`.litematic`) schematics directly into **WorldEdit / FastAsyncWorldEdit (FAWE)** compatible **Sponge V2** (`.schem`) format.
+
+---
+
+## 🎯 Purpose
+
+In Minecraft, schematic files created by the Fabric/Quilt-based **Litematica** mod (`.litematic`) cannot be loaded directly by **WorldEdit** or **FAWE** plugins running on Forge, NeoForge, Paper, or Spigot servers.
+
+This tool parses Litematica files directly at the NBT level without launching a Minecraft client and converts them into standard Sponge V2 `.schem` files.
+
+---
+
+## ✨ Features
+
+- 🧩 **Multi-Region Merging & Conflict Policies**: Automatically computes the global bounding box across all regions in a `.litematic` file, aligns relative region offsets, prevents air blocks from erasing solid blocks, and provides configurable conflict resolution (`--on-overlap overwrite|keep-first|error`).
+- 📦 **Sponge V2 NBT Structure & Dynamic `DataVersion`**: Preserves the source schematic's `MinecraftDataVersion` (falling back to `2586` only if missing) and builds a Sponge V2 NBT tree (`Version: 2`).
+- 🧰 **BlockEntities & Entities Preservation**: Transfers container inventories (chests, barrels, shulker boxes, signs) and entities (armor stands, item frames, paintings, minecarts) with global coordinate alignment, `TileX/Y/Z` recalculation, and `UUID`/`Id` sanitization.
+- 🔧 **Modded & Vanilla Namespace Integrity**: Preserves custom mod namespaces (e.g., `create:brass_casing`, `ae2:controller[state=online]`) while automatically prefixing un-namespaced vanilla identifiers with `minecraft:`.
+- 🔢 **LEB128 VarInt Byte Encoding**: Encodes block palette indices into signed 8-bit NBT `ByteArray` streams using dynamic LEB128 VarInt encoding, supporting palettes of any size (`> 128` block states).
+- 📐 **Negative Coordinate Axis Alignment**: Regions saved with negative selection bounds in Litematica are automatically normalized to WorldEdit's `(Y * Length + Z) * Width + X` index ordering.
+
+---
+
+## 🧱 Minecraft Version Compatibility & Scope
+
+This converter supports **Minecraft 1.13+ schematics** (1.13 through 1.20, 1.21+, etc.).
+
+### Why is 1.13 the Minimum Supported Version?
+With Minecraft 1.13 (**"The Flattening"**), blocks transitioned from numeric IDs and metadata values (e.g., `35:14`) to string-based namespaced block states (e.g., `minecraft:red_wool`). Sponge V2 palettes rely strictly on string-based block states and do not support legacy 1.12.2 numeric IDs.
+
+### How Newer Versions & Modded Blocks Work
+Block IDs and block state properties (`block.id` and `block.properties`) are parsed dynamically from the input `.litematic` file alongside its `MinecraftDataVersion` tag, without a hardcoded block registry.
+
+### Known Format Limitations
+- **No Cross-Version Block ID Remapping**: The converter preserves the source schematic's `DataVersion` and block state strings as-is. Loading a 1.21 schematic on an older 1.16 server will not downgrade blocks that did not exist in 1.16.
+- **Pending Ticks**: Litematica's `PendingBlockTicks` and `PendingFluidTicks` have no standard equivalent in WorldEdit's Sponge V2 importer and are skipped with an informational console notice when present.
+- **Dimension Bounds**: Sponge V2 stores `Width`, `Height`, and `Length` as signed 16-bit `Short` integers, limiting each axis of the combined bounding box to a maximum of `32,767` blocks.
+
+---
+
+## 📥 Installation
+
+Ensure you have **Python 3.8+** installed on your system.
+
+### Option 1: Install from PyPI (Recommended)
+```bash
+pip install litematic-to-schematic
+```
+*(This automatically installs the `lithetic`, `litematic-to-schematic`, `litematic2schem`, and `litematic2schematic` CLI commands.)*
+
+### Option 2: Install from Source
+```bash
+git clone https://github.com/Ohualtex/litematic-to-schematic.git
+cd litematic-to-schematic
+pip install .
+```
+
+---
+
+## 🚀 Usage
+
+### 1. Command-Line Interface (CLI)
+
+Using the shorthand `lithetic` command (or `litematic-to-schematic` / `litematic2schem` / `python convert.py`):
+```bash
+lithetic sample_structure.litematic
+```
+
+Specify a custom output file path and multi-region overlap policy:
+```bash
+lithetic sample_structure.litematic -o my_building.schem --on-overlap keep-first
+```
+
+Display help menu:
+```bash
+lithetic --help
+```
+
+### 2. Windows Batch Script (`start.bat`)
+
+1. Double-click `start.bat`.
+2. Enter the name of your `.litematic` file when prompted (e.g., `house.litematic`).
+3. Your `.schem` file will be generated in the same directory.
+
+### 3. Running the Test Suite
+
+```bash
+python -m unittest discover -s tests -v
+```
+
+---
+
+## 📁 Project Structure
+
+```text
+litematic-to-schematic/
+├── pyproject.toml                  # PEP 621 package configuration & CLI entry points
+├── requirements.txt                # Runtime dependencies (litemapy, nbtlib)
+├── convert.py                      # Backward-compatible CLI/API wrapper script
+├── start.bat                       # Windows interactive batch launcher
+├── README.md                       # English documentation (default)
+├── README_TR.md                    # Turkish documentation
+├── LICENSE                         # MIT License
+├── src/
+│   └── litematic_to_schematic/
+│       ├── __init__.py             # Package version & public API exports
+│       ├── __main__.py             # `python -m litematic_to_schematic` entry point
+│       ├── converter.py            # Core Litematica -> Sponge V2 conversion engine
+│       └── cli.py                  # Argparse command-line interface
+└── tests/
+    └── test_converter.py           # Unit & integration test matrix (T01-T14)
+```
+
+---
+
+## 📜 License
+
+This project is licensed under the [MIT License](LICENSE).
+
+---
+
+## 👤 Author
+
+**Ohualtex**
+- GitHub: [@Ohualtex](https://github.com/Ohualtex)

litematic_to_schematic-1.0.0/README.md

@@ -0,0 +1,136 @@
+# 🛠️ Litematica to Schematic Converter
+
+![PyPI Version](https://img.shields.io/pypi/v/litematic-to-schematic.svg)
+![Python Version](https://img.shields.io/badge/python-3.8%2B-blue.svg)
+![License](https://img.shields.io/badge/license-MIT-green.svg)
+![Minecraft Version](https://img.shields.io/badge/minecraft-1.13%2B-orange.svg)
+![WorldEdit Format](https://img.shields.io/badge/format-Sponge%20V2%20(.schem)-brightgreen.svg)
+
+> Read this document in another language:  
+> 🇹🇷 **[Türkçe (Turkish)](README_TR.md)**
+
+A fast, reliable Python CLI tool and library to convert Minecraft **Litematica** (`.litematic`) schematics directly into **WorldEdit / FastAsyncWorldEdit (FAWE)** compatible **Sponge V2** (`.schem`) format.
+
+---
+
+## 🎯 Purpose
+
+In Minecraft, schematic files created by the Fabric/Quilt-based **Litematica** mod (`.litematic`) cannot be loaded directly by **WorldEdit** or **FAWE** plugins running on Forge, NeoForge, Paper, or Spigot servers.
+
+This tool parses Litematica files directly at the NBT level without launching a Minecraft client and converts them into standard Sponge V2 `.schem` files.
+
+---
+
+## ✨ Features
+
+- 🧩 **Multi-Region Merging & Conflict Policies**: Automatically computes the global bounding box across all regions in a `.litematic` file, aligns relative region offsets, prevents air blocks from erasing solid blocks, and provides configurable conflict resolution (`--on-overlap overwrite|keep-first|error`).
+- 📦 **Sponge V2 NBT Structure & Dynamic `DataVersion`**: Preserves the source schematic's `MinecraftDataVersion` (falling back to `2586` only if missing) and builds a Sponge V2 NBT tree (`Version: 2`).
+- 🧰 **BlockEntities & Entities Preservation**: Transfers container inventories (chests, barrels, shulker boxes, signs) and entities (armor stands, item frames, paintings, minecarts) with global coordinate alignment, `TileX/Y/Z` recalculation, and `UUID`/`Id` sanitization.
+- 🔧 **Modded & Vanilla Namespace Integrity**: Preserves custom mod namespaces (e.g., `create:brass_casing`, `ae2:controller[state=online]`) while automatically prefixing un-namespaced vanilla identifiers with `minecraft:`.
+- 🔢 **LEB128 VarInt Byte Encoding**: Encodes block palette indices into signed 8-bit NBT `ByteArray` streams using dynamic LEB128 VarInt encoding, supporting palettes of any size (`> 128` block states).
+- 📐 **Negative Coordinate Axis Alignment**: Regions saved with negative selection bounds in Litematica are automatically normalized to WorldEdit's `(Y * Length + Z) * Width + X` index ordering.
+
+---
+
+## 🧱 Minecraft Version Compatibility & Scope
+
+This converter supports **Minecraft 1.13+ schematics** (1.13 through 1.20, 1.21+, etc.).
+
+### Why is 1.13 the Minimum Supported Version?
+With Minecraft 1.13 (**"The Flattening"**), blocks transitioned from numeric IDs and metadata values (e.g., `35:14`) to string-based namespaced block states (e.g., `minecraft:red_wool`). Sponge V2 palettes rely strictly on string-based block states and do not support legacy 1.12.2 numeric IDs.
+
+### How Newer Versions & Modded Blocks Work
+Block IDs and block state properties (`block.id` and `block.properties`) are parsed dynamically from the input `.litematic` file alongside its `MinecraftDataVersion` tag, without a hardcoded block registry.
+
+### Known Format Limitations
+- **No Cross-Version Block ID Remapping**: The converter preserves the source schematic's `DataVersion` and block state strings as-is. Loading a 1.21 schematic on an older 1.16 server will not downgrade blocks that did not exist in 1.16.
+- **Pending Ticks**: Litematica's `PendingBlockTicks` and `PendingFluidTicks` have no standard equivalent in WorldEdit's Sponge V2 importer and are skipped with an informational console notice when present.
+- **Dimension Bounds**: Sponge V2 stores `Width`, `Height`, and `Length` as signed 16-bit `Short` integers, limiting each axis of the combined bounding box to a maximum of `32,767` blocks.
+
+---
+
+## 📥 Installation
+
+Ensure you have **Python 3.8+** installed on your system.
+
+### Option 1: Install from PyPI (Recommended)
+```bash
+pip install litematic-to-schematic
+```
+*(This automatically installs the `lithetic`, `litematic-to-schematic`, `litematic2schem`, and `litematic2schematic` CLI commands.)*
+
+### Option 2: Install from Source
+```bash
+git clone https://github.com/Ohualtex/litematic-to-schematic.git
+cd litematic-to-schematic
+pip install .
+```
+
+---
+
+## 🚀 Usage
+
+### 1. Command-Line Interface (CLI)
+
+Using the shorthand `lithetic` command (or `litematic-to-schematic` / `litematic2schem` / `python convert.py`):
+```bash
+lithetic sample_structure.litematic
+```
+
+Specify a custom output file path and multi-region overlap policy:
+```bash
+lithetic sample_structure.litematic -o my_building.schem --on-overlap keep-first
+```
+
+Display help menu:
+```bash
+lithetic --help
+```
+
+### 2. Windows Batch Script (`start.bat`)
+
+1. Double-click `start.bat`.
+2. Enter the name of your `.litematic` file when prompted (e.g., `house.litematic`).
+3. Your `.schem` file will be generated in the same directory.
+
+### 3. Running the Test Suite
+
+```bash
+python -m unittest discover -s tests -v
+```
+
+---
+
+## 📁 Project Structure
+
+```text
+litematic-to-schematic/
+├── pyproject.toml                  # PEP 621 package configuration & CLI entry points
+├── requirements.txt                # Runtime dependencies (litemapy, nbtlib)
+├── convert.py                      # Backward-compatible CLI/API wrapper script
+├── start.bat                       # Windows interactive batch launcher
+├── README.md                       # English documentation (default)
+├── README_TR.md                    # Turkish documentation
+├── LICENSE                         # MIT License
+├── src/
+│   └── litematic_to_schematic/
+│       ├── __init__.py             # Package version & public API exports
+│       ├── __main__.py             # `python -m litematic_to_schematic` entry point
+│       ├── converter.py            # Core Litematica -> Sponge V2 conversion engine
+│       └── cli.py                  # Argparse command-line interface
+└── tests/
+    └── test_converter.py           # Unit & integration test matrix (T01-T14)
+```
+
+---
+
+## 📜 License
+
+This project is licensed under the [MIT License](LICENSE).
+
+---
+
+## 👤 Author
+
+**Ohualtex**
+- GitHub: [@Ohualtex](https://github.com/Ohualtex)

litematic_to_schematic-1.0.0/pyproject.toml

@@ -0,0 +1,50 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "litematic-to-schematic"
+version = "1.0.0"
+description = "Convert Minecraft Litematica (.litematic) schematics directly to WorldEdit Sponge V2 (.schem) format."
+readme = "README.md"
+requires-python = ">=3.8"
+license = { file = "LICENSE" }
+authors = [
+    { name = "Ohualtex" }
+]
+keywords = ["minecraft", "litematica", "litematic", "schematic", "schem", "worldedit", "sponge", "lithetic"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: End Users/Desktop",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Games/Entertainment",
+    "Topic :: Utilities",
+]
+dependencies = [
+    "litemapy",
+    "nbtlib",
+]
+
+[project.urls]
+Homepage = "https://github.com/Ohualtex/litematic-to-schematic"
+Repository = "https://github.com/Ohualtex/litematic-to-schematic"
+Issues = "https://github.com/Ohualtex/litematic-to-schematic/issues"
+
+[project.scripts]
+litematic-to-schematic = "litematic_to_schematic.cli:main"
+litematic2schem = "litematic_to_schematic.cli:main"
+litematic2schematic = "litematic_to_schematic.cli:main"
+lithetic = "litematic_to_schematic.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+

litematic_to_schematic-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

litematic_to_schematic-1.0.0/src/litematic_to_schematic/__init__.py

@@ -0,0 +1,19 @@
+"""Litematica (.litematic) to WorldEdit Sponge V2 (.schem) converter package."""
+
+from .converter import (
+    litematic_to_schem_final,
+    normalize_identifier,
+    format_block_state,
+    encode_varint,
+    decode_varint,
+)
+
+__version__ = "1.0.0"
+__all__ = [
+    "litematic_to_schem_final",
+    "normalize_identifier",
+    "format_block_state",
+    "encode_varint",
+    "decode_varint",
+    "__version__",
+]

litematic_to_schematic-1.0.0/src/litematic_to_schematic/__main__.py

@@ -0,0 +1,5 @@
+from .cli import main
+
+if __name__ == "__main__":
+    main()
+

litematic_to_schematic-1.0.0/src/litematic_to_schematic/cli.py

@@ -0,0 +1,42 @@
+import os
+import sys
+import argparse
+from .converter import litematic_to_schem_final, VALID_OVERLAP_POLICIES
+
+
+def build_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(
+        description="Converts Litematica files (.litematic) directly to WorldEdit Sponge V2 Schematic (.schem) format."
+    )
+    parser.add_argument("input", help="Path to the input .litematic file")
+    parser.add_argument("-o", "--output", help="Optional: Custom output .schem file path", default=None)
+    parser.add_argument(
+        "--on-overlap",
+        choices=VALID_OVERLAP_POLICIES,
+        default="overwrite",
+        help="Conflict resolution policy when multiple regions overlap with non-air blocks (default: overwrite)",
+    )
+    return parser
+
+
+def main(argv=None) -> int:
+    parser = build_parser()
+    args = parser.parse_args(argv)
+
+    input_file = args.input
+
+    if args.output:
+        output_file = args.output
+    else:
+        # Strip extension and append .schem
+        base_name = os.path.splitext(input_file)[0]
+        output_file = f"{base_name}.schem"
+
+    success = litematic_to_schem_final(input_file, output_file, on_overlap=args.on_overlap)
+    if not success:
+        sys.exit(1)
+    return 0
+
+
+if __name__ == "__main__":
+    main()