Add WallCraft AI MVP scaffolding and documentation

This commit is contained in:
Jamie Miller
2026-02-06 07:48:40 +00:00
parent cabd4ecf66
commit 34da1bc90b
15 changed files with 524 additions and 0 deletions

25
quick-start.md Normal file
View File

@@ -0,0 +1,25 @@
WallCraft AI Quick Start (MVP)
What youll get
- A cloud-driven FoundryVTT MVP to generate walls (including doors/windows) for the current scene.
- Non-destructive preview with manual adjustments before applying.
Setup
- Install FoundryVTT module (WallCraft AI) for FoundryVTT v13.0.351
- Configure cloud endpoint URL and API token in Settings
- Ensure the cloud AI endpoint is reachable via HTTPS
How to use
- In FoundryVTT, open a scene and click the WallCraft AI Prep button in the Scene toolbar
- The module collects scene data and sends a fixed prompt to the cloud AI
- See a translucent preview of AI-generated walls
- Use the adjustment panel to tweak endpoints or types if needed
- Click Apply to persist walls to the scene
- Review chat/journal log for traceability
Notes
- Batching and multi-scene processing are not part of MVP; plan for future sprints if you want to scale.
- Security: only necessary scene data is sent; token remains with you.
Next steps
- If youd like, I can generate concrete starter patches (module.json + a minimal AIPrep.js skeleton and the SettingsPanel), plus the exact payload shapes ready to patch into your repo. I can also tailor naming and endpoint paths to your preferred conventions.