1. Always Begin With VStitcher UI
Even if the final goal is 100% headless automation, the UI version of VStitcher is essential during onboarding.
Why provide a VStitcher UI temporary license?
Developers must understand how garments behave before automating them.
They can visually see what API actions do (snapshots, colorways, materials, physics, simulation, etc.).
Python API experimentation is dramatically easier inside the UI (via plugins).
Ensures correct interpretation of presets, garment structure, and asset organization.
Headless-only onboarding is not recommended - it may cause confusion and slow down development.
2. Use Python Playground Inside VStitcher UI
Python Playground plugin:
🔗 https://help.browzwear.com/en/articles/13066078-pythonplayground
Why Python Playground is the best starting point
Lets you run Python scripts directly inside the UI.
Shows immediate visual results of API calls.
Perfect for experimenting with:
Snapshots
Materials / avatars
Simulation
Render presets
Geometry export
Provides a safe sandbox before moving scripts into VS-CLI.
They can even trigger headless-style scripts
Scripts created/tested in Playground can be run unchanged inside VS-CLI.
This creates a smooth transition from UI → automation.
3. Start With the Sample Plugin (Strongly Recommended)
Sample Plugin (Python):
🔗 https://help.browzwear.com/en/articles/13066080-samplepluginpython
Why the Sample Plugin accelerates development
Contains a working garment, snapshot, and asset structure.
Demonstrates plugin lifecycle and VStitcher API usage.
Shows how to structure production-ready code.
Includes examples of:
loading garment and and basic garment lifecycle operations
how to work with colorways and materials
loading and using snapshots
render and export views as files
geometry, patterns and layout operations
… and more!
Example Garment Included
Teams do NOT need to ask for a test garment. It is already packaged inside the Sample Plugin.
4. Review the API Reference & Header Files
Header files describe the underlying VStitcher API surface:
🔗 https://help.browzwear.com/en/articles/13066143-header-files
Why these files matter
They define the functions exposed to Python via BwApi.
They clarify naming, data structures, enums, and fields.
They highlight what operations VStitcher supports headless.
These files are the best technical reference for automation developers.
5. Use VS-CLI Only After Understanding UI Behavior
Once developers:
Know how garments behave in VStitcher UI
Understand snapshots, materials, and render setup
Have tested scripts inside Python Playground
Have tried real examples from the Sample Plugin
Then they are ready to run scripts inside VS-CLI.
This ensures:
Fewer errors
Faster debugging
More predictable automation output
And significantly reduces support overhead.
6. Browzwear University Is Required Learning
BW University contains training on:
Avatars
Garments
Simulation
Rendering
Tech packs / workflows
Production garment processes
Why it matters for VS-CLI users
VS-CLI scripts manipulate garments the exact same way users do in the UI.
If a team does not understand:
How to load a snapshot
What a colorway is
What simulation states exist
How render presets work
Automation results will be incorrect or inconsistent.
7. Summary: The Recommended Onboarding Flow
Step 1: Install VStitcher UI + temporary license
Understand garment behavior visually.
Step 2: Use Python Playground to experiment with API
Instant feedback → faster development.
Step 3: Explore Sample Plugin & example garment
Learn correct API usage and workflow structure.
Step 4: Review Header Files & API references
Understand functions that VS-CLI relies on.
Step 5: Move scripts into VS-CLI and run headless
After validation in UI, automation becomes predictable.
Step 6: Complete training via Browzwear University
Ensures teams understand garment fundamentals.