Ghostlight/scripts/README.md
2026-05-03 12:53:58 +01:00

1.4 KiB

Ghostlight Scripts

BFL Image Generation

generate_bfl_images.py submits prompts to the Black Forest Labs async image API, polls the returned polling_url, downloads the signed result.sample image immediately, and writes a metadata receipt beside the image.

The script reads the API key from BFL_API_KEY first. If that is not set, it falls back to E:\Projects\gamecult-ops\bfl-api.txt. It never prints the key.

Dry-run a direct prompt:

npm run images:bfl -- --prompt "A maintenance yard in a rotating asteroid habitat" --dry-run

Dry-run one Ghostlight visual scene prompt:

npm run images:bfl -- --visual-plan examples\visual\pallas-species-strikes.branch-and-fold.v0.visual.json --scene-id pallas_yard_wake --dry-run

Submit one paid render:

npm run images:bfl -- --visual-plan examples\visual\pallas-species-strikes.branch-and-fold.v0.visual.json --scene-id pallas_yard_wake --width 1536 --height 864 --output-format png --yes

Render every base scene from a visual plan:

npm run images:bfl -- --visual-plan examples\visual\pallas-species-strikes.branch-and-fold.v0.visual.json --all-scenes --width 1536 --height 864 --output-format png --yes

Generated images and receipts go under experiments/images/, which is ignored by git. Move curated artifacts elsewhere deliberately if they need to become project assets.