CLI / Automatisierung (Übersicht)
Jede Operation der App lässt sich headless aufrufen — für Skripte, Pipelines und Batch-Läufe über einen ganzen Ordner.
Kurzbeschreibung
Die App ist auch ein Kommandozeilen-Werkzeug: dieselbe Verarbeitung, die du in der Oberfläche klickst, läuft headless für Skripte, Build-Pipelines und das stapelweise Abarbeiten ganzer Ordner. Diese Seite beschreibt das Globale — Aufruf, Positional-Argumente, Operationen und die Flags, die mehrere Features teilen. Die feature-spezifischen Flags und je ein Beispielbefehl stehen im „CLI / Automatisierung"-Abschnitt der jeweiligen Feature-Seite (siehe Pro Feature).
Aufruf
Zwei gleichwertige Wege:
# Python-Skript (Entwicklung / aus dem Repo)
py -3.12 clean_sprite_chromakey.py [optionen] input output
# gebaute Anwendung (Release-EXE)
clean_sprite_chromakey.exe [optionen] input output
In den Beispielen auf den Feature-Seiten steht stellvertretend clean_sprite_chromakey.py — ersetze
es bei einer Installation durch die EXE. Hilfe und Version:
clean_sprite_chromakey.py --help # vollständige Flag-Liste (Quelle der Wahrheit)
clean_sprite_chromakey.py --version
Positional-Argumente
| Argument | Bedeutung |
|---|---|
input |
Eingabe-PNG (Sprite-Sheet / Asset). |
output |
Ausgabe-PNG. Bei zerschneidenden Operationen (Slice / SliceX) der Ziel-/Basis-Pfad für die einzelnen Zellen. |
--debug-output PFAD |
Optionales Debug-PNG, über #00FF00 kompositiert (Alias --preview-output). |
Beide Positional-Argumente beziehen sich auf eine Datei; einen Ordner-Modus hat die CLI nicht. Die CLI ist die Automatisierungs-Oberfläche und gehört zum Batch-Modul — geskriptetes Stapelverarbeiten (die CLI in einer Schleife über einen Ordner) erfordert dasselbe Entitlement wie die GUI-Batch-Verarbeitung; es ist kein kostenloser Umweg um das Batch-Modul.
Operation wählen (--operation)
Welche Verarbeitung läuft, bestimmt --operation. Default ist chromakey.
--operation |
Feature | Flag-Gruppe |
|---|---|---|
chromakey (Default) |
Chroma-Key-Profile | --profile + die gemeinsamen Key-Flags |
undetail |
Pixelart UnDetail | --undetail-* |
slice |
Asset Slice | --slice-* |
slice-grid |
Asset SliceX | --slice-grid-xs / --slice-grid-ys |
pixelize |
Pixelize | --pixelize-* |
Profil wählen (--profile, nur chromakey)
Bei --operation chromakey wählt --profile das Reinigungsprofil (Default auto):
--profile |
Feature |
|---|---|
auto |
Auto — Key pro Bild messen, Soft-Matte, Passthrough ohne Key |
green |
Green Sprite |
green_hard |
Green Sprite (hart, inhalt-sicher) |
residue |
Reste entfernen (Residue Repair) |
magenta_sprite |
Magenta Sprite / Outline |
magenta_fx |
Magenta FX / Water |
magenta_fx_plus |
Magenta FX / Water Plus |
custom |
Custom Color |
fx_glow |
FX / Glow (Soft-Matte) |
Gemeinsame Flags
Diese Flags teilen sich mehrere Chroma-Key-Profile (Details und sinnvolle Werte auf der jeweiligen Feature-Seite):
| Flag | Wirkung | Gilt für |
|---|---|---|
--key-color #RRGGBB (Alias --chromakey-color) |
Keyfarbe als #RRGGBB oder R,G,B. Default #00FF00. |
Green / Green-Hard / Magenta-* / Custom |
--key-tolerance 0–160 |
RGB-Distanz-Toleranz (Default 48). | Custom + Auto-Custom-Key |
--edge-cleanup {on,off} |
Kanten-Cleanup; off entfernt nur den Hintergrund. |
Green / Green-Hard / Magenta-* / Custom |
--spill-radius 1–4 |
Breite des Kantenbands (Default 2). | Profile mit Saum-Despill |
--spill-strength {conservative,normal,strong,maximum} |
Aggressivität der Kanten-Korrektur. | Magenta-* / Green-Repair |
--green-repair {off,soft,normal,strong} |
Black-/Magic-Outline-Repair für kontaminierte Grün-Kanten. | Green Sprite |
Profil- bzw. operationsspezifische Flags (--residue-*, --fx-*, --undetail-*, --slice-*,
--pixelize-*) sind im CLI-Abschnitt des jeweiligen Features dokumentiert.
Utilities
| Flag | Wirkung |
|---|---|
--check-update |
Prüft den Update-Feed und meldet, ob eine neuere Version existiert → Update-Check. |
--version |
Versionsnummer ausgeben. |
--gui |
Öffnet die grafische Oberfläche statt headless zu verarbeiten. |
--stamp-metadata |
Debug: schreibt die angewandten Parameter als tEXt-Metadaten in die Ausgabe (v. a. fürs Residue-Profil). |
Was GUI-only ist
Folgendes hat kein CLI-Pendant — es lebt nur in der Oberfläche (--gui):
- Interaktive Batch-Verarbeitung (Dateiliste, Überschreibstrategie, Report, Abbruch) → Batch-Verarbeitung. Das headless-Pendant ist die geskriptete CLI-Schleife — beides gehört zum Batch-Modul.
- Pipette / Farbe aus dem Bild picken — auf der CLI gibst du die Keyfarbe direkt mit
--key-coloran. - Live-Linien-Ziehen bei Asset SliceX — auf der CLI nennst du die Schnittpositionen numerisch
(
--slice-grid-xs/--slice-grid-ys). - Vorschau- / Maskenansicht, Presets, „Zielordner öffnen" — reine Oberflächen-Komfortfunktionen.
Pro Feature
Jede Feature-Seite hat einen eigenen „CLI / Automatisierung"-Abschnitt mit den relevanten Flags und einem Beispielbefehl — diese Übersicht verlinkt dorthin, die Feature-Abschnitte verlinken zurück hierher:
- Chroma-Key: Green Sprite · Green Sprite (hart) · Reste entfernen · Auto · Custom Color · Magenta Sprite · Magenta FX · Magenta FX Plus · FX / Glow
- Transform: Pixelart UnDetail · Asset Slice · Asset SliceX · Pixelize
- Utility: Update-Check
Maßgeblich bleibt
clean_sprite_chromakey.py --help— bei Abweichungen gilt die Ausgabe der App.