astrbot_plugin_imagestudio/README.md

80 行
2.2 KiB
Markdown

2026-07-04 22:51:52 +08:00
# 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:
```text
character_profiles
-> profile_workflows
-> workflow_nodes
-> generation_tasks
-> generation_images
```
## Current Stage
This repository has completed `S0-1` and started the S0 backend foundation.
Implemented foundation:
- v3 directory and configuration baseline.
- Common API response helpers matching the v3 contract.
- Request context and permission guard helpers.
- Database helper with SQLite default and optional PostgreSQL selection.
- Initial `audit_logs` migration and audit recording service.
2026-07-04 22:51:52 +08:00
Next tasks:
1. Finish route-level usage of S0 helpers.
2. `S1-1` `character_profiles` table, repository, and service.
3. `S1-2` `profile_workflows` and `workflow_nodes`.
4. `S1-3` `generation_images`.
5. `S2-1` `ui/bootstrap`.
2026-07-04 22:51:52 +08:00
## Repository Layout
```text
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.