astrbot_plugin_imagestudio/README.md

2.7 KiB

AstrBot ImageStudio

AstrBot ImageStudio is an AstrBot role asset production and image-generation workspace plugin.

It provides two UI surfaces:

  • AstrBot Plugin Page UI for lightweight status, queue, recent jobs, and quick entry points.
  • Standalone Web UI mounted under AstrBot's plugin extension route for the full workspace.

Both UIs share one backend API, database, queue model, VFS media layer, material library, wardrobe system, and audit trail.

Development Baseline

Use the v3 documents as the source of truth:

  1. imagestudio_full_plugin_dev_doc_v3_ui_adjusted.md
  2. imagestudio_api_contract_v3_ui_adjusted.md
  3. imagestudio_codex_hermes_dev_flow_v3.md

Older v0.1 planning is superseded by v3. In v3, the central fact chain is:

character_profiles
  -> profile_workflows
  -> workflow_nodes
  -> generation_tasks
  -> generation_images

Current Stage

The non-UI backend queue through S120 is implemented. UI-only stages remain separate.

Implemented backend foundation and operations:

  • AstrBot runtime registration manifest and pure dispatch helpers.
  • v3 response helpers, request context, permission guards, and permission matrix export.
  • SQLite default database with optional PostgreSQL via psycopg or psycopg2.
  • Migrations, repositories, audit logging, config snapshots, route registry, and contract export.
  • Profiles, workflows, nodes, queues, images, media signing, material library, wardrobe, integrations, costs, review policy, model provider routing, and worker infrastructure.
  • Real image-provider adapter path, VLM adapter interface, prompt expansion, budget guard, token rotation, safe deletion, media index, orphan scanning, PG smoke, and non-UI smoke scripts.

Useful entry points:

  • main.get_plugin_manifest()
  • main.register_plugin(runtime)
  • main.dispatch_web_request(...)
  • scripts/imagestudio_non_ui_smoke.py
  • scripts/imagestudio_pg_smoke.py

For installation, packaging, smoke checks, and PG setup, see INSTALL.md.

Repository Layout

main.py
metadata.yaml
_conf_schema.json
config.yaml
adapters/
core/
engines/
backend/
database/
assets_builtin/
pages/imagestudio/
web/
frontend/
data/

The root directory is the plugin repository root. Do not introduce a second backend service or a standalone web port.

Non-Negotiable Rules

  • Standalone Web UI must be served by AstrBot plugin extension routes.
  • Plugin Page UI and Standalone Web UI must call the same backend API.
  • Frontend code must not read or construct real disk paths.
  • API keys and tokens must not be returned to the frontend in plain text.
  • Every write operation must record audit_logs.
  • Generated images must have generation_images records.
  • Media access must go through signed media APIs.