Browzwear

Open Platform

This page explains how to install, activate, and run VStitcher-CLI on Windows or macOS, including a sample script for testing automation workflows.

VStitcher-CLI — Local Installation & Usage Guide

When developing automation workflows, integrations, or server-side processing with VStitcher-CLI, several tools make development, debugging, and support significantly easier.

Recommended Tools When Working With VStitcher Engine

VStitcher-CLI enables automated, headless garment processing: rendering, exporting assets, applying colorways and materials. This guide explains the recommended starting points for new teams or developers adopting VS-CLI.

How to Start Working With VStitcher Engine (VS-CLI)

This page collects practical tips and best practices that help teams work efficiently with VStitcher-CLI, BwAPI, and headless workflows.

VStitcher-CLI – Tips & Tricks

VStitcher-CLI live examples

Debugging VStitcher-CLI Scripts with Python Playground

The purpose of this document is to explain how to debug a VStitcher/Lotta Python plugin with Visual Studio Code.

Debugging VStitcher Python plugins

When working with VS-CLI through BwApi, errors are reported using VStitcher error codes. Understanding how and where these codes appear is essential for effective debugging.

VStitcher Error Codes and Error Diagnostics

This page explains how to build and run a Windows Docker container that hosts Browzwear VStitcher-CLI 2025.2, including GPU considerations, Mesa CPU rendering fallback, installation steps, and how to execute…

VStitcher-CLI Windows Docker Image — Build & Run Guide

VStitcher Engine (Headless)

Welcome to Browzwear’s API



Welcome to VStitcher API
VStitcher API gives developers the ability to seamlessly create and integrate plugi...

VStitcher API

Introduction

Overview
Cloud Licensing
Product Downloads



License and Authentication
Overview
To apply to join our Open Platform partner program and r...

License and Authentication

API Functions
Folder structure
Plugin.json
Example



Understanding VStitcher API
API Functions
The API is based on C functions and is por...

Understanding Vstitcher API

Creating Python plugin
Basic plugin
Debug your plugin using Visual Studio Code
Install debugpy Library
Prepare Visual Studio Code
Modify t...

Creating Python plugin

Creating C++ plugin
Windows
Prerequisite
Creation process
Project Settings
Mac OS
Prerequisite
Creation process



Creating C++ plugin

Wr...

Creating C++ plugin

Creating C# plugin
Create new project
Add Browzwear library to your project
Initialize plugin
Create plugin.json file to your plugin
Proje...

Creating C# plugin

Development
Plugin Manager in VStitcher
Add Menu Item to the Plugins Menu
Creating an External HTML Window
Register for System Events
Mult...

Development

Error Codes



    BW_API_ERROR_SUCCESS = 0,


    BW_API_ERROR_UNDEFINED = -1,


    BW_API_ERROR_INTERNAL_ERROR = -2,


    BW_API_ERROR...

Error Codes

Deployment
Deploy your Plugins with External Library
example




Deployment

Deploy your Plugins with External Library
VStitcher/Lotta ins...

Deployment

Getting Started

struct BwApiCoordinatesXY
float xfloat y

struct BwApiCoordinatesXYZ
float xfloat yfloat z

struct BwApiDimensions
float widthfloat height...

VStitcher API Types

Version
        
        
            IdentifierGet
        
        
            ApplicationExit
        
        
            HostApplic...

Application

ConvertBezierToSpline
        
        
            ConvertSplineToBezier
        
    


    ConvertBezierToSpline
    Convert Bezier poi...

Helper

AnimationSeek
        
        
            AnimationSettingsUpdate
        
        
            AnimationSettingsGet
        
        
 ...

Animation

ClipLoad
        
        
            ClipInfoGet
        
        
            ClipClone
        
        
            ClipDelete
      ...

Clip

AssetLibAdd
        
        
            AssetLibUpdate
        
        
            AssetLibGet
        
        
            AssetLibR...

AssetLibrary

ColorLibraryCreate
        
        
            ColorLibraryAdd
        
        
            ColorLibraryRemove
        
        
      ...

Color

MaterialCreate
        
        
            MaterialClone
        
        
            MaterialDelete
        
        
            Mate...

Material

AssetManagement

OutfitCreate
        
        
            OutfitReadGarmentProperties
        
    


    OutfitCreate
    Creates a new empty garment.
 ...

Outfit

ButtonCreate
        
        
            ButtonDelete
        
        
            ButtonOneLocation
        
        
            Butt...

Button

ClusterCreate
        
        
            ClusterDelete
        
        
            ClusterShapeAdd
        
        
            Clus...

Cluster

ColorwayDelete
        
        
            ColorwayCurrentGet
        
        
            ColorwayCurrentSet
        
        
       ...

Colorway

DartCreate
        
        
            DartGet
        
        
            DartUpdate
        
        
            DartDelete
       ...

Dart

DiamondDartCreate
        
        
            DiamondDartDelete
        
        
            DiamondDartIds
        
        
         ...

DiamondDart

EdgeCreateAsPolyline
        
        
            EdgeCreate
        
        
            EdgeCreateAsBezier
        
        
         ...

Edge

GarmentCreate
        
        
            GarmentOpen
        
        
            GarmentImport
        
        
            GarmentS...

Garment

GuidelineCreate
        
        
            GuidelineDelete
        
        
            GuidelinePropertiesGet
        
    


    Gui...

GuideLine

InternalPointAdd
        
        
            InternalPointRemove
        
        
            InternalPointIdsGet
        
        
   ...

InternalPoint

LineCreateAsPolyline
        
        
            LineCreateAsBezier
        
        
            LineDelete
        
        
         ...

Line

MaterialContainerIds
        
        
            MaterialContainerCreate
        
        
            MaterialContainerDelete
        
...

MaterialContainer

PleatCreate
        
        
            PleatDelete
        
        
            PleatIds
        
        
            PleatTypeGet
  ...

Pleat

RulerIds
        
        
            RulerCreate
        
        
            RulerNameGet
        
        
            RulerLengthGet...

Ruler

ShapeCreate
        
        
            ShapeDelete
        
        
            ShapePropertiesGet
        
        
            Shape...

Shape

SizeAdd
        
        
            SizeDelete
        
        
            SizeCurrentGet
        
        
            SizeCurrentSet...

Size

StitchCreate
        
        
            StitchCreateEx
        
        
            StitchMultiCreateEx
        
        
            ...

Stitch

ZipperCreate
        
        
            ZipperDelete
        
        
            ZipperZippedRateGet
        
        
            Zi...

Zipper

ShoesIds
        
        
            ShoesAvatarsGet
        
        
            ShoesWear
        
        
            ShoesCurrentR...

Shoes

AvatarTemplates
        
        
            AvatarTemplatesEx
        
        
            AvatarCreate
        
        
            A...

Avatar

EnvironmentSet
        
        
            EnvironmentGet
        
        
            Environments
        
        
            Envir...

Environment

RenderExport3DObject
        
        
            RenderImage
        
        
            RenderImageEx
        
        
            R...

Render

SnapshotLoad
        
        
            SnapshotLoadEx
        
        
            SnapshotSave
        
        
            Snapsho...

Snapshot

WndMessageBox
        
        
            WndFileDialog
        
        
            WndDialogShow +C-API
        
        
           ...

General

RelateCreate
        
        
            RelateCreateEx
        
        
            RelateMultiCreateEx
        
        
            ...

Relate

SmartTemplateGet
        
        
            SmartTemplateSet
        
        
            SmartTemplateCategoriesGet
        
        ...

SmartTemplate

API Schema

settings.json

Copy Json
{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"description": "Animation settings",
	"type": "object",...

settings_v3_7.json

animation

plugin_manifest.json

Copy Json
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "ident...

plugin_manifest.json

plugin manifest

asset.json

Copy Json
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "remote_id": {
 ...

asset_v2_0.json

collection.json

Copy Json
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
 ...

collection_v2_0.json

library.json

Copy Json
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
    ...

library_v2_0.json

state.json

Copy Json
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "state": {
     ...

state_v2_0.json

asset.json

Copy Json
{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"type": "object",
	"properties": {
		"remote_id": {
			"de...

asset_v3_11.json

collection.json

Copy Json
{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"type": "object",
	"properties": {
		"name": {
			"de...

collection_v3_11.json

locales.json

Copy Json
{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"type": "array",
	"items": {
		"type": "object",
		"prop...

locales_v3_11.json

library_v3_11.json

asset-library

Copy Json
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "Avatar Joint Schema",
    "description": "A schema rep...

joint_v3_21.json

avatar_import_info.json

Copy Json
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "path": {
    "type": "string",
    "patter...

avatar_import_info_v1_0.json

avatar_measurements_error.json

Copy Json
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "propertie...

avatar_measurements_error_v1_0.json

avatar_pose_properties.json

Copy Json
{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"type": "object",
	"properties": {
		"nam...

avatar_pose_properties_v1_0.json

avatar_properties.json

Copy Json
{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"oneOf": [{
		"type": "object",
		"properties"...

avatar_properties_v1_0.json

common.json

Copy Json
{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"definitions": {
		"vect3d": {
			"type": "object",
			"p...

common_v1_0.json

hanging_points.json

Copy Json
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Hanging Points object",
  "type...

hanging_points_v1_0.json

hanging_points_info.json

Copy Json
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Hanging Points Info",
  "o...

hanging_points_info_v1_0.json

avatar_properties_v3_10.json

avatar_properties_v3_14.json

avatar_properties_v3_9.json

avatar_template.json

Copy Json
{
  "$schema":  "http://json-schema.org/draft-04/schema#",
  "type":  "object",
  "properties":  {
    "na...

avatar_template_v3_9.json

avatar

clip_info.json

Copy Json
{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"description": "Clip info object",
	"type": "object",
...

clip_info_v3_8.json

clip

color_lib.json

Copy Json
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
  ...

color_lib_v1_0.json

color.json

Copy Json
{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"description": "Color object",
	"type": "object",
	"proper...

color_v1_0.json

color

dart_creation_properties.json

Copy Json
{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"description": "Dart creation info",
	"...

dart_creation_properties_v3_7.json

dart_properties.json

Copy Json
{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"description": "Dart properties",
	"type": "obje...

dart_properties_v3_7.json

dart

Copy Json
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "properties": {
        "name": {
        ...

edge_properties_v3_22.json

edge_properties.json

Copy Json
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "properties": {
    ...

edge_properties_v3_18.json

 

Copy Json
{
    "$schema": "http://json-schema.org/draft-04/schema#",
	"type": "object",
    "description": "Create Outfit",
    "prope...

create_outfit_v3_17.json

edge_properties.json

Copy Json
{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"type": "object",
	"properties": {
		"name": {
	...

edge_properties_v3_17.json

edge_properties_v3_16.json

edge_properties_v1_0.json

edge_properties_v3_3.json

edge

camera.json

Copy Json
{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"type": "object",
	"properties": {
		"fov": {
			"type": ...

camera_v1_0.json

light.json

Copy Json
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "exposure": {
  ...

light_v1_0.json

environment

Copy Json
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "settings for export",
  "type": "object",
  "propert...

export_settings_v3_21.json

garment_close_info.json

Copy Json
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "description": "Garment Close Info",
  ...

garment_close_info_v3_16.json

costing.json

Copy Json
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "value": {
   ...

costing_v1_0.json

garment_info.json

Copy Json
{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"description": "Garment info object",
	"type": "obj...

garment_info_v1_0.json

garment_settings.json

Copy Json
{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"description": "Garment Settings",
	"type": "ob...

garment_settings_v1_0.json

garment_settings_v3_13.json

export_settings.json

Copy Json
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "settings for export",
  "type"...

export_settings_v3_6.json

import_settings.json

Copy Json
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "settings for import",
  "type"...

import_settings_v3_6.json

tech_pack.json

Copy Json
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "definitions": {
    "garment_info": {
      "proper...

tech_pack_v3_7.json

render.json

Copy Json
{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"description": "Renderobject",
	"properties": {
		"render...