1. Visual Studio Code (VS Code)
Why it matters
VS Code is the primary editor recommended for:
Writing Python scripts that control VStitcher-CLI.
Creating and maintaining custom plugins or automation scripts.
Editing JSON presets, XML configuration, or integration scripts.
Inspecting log files or CLI output.
Key benefits:
Cross-platform (Windows, macOS, Linux)
Excellent Python support (formatting, debugging, linting)
Extensions useful for CLI/Headless workflows, such as:
Python
JSON Tools
Git Integration
REST Client (for testing cloud endpoints)
SSH Remote Development (for debugging on remote servers)
2. Zendesk (Support Platform)
Why it matters
You will often rely on Zendesk when working with headless or automated systems to:
Track support tickets related to CLI behaviors, exports, crashes, Unreal engine logs, or garment-processing issues.
Review reported logs from customers or internal testers.
View internal Browzwear engineering updates, linked documentation, or ticket references.
Coordinate escalations with R&D teams.
Typical Uses:
Sending a reproducible example along with CLI logs.
Tracking issues such as:
Unreal render engine failures
License connection problems
Differences between desktop VS and headless CLI output
Missing dependencies (MKL, OpenGL, DX12, etc.)
Zendesk is crucial for maintaining traceability and ensuring that issues discovered in headless environments get the appropriate visibility.
3. Sample Plugins, Boilerplates, and Header Files
Sample plugins & boilerplates
Header files
These are some of the most important resources available to developers working with headless VStitcher environment.
Why they matter
Understanding the VStitcher API (BwApi)
The header files define:
Available API functions
Data structures
Expected inputs/outputs
Supported rendering or garment manipulation commands
Even though Python is used for CLI scripting, the API is often informed by the same interface definitions. Reading the header files helps developers understand what is possible and how BW’s internal logic is structured.
Starting point for automation workflows
Sample plugins and boilerplates show:
How to structure a project
How to load garments
How to manipulate snapshots
How to export images or 3D assets
How to listen to events or respond to garment updates
Even if your final workflow runs headless, plugin samples show how to interact with the BwApi, which is the same foundation used by CLI scripts.
Validating compatibility
When adding automation on top of Browzwear functionality, reviewing official boilerplates ensures:
You are using supported API calls
Your script logic is compatible with current and future VStitcher versions
You avoid deprecated or unstable internal functions
This is especially important for long-running or cloud environments where silent execution is mandatory.