retrotool-libsfx 2026.5.15__tar.gz

retrotool_libsfx-2026.5.15/MANIFEST.in

@@ -0,0 +1,12 @@
+include README.md
+include setup.py
+include pyproject.toml
+recursive-include vendor *
+recursive-include retrotool_libsfx/bin *
+recursive-include retrotool_libsfx/include *
+recursive-include retrotool_libsfx/examples *
+global-exclude __pycache__
+global-exclude *.py[cod]
+global-exclude .gitignore
+prune vendor/.git
+prune vendor/**/.git

retrotool_libsfx-2026.5.15/PKG-INFO

@@ -0,0 +1,83 @@
+Metadata-Version: 2.4
+Name: retrotool-libsfx
+Version: 2026.5.15
+Summary: Bundled Optiroc SNES toolchain (libSFX, SuperFamiconv, ca65, SuperFamicheck, brrtools, lz4) for retrotool
+Author-email: Daniel Burgess <daniel@herotechsys.com>
+License: MIT AND Zlib AND BSD-2-Clause
+Keywords: snes,sfc,libsfx,superfamiconv,ca65,brrtools,toolchain
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Multimedia :: Graphics
+Classifier: Topic :: Software Development :: Assemblers
+Classifier: Topic :: Software Development :: Build Tools
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# retrotool-libsfx
+
+Bundled [Optiroc](https://github.com/Optiroc) SNES toolchain for the `retrotool`
+build pipeline. One wheel, one install, whole stack.
+
+## What's inside
+
+Built from vendored upstream sources (git submodules) during wheel construction:
+
+| Tool | Upstream | Purpose |
+|------|----------|---------|
+| [libSFX](https://github.com/Optiroc/libSFX) | `vendor/libSFX` | 65816 asm framework (headers + macros, no binary) |
+| [SuperFamiconv](https://github.com/Optiroc/SuperFamiconv) | `vendor/SuperFamiconv` | PNG → tiles / palette / tilemap converter |
+| [SuperFamicheck](https://github.com/Optiroc/SuperFamicheck) | `vendor/SuperFamicheck` | SNES header + checksum fixer |
+| [BRRtools](https://github.com/Optiroc/BRRtools) | `vendor/BRRtools` | BRR audio encode/decode |
+| [lz4](https://github.com/lz4/lz4) | `vendor/lz4` | reference LZ4 compressor |
+| [cc65](https://github.com/cc65/cc65) | `vendor/cc65` | ca65/ld65 assembler + linker for libSFX projects |
+| [make_breakpoints](https://github.com/Optiroc/make_breakpoints) | `vendor/make_breakpoints` | ld65 symbols → Mesen breakpoints |
+
+`retrotool` can drive the whole chain from a `project.toml` or MBXML file.
+Users can pick either **ca65** (shipped here) or **asar** (existing retrotool
+asm module) as the assembler, per project.
+
+## Installation
+
+```sh
+pip install retrotool[libsfx]      # 0.9.0+
+```
+
+Base `retrotool` stays pure-python; the toolchain is opt-in via this extra.
+
+## Setup (development)
+
+```sh
+git submodule update --init --recursive
+cd packages/retrotool-libsfx
+python -m pip install build
+python -m build --wheel
+```
+
+On platforms where not every submodule builds cleanly (yet), `setup.py` skips
+missing submodules with a warning rather than failing — useful during the
+0.8.x → 0.9.0 staged rollout.
+
+## Usage
+
+```python
+from retrotool_libsfx import (
+    superfamiconv_binary, superfamicheck_binary,
+    ca65_binary, ld65_binary, brr_encoder_binary, lz4_binary,
+    libsfx_include_dir, libsfx_config_dir,
+    run_superfamiconv, run_ca65, run_ld65,
+    ToolNotBundledError,
+)
+
+run_superfamiconv(["tiles", "-i", "bg.png", "-d", "bg.tiles", "-B", "4"])
+```
+
+## License
+
+This wrapper package: MIT. Vendored tools retain their own licenses; see each
+submodule's LICENSE file.

retrotool_libsfx-2026.5.15/README.md

@@ -0,0 +1,62 @@
+# retrotool-libsfx
+
+Bundled [Optiroc](https://github.com/Optiroc) SNES toolchain for the `retrotool`
+build pipeline. One wheel, one install, whole stack.
+
+## What's inside
+
+Built from vendored upstream sources (git submodules) during wheel construction:
+
+| Tool | Upstream | Purpose |
+|------|----------|---------|
+| [libSFX](https://github.com/Optiroc/libSFX) | `vendor/libSFX` | 65816 asm framework (headers + macros, no binary) |
+| [SuperFamiconv](https://github.com/Optiroc/SuperFamiconv) | `vendor/SuperFamiconv` | PNG → tiles / palette / tilemap converter |
+| [SuperFamicheck](https://github.com/Optiroc/SuperFamicheck) | `vendor/SuperFamicheck` | SNES header + checksum fixer |
+| [BRRtools](https://github.com/Optiroc/BRRtools) | `vendor/BRRtools` | BRR audio encode/decode |
+| [lz4](https://github.com/lz4/lz4) | `vendor/lz4` | reference LZ4 compressor |
+| [cc65](https://github.com/cc65/cc65) | `vendor/cc65` | ca65/ld65 assembler + linker for libSFX projects |
+| [make_breakpoints](https://github.com/Optiroc/make_breakpoints) | `vendor/make_breakpoints` | ld65 symbols → Mesen breakpoints |
+
+`retrotool` can drive the whole chain from a `project.toml` or MBXML file.
+Users can pick either **ca65** (shipped here) or **asar** (existing retrotool
+asm module) as the assembler, per project.
+
+## Installation
+
+```sh
+pip install retrotool[libsfx]      # 0.9.0+
+```
+
+Base `retrotool` stays pure-python; the toolchain is opt-in via this extra.
+
+## Setup (development)
+
+```sh
+git submodule update --init --recursive
+cd packages/retrotool-libsfx
+python -m pip install build
+python -m build --wheel
+```
+
+On platforms where not every submodule builds cleanly (yet), `setup.py` skips
+missing submodules with a warning rather than failing — useful during the
+0.8.x → 0.9.0 staged rollout.
+
+## Usage
+
+```python
+from retrotool_libsfx import (
+    superfamiconv_binary, superfamicheck_binary,
+    ca65_binary, ld65_binary, brr_encoder_binary, lz4_binary,
+    libsfx_include_dir, libsfx_config_dir,
+    run_superfamiconv, run_ca65, run_ld65,
+    ToolNotBundledError,
+)
+
+run_superfamiconv(["tiles", "-i", "bg.png", "-d", "bg.tiles", "-B", "4"])
+```
+
+## License
+
+This wrapper package: MIT. Vendored tools retain their own licenses; see each
+submodule's LICENSE file.

retrotool_libsfx-2026.5.15/pyproject.toml

@@ -0,0 +1,46 @@
+[project]
+name = "retrotool-libsfx"
+version = "2026.5.15"
+description = "Bundled Optiroc SNES toolchain (libSFX, SuperFamiconv, ca65, SuperFamicheck, brrtools, lz4) for retrotool"
+readme = "README.md"
+authors = [{name = "Daniel Burgess", email = "daniel@herotechsys.com"}]
+license = {text = "MIT AND Zlib AND BSD-2-Clause"}
+requires-python = ">=3.12"
+keywords = ["snes", "sfc", "libsfx", "superfamiconv", "ca65", "brrtools", "toolchain"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: MacOS",
+    "Operating System :: Microsoft :: Windows",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Multimedia :: Graphics",
+    "Topic :: Software Development :: Assemblers",
+    "Topic :: Software Development :: Build Tools",
+]
+
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+packages = ["retrotool_libsfx"]
+
+[tool.setuptools.package-data]
+retrotool_libsfx = ["bin/*", "include/**/*", "examples/**/*", "licenses/*"]
+
+[tool.cibuildwheel]
+skip = ["pp*", "*-musllinux_*", "cp36-*", "cp37-*", "cp38-*", "cp39-*", "cp310-*", "cp311-*"]
+build-verbosity = 1
+
+[tool.cibuildwheel.linux]
+before-all = "yum install -y gcc-c++ make cmake || { apt-get update && apt-get install -y g++ make cmake; }"
+archs = ["x86_64", "aarch64"]
+
+[tool.cibuildwheel.macos]
+archs = ["x86_64", "arm64"]
+
+[tool.cibuildwheel.windows]
+archs = ["AMD64"]

retrotool_libsfx-2026.5.15/retrotool_libsfx/__init__.py

@@ -0,0 +1,106 @@
+"""Bundled Optiroc SNES toolchain accessors.
+
+Each `*_binary()` function returns the absolute path to a bundled executable,
+or raises `ToolNotBundledError` if the wheel was built without that tool
+(e.g. the 0.8.x release only ships SuperFamiconv; the full toolchain lands
+in retrotool 0.9.0).
+
+Each `run_*` helper is a `subprocess.run` convenience wrapper.
+"""
+from __future__ import annotations
+
+import subprocess
+import sys
+from importlib.resources import files
+from pathlib import Path
+
+__version__ = "2026.5.15"
+
+_EXE = ".exe" if sys.platform == "win32" else ""
+
+
+class ToolNotBundledError(FileNotFoundError):
+    """Raised when a bundled tool binary is not present in this wheel."""
+
+
+def _binary(name: str) -> Path:
+    p = Path(str(files(__package__) / "bin" / f"{name}{_EXE}"))
+    if not p.exists():
+        raise ToolNotBundledError(
+            f"Bundled `{name}` missing at {p}. This retrotool-libsfx wheel "
+            f"was built without {name}. Reinstall, or build retrotool-libsfx "
+            f"from sdist with the corresponding vendor/ submodule populated."
+        )
+    return p
+
+
+# Individual binary accessors
+def superfamiconv_binary() -> Path:     return _binary("superfamiconv")
+def superfamicheck_binary() -> Path:    return _binary("superfamicheck")
+def brr_encoder_binary() -> Path:       return _binary("brr_encoder")
+def brr_decoder_binary() -> Path:       return _binary("brr_decoder")
+def lz4_binary() -> Path:               return _binary("lz4")
+def ca65_binary() -> Path:              return _binary("ca65")
+def ld65_binary() -> Path:              return _binary("ld65")
+def cc65_binary() -> Path:              return _binary("cc65")
+def co65_binary() -> Path:              return _binary("co65")
+def ar65_binary() -> Path:              return _binary("ar65")
+def make_breakpoints_binary() -> Path:  return _binary("make_breakpoints")
+
+
+# libSFX asm runtime (header tree, not executable)
+def libsfx_include_dir() -> Path:
+    p = Path(str(files(__package__) / "include"))
+    if not p.exists():
+        raise ToolNotBundledError(
+            f"libSFX include tree missing at {p}. Build from sdist with "
+            f"vendor/libSFX populated."
+        )
+    return p
+
+
+def libsfx_config_dir() -> Path:
+    p = Path(str(files(__package__) / "include" / "Configurations"))
+    if not p.exists():
+        raise ToolNotBundledError(f"libSFX Configurations/ missing at {p}.")
+    return p
+
+
+def libsfx_packages_dir() -> Path:
+    return Path(str(files(__package__) / "include" / "Packages"))
+
+
+def libsfx_examples_dir() -> Path:
+    p = Path(str(files(__package__) / "examples"))
+    if not p.exists():
+        raise ToolNotBundledError(
+            f"libSFX examples tree missing at {p}. Reinstall retrotool-libsfx "
+            f"from an sdist/wheel built after examples/ was bundled."
+        )
+    return p
+
+
+# subprocess wrappers
+def _run(bin_fn, args: list[str], **kwargs) -> subprocess.CompletedProcess:
+    kwargs.setdefault("check", True)
+    return subprocess.run([str(bin_fn()), *args], **kwargs)
+
+
+def run_superfamiconv(args, **kw):    return _run(superfamiconv_binary, args, **kw)
+def run_superfamicheck(args, **kw):   return _run(superfamicheck_binary, args, **kw)
+def run_brr_encoder(args, **kw):      return _run(brr_encoder_binary, args, **kw)
+def run_brr_decoder(args, **kw):      return _run(brr_decoder_binary, args, **kw)
+def run_lz4(args, **kw):              return _run(lz4_binary, args, **kw)
+def run_ca65(args, **kw):             return _run(ca65_binary, args, **kw)
+def run_ld65(args, **kw):             return _run(ld65_binary, args, **kw)
+def run_make_breakpoints(args, **kw): return _run(make_breakpoints_binary, args, **kw)
+
+
+# Back-compat alias for the pre-rename API (retrotool.graphics.superfamiconv
+# imported `binary_path` when this package was still `retrotool-superfamiconv`).
+def binary_path() -> Path:
+    return superfamiconv_binary()
+
+
+def run(args, **kw):
+    return run_superfamiconv(args, **kw)

retrotool_libsfx-2026.5.15/retrotool_libsfx.egg-info/PKG-INFO

@@ -0,0 +1,83 @@
+Metadata-Version: 2.4
+Name: retrotool-libsfx
+Version: 2026.5.15
+Summary: Bundled Optiroc SNES toolchain (libSFX, SuperFamiconv, ca65, SuperFamicheck, brrtools, lz4) for retrotool
+Author-email: Daniel Burgess <daniel@herotechsys.com>
+License: MIT AND Zlib AND BSD-2-Clause
+Keywords: snes,sfc,libsfx,superfamiconv,ca65,brrtools,toolchain
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Multimedia :: Graphics
+Classifier: Topic :: Software Development :: Assemblers
+Classifier: Topic :: Software Development :: Build Tools
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# retrotool-libsfx
+
+Bundled [Optiroc](https://github.com/Optiroc) SNES toolchain for the `retrotool`
+build pipeline. One wheel, one install, whole stack.
+
+## What's inside
+
+Built from vendored upstream sources (git submodules) during wheel construction:
+
+| Tool | Upstream | Purpose |
+|------|----------|---------|
+| [libSFX](https://github.com/Optiroc/libSFX) | `vendor/libSFX` | 65816 asm framework (headers + macros, no binary) |
+| [SuperFamiconv](https://github.com/Optiroc/SuperFamiconv) | `vendor/SuperFamiconv` | PNG → tiles / palette / tilemap converter |
+| [SuperFamicheck](https://github.com/Optiroc/SuperFamicheck) | `vendor/SuperFamicheck` | SNES header + checksum fixer |
+| [BRRtools](https://github.com/Optiroc/BRRtools) | `vendor/BRRtools` | BRR audio encode/decode |
+| [lz4](https://github.com/lz4/lz4) | `vendor/lz4` | reference LZ4 compressor |
+| [cc65](https://github.com/cc65/cc65) | `vendor/cc65` | ca65/ld65 assembler + linker for libSFX projects |
+| [make_breakpoints](https://github.com/Optiroc/make_breakpoints) | `vendor/make_breakpoints` | ld65 symbols → Mesen breakpoints |
+
+`retrotool` can drive the whole chain from a `project.toml` or MBXML file.
+Users can pick either **ca65** (shipped here) or **asar** (existing retrotool
+asm module) as the assembler, per project.
+
+## Installation
+
+```sh
+pip install retrotool[libsfx]      # 0.9.0+
+```
+
+Base `retrotool` stays pure-python; the toolchain is opt-in via this extra.
+
+## Setup (development)
+
+```sh
+git submodule update --init --recursive
+cd packages/retrotool-libsfx
+python -m pip install build
+python -m build --wheel
+```
+
+On platforms where not every submodule builds cleanly (yet), `setup.py` skips
+missing submodules with a warning rather than failing — useful during the
+0.8.x → 0.9.0 staged rollout.
+
+## Usage
+
+```python
+from retrotool_libsfx import (
+    superfamiconv_binary, superfamicheck_binary,
+    ca65_binary, ld65_binary, brr_encoder_binary, lz4_binary,
+    libsfx_include_dir, libsfx_config_dir,
+    run_superfamiconv, run_ca65, run_ld65,
+    ToolNotBundledError,
+)
+
+run_superfamiconv(["tiles", "-i", "bg.png", "-d", "bg.tiles", "-B", "4"])
+```
+
+## License
+
+This wrapper package: MIT. Vendored tools retain their own licenses; see each
+submodule's LICENSE file.