Building a Project in iJewel Drive

Create a Wedding Band Builder project and customize its assets - no code required

Assets Setup explains what the building blocks are. This page shows you how to put them together inside iJewel Drive: create a project, replace profiles, swap materials and icons, edit project defaults, synchronize folder changes, preview the result, and publish it for an integration. Everything here happens in the Drive file browser; normal setup does not require editing JSON by hand.

Release baseline

This workflow is documented against Mini Editor 0.4.24 and Mini Viewer 0.6.11. Older Viewer releases do not provide the final Wedding Band iframe ready and teardown lifecycle.

Enterprise plan required

Creating a Wedding Band Builder project is an Enterprise feature. The New Wedding Band option only appears at the Drive root for Enterprise accounts. On other plans you'll see an upgrade prompt instead. Open Billing Settings to upgrade your plan directly.

What a project is

A Wedding Band Builder project is a special folder in your Drive. It carries the configurator's settings and holds every asset - profiles, materials, icons, diamond models - as real files inside tidy subfolders. A one-click Sync rebuilds the profile and finish catalogs only. Other generated asset folders are storage created during provisioning; Sync does not derive configuration from them.

The project folder has two connected layers:

Layer	What it contains	How it changes
Drive files	Profile models, finish materials, icons, swatches, and diamond models	Upload, replace, move, rename, or delete files and folders
Project configuration	Included bands, defaults, catalogs, scene settings, branding, and asset URLs	Created from the Wedding Band starter project; profile and finish catalogs are partly rebuilt by Sync, while supported behavior fields are edited in Mini Editor

Sync intentionally rebuilds only the configuration that can be inferred safely from folders. It preserves the remaining Wedding Band settings.

Create a new project

1. Go to your Drive root (the top-level folder list).

Start at the Drive root, where Wedding Band project creation is available from Add new.

2. Click Add new and choose New Wedding Band.

Choose New Wedding Band from the root-level Add new menu.

3. In the New Wedding Band Configurator dialog:
   • Toggle His Ring, Her Ring, or both.
   • Enter a Project Name.
   • Click Submit. (Submit stays disabled until you pick at least one ring and enter a name.)

Select the rings to include and enter the new project's name. This example is intentionally left unsubmitted.

4. iJewel Drive creates the project folder and copies in a full starter kit - 7 profiles, 3 metals, 7 surface finishes, the UI icon sets, and the diamond models - so you have a working configurator from the very first click.

Open the new project folder to see the starter assets, ready to customize.

What Drive creates

Submitting the dialog starts a complete project-provisioning operation:

1. Drive creates a configurator folder with type WeddingBandBuilder.
2. It copies the Wedding Band starter configuration and changes its project name.
3. It filters the starter's bands list to His Ring, Her Ring, or both, based on the dialog selection.
4. It creates the catalog folders and downloads each starter asset into your Drive.
5. It refreshes the file browser after the operation finishes.

The current starter project includes:

Catalog	Starter content
Bands	Her Ring, His Ring, or both
Profiles	D-Shape, Flat, Concave, Round, Knife Edge, Beveled, Comfort
Metals	Gold (yellow), White Gold (white), Rose Gold (rose)
Finishes	Hammered, Sand, Ice, Nature, Brush, Linear, Polished
Color partitions	1 Color, 2 Color, 3 Color
Poses	Default, Crossed, Stacked, Nested icons
Diamonds	Single-stone and pave/prongs GLB models
UI assets	Logo; profile, dimensions, material, and diamond tab icons; design and cut icons

Partial project creation

Starter assets are copied from their source locations into your Drive. If one or more downloads or uploads fail, the folder can still exist but Drive reports that the project is only partially populated and identifies the failed assets. Open the folder, replace the missing files, and Sync again instead of assuming that a failure toast rolled back the whole folder.

Understand the folder structure

Inside a project folder you'll find these subfolders:

A provisioned Wedding Band project keeps diamonds, finishes, icons, metals, profiles, and separation presets together under one special Drive folder.

<Your Project>/
├─ profiles/            one subfolder per profile (shape model + icon)
│  ├─ D-Shape/
│  ├─ Flat/
│  └─ ...
├─ finishes/            one subfolder per surface finish
│  ├─ Polished/
│  │  ├─ (icon image)
│  │  └─ files/         one .pmat per metal (yellow.pmat, white.pmat, rose.pmat)
│  └─ ...
├─ metals/              metal swatch icons
├─ icons/               UI catalog images
│  ├─ logo.(svg/png)
│  ├─ tabs/             profile, dimensions, material, diamonds
│  ├─ poses/            default, crossed, stacked, nested
│  ├─ design/           no-diamonds, full-diamonds, bezel-diamonds, ...
│  └─ cuts/             1, 2, 3
├─ diamonds/            diamond_single.glb, diamond_pave.glb
└─ separationPresets/   (settings only - no files)

Two of these folders are Sync-managed: change their contents, run Sync Configurator, and Drive rebuilds those catalogs. The rest hold images and models copied during project creation. Their configuration is preserved, but the current Sync and Mini Editor do not provide catalog management for them.

Folder	Holds	Updated by
profiles/<Name>/	one 3D shape model + one icon image	Sync (rebuilt from folders)
finishes/<Name>/	one icon image + a files/ folder of .pmat materials	Sync (rebuilt from folders)
metals/	metal swatch icons	Provisioned storage; not read by Sync or editable as a catalog in Mini Editor
icons/	logo, tab / pose / design / cut icons	Provisioned storage; not read by Sync or editable as mappings in Mini Editor
diamonds/	the two diamond .glb models	Provisioned storage; not read by Sync or editable as model references in Mini Editor
separationPresets/	nothing; the preset definitions remain in project configuration	Placeholder only; not read by Sync or editable as definitions in Mini Editor

Uploading inside a project

When you upload 3D files into a Wedding Band Builder project, iJewel Drive stores them exactly as they are:

• automatic GLB conversion is disabled;
• compression is disabled;
• automatic centering is disabled; and
• automatic scaling is disabled.

These safeguards preserve the profile curve's units, origin, and shape. Wedding Band folders allow New Folder, File upload, Sync Configurator, and View. Folder upload and the generic Configurator-component workflow are not offered inside a Wedding Band project.

What Sync reads

Sync walks the complete Wedding Band folder tree, but it rebuilds only profiles and finishes.

Profile discovery rules

For every direct subfolder of profiles/, Drive:

1. uses the folder name as the profile's display name;
2. creates its ID from the lowercased folder name;
3. uses the first supported 3D file as the profile model (.3dm, .glb, .gltf, .fbx, .obj, or .stl);
4. uses the first image as the icon (.svg, .png, .jpg, .jpeg, .webp, or .gif); and
5. preserves the profile's existing engraving offsets when the folder name still matches an existing profile.

If a model or icon is temporarily missing, Sync retains the matching existing URL when possible. Keep only one intended model and one intended icon in each profile folder so discovery is unambiguous.

Finish discovery rules

For every direct subfolder of finishes/, Drive:

1. uses the folder name as the finish name and its lowercased value as the ID;
2. uses the first image in that folder as the finish icon;
3. looks for a child folder named exactly files;
4. reads every .pmat file in files/; and
5. uses each lowercase filename without .pmat as the metal key.

For the starter metals, the material filenames must therefore be yellow.pmat, white.pmat, and rose.pmat. A missing icon or empty files/ folder falls back to the existing finish data when a matching finish already exists.

Configuration Sync preserves

Sync does not replace the following parts of the Wedding Band configuration:

• included bands and their default state;
• the metals catalog;
• logo, tabs, poses, design, and cut icons;
• diamond model filenames;
• color-separation presets;
• project-level asset base URL;
• scene, camera, branding, and embed settings; and
• profile engraving offsets that can be matched by profile name.

This boundary is important: adding a file to metals/, icons/, or diamonds/ does not create a new catalog entry by itself. Preserved does not mean Mini Editor-managed: these asset catalogs and separation-preset definitions are not currently exposed there.

Update profiles

A profile is the ring's cross-section shape. Each one lives in its own subfolder under profiles/, containing a single 3D shape model and one icon image (the swatch shoppers tap to pick the shape).

To add or replace a profile:

1. Open the project's profiles/ folder.

   

   Each direct child folder becomes one profile option after Sync.

2. Create a New Folder named for the profile (e.g. Milgrain). The folder name becomes the profile's display name in the builder.

3. Open the new folder and upload the shape model (a .3dm file with a single closed 2D curve) plus an icon image.

   

   This existing profile shows its 3DM shape model. When adding a profile, upload its picker icon in the same folder as well.

4. To swap an existing profile, open its folder and upload replacement files.

5. Click Add new → Sync Configurator.

On Sync, each profile folder becomes a profile in the builder - its name comes from the folder, and its shape and icon come from the two files inside.

WARNING

The profile curve must be drawn at accurate millimeter dimensions - the builder uses its real size as the base for width and thickness. A wrongly-scaled curve throws off every dimension, weight, and price. See Assets Setup → 2D Profiles for details.

Update surface finishes

A finish (also called a surface) is a texture like Polished, Hammered, or Brush. Each finish has its own subfolder under finishes/, holding an icon image plus a files/ subfolder with one material file per metal.

To add or replace a finish:

1. Open finishes/ and create a New Folder named for the finish (e.g. Matte).

   

   Each direct child folder represents one surface finish.

2. Inside it, upload the finish's icon image.

3. Create a files subfolder and upload one .pmat material per metal, named for the metal: yellow.pmat, white.pmat, rose.pmat.

   

   The finish's metal-specific materials belong in a child folder named exactly files.

   

   The starter metal keys are represented by rose.pmat, white.pmat, and yellow.pmat.

4. Click Add new → Sync Configurator.

On Sync, each finish folder becomes a selectable surface, and its files/ materials are matched to the right metal automatically.

Provisioned icons, metals, diamonds, and separation presets

These folders are created and populated from the starter configuration when the project is provisioned. They are not rebuilt from their folders, and their catalog definitions are not currently editable in Mini Editor.

• Icons (icons/) - the logo (logo.svg), tab icons, pose icons, design icons, and cut icons. A replacement is reliable only when Drive retains the same referenced file identity; Sync does not discover the replacement.
• Metals (metals/) - the metal swatch icons shown in the material picker.
• Diamonds (diamonds/) - the two shared diamond models, diamond_single.glb and diamond_pave.glb.
• Separation presets (separationPresets/) - an empty placeholder folder. The actual preset definitions remain in the stored Wedding Band configuration.

Sync only rebuilds profiles and finishes

Sync Configurator rebuilds the profiles and finishes lists from their folders. It does not re-scan icons/, metals/, diamonds/, or separationPresets/. Mini Editor also does not expose those asset catalogs or separation-preset definitions. Replacing an existing Drive file may keep a working reference when the file identity is retained, but adding, removing, or renaming these assets will not update the stored configuration. Contact support for a configuration update until a folder-sync or editor surface is added for them at contact@ijewel3d.com.

About assetBaseUrl

Each project has a base URL used to resolve any asset referenced by filename alone - most importantly the diamond models. When you Sync, profile and finish files are re-pointed to your Drive-hosted copies, while the base URL stays put. You normally never need to touch this.

Sync your changes

Drive requests a configurator sync after several successful file-browser operations inside a configurator, including uploads, moves, deletes, renames, folder creation, and some metadata updates. A manual Sync remains the clearest way to finish a batch of related changes and confirm the saved state.

After changing profiles or finishes, click:

Add new → Sync Configurator (or the Sync button in the toolbar).

Inside a Wedding Band project, Add new provides folder creation, file upload, and Sync Configurator. The View button remains available in the toolbar.

Sync walks your project's folders, rebuilds the profile and finish lists, and saves the configurator. You'll see a "Configurator Synced successfully" confirmation when it's done.

Use this sequence for a safe catalog update:

1. Upload all profile models/icons and finish icons/material files for the change.
2. Remove obsolete files only after their replacements have uploaded.
3. Run Sync Configurator once at the end.
4. Wait for Configurator Synced successfully.
5. Open View and test every affected band, metal, and finish.

If Sync fails, verify the exact root folder names profiles and finishes, the exact child folder name files, supported file extensions, and metal-key filenames before retrying.

Preview your changes

With the project open, click the View button in the toolbar. The configurator opens in a new tab, loaded with your current profiles, materials, icons, and diamonds - exactly what your shoppers will see. Use it to confirm every change before you deploy.

Manage project settings and access

The Wedding Band project folder supports a few different management actions:

Action	Purpose
View	Opens the current configurator in a new tab using the saved project configuration
Edit Default Settings	Opens Mini Editor for scene, camera, branding, embed defaults, band defaults, UI option lists, engraving, limits, and theme; it does not manage asset catalogs or separation-preset definitions
Sync Configurator	Rebuilds the folder-managed profile and finish catalogs and saves them into the project
Make Public / Share	Allows the project to be loaded through a share URL, hosted embed, or public SDK integration

Saving default settings also marks those folder settings as public so the published viewer can resolve them. Always preview after saving project defaults; scene changes and catalog Sync update different parts of the same stored configuration.

Configure Wedding Band behavior

The project created by Drive stores much more than asset URLs. Its Wedding Band configuration includes global defaults and an independent state for each included band.

Project-level behavior

Area	Stored behavior
Included bands	Her Ring, His Ring, or both
Geometry root	Root scale and automatic-fit behavior
Catalogs	Profiles, metals, finishes, diamonds, icons, and separation presets
Presentation	Per-band position and rotation plus the built-in UI assets
Viewer defaults	Scene, material, camera, branding, and embed settings

Per-band defaults

Each included band can start with its own:

• display name, physical base width, and physical base thickness;
• profile and width/height multipliers;
• ring size;
• one-, two-, or three-color partition;
• active metal slot plus metal and finish selections for all three slots;
• diamond setting type, span, spacing, count, stone size, and placement;
• edge type and edge side;
• polished-interior and split-at-groove choices;
• straight or wavy grooves, including frequency, amplitude, and split mode;
• engraving text, font, font size, and profile-specific vertical placement; and
• position and rotation in a two-band presentation.

The starter's Her and His states are independent. A customer switching bands in the viewer changes which state the controller reads and writes; it does not copy one ring's selections to the other.

Catalog changes versus runtime changes

Use Drive Sync for folder-derived profiles and finishes. Use Mini Editor for the supported behavior and default fields. Use the Wedding Band controller in your storefront for a customer's current selections.

Task	Correct layer
Add or remove a profile or finish	Drive folders, then Sync
Add a metal, icon mapping, diamond model, or separation-preset definition	Not supported by current Sync or Mini Editor; requires a configuration/support update
Set the initial His/Her ring state	Project defaults
Change width, material, diamonds, engraving, or ring size while shopping	Wedding Band controller API
Read price, dimensions, snapshot, or manufacturing data	Wedding Band controller API
Save a customer's chosen configuration	exportConfig() in the integration, then store it with the cart/order

Platform operations are not browser SDK methods

iJewel Drive internally provisions the starter project, derives profile and finish configuration from folders, and saves the rebuilt plugin configuration. Those platform operations are used by New Wedding Band and Sync Configurator; they are not exposed on the storefront controller. Do not call Drive's internal setup or sync functions from customer-facing HTML. The public browser surface begins with viewer.getPluginByType('WeddingBandBuilder').controller.

Maintainer implementation mapping

The current Drive frontend implements this workflow with three Wedding Band-specific operations:

Internal operation	Drive feature	Responsibility
setupWeddingBandBuilder	New Wedding Band	Creates the special folder, filters His/Her bands, stores the starter configuration, creates the asset tree, and copies starter assets
getWeddingBandBuilderConfig	Sync discovery	Reads nested files and derives only the profiles and finishes catalogs while preserving the rest of the plugin configuration
updateWeddingBandBuilderConfigurator	Sync Configurator	Merges the derived catalogs into the existing WeddingBandBuilder plugin and saves the project configuration

These names describe the platform implementation and can change independently of the public Wedding Band controller API.

Validate the finished project

Before publishing, check:

• both selected bands open and retain independent state;
• every profile has the intended model, icon, width, thickness, and engraving placement;
• every finish renders for every metal key;
• 1 Color, 2 Color, and 3 Color partitions map to the intended material slots;
• edge, groove, diamond, and engraving options stay within manufacturable limits;
• price and weight update after geometry, metal, and diamond changes;
• the scene, logo, controls, and camera work on desktop and mobile; and
• the hosted/share URL works in a private browser window without your Drive login.

For integration testing, use the matching maintained example:

Integration	Live page	Source
Published Drive file	Open live	View source
Built-in UI	Open live	View source
Custom UI	Open live	Browse source
iframe host controls	Open live	Browse source

• Pricing and weight: Pricing Engine
• Colors and branding: Theming & Branding
• Asset concepts and requirements: Assets Setup
• Runnable integrations: Working Wedding Band Templates

Next steps

Once your assets look right in the preview, you're ready to publish and embed the configurator on your store - continue to Deployment.