latest

Your First Model

End-to-end walkthrough: upload a 3D file, optimize it in the Publisher, save it to your account, publish it, and embed it on a page.


What you'll need

  • A running local dev stack (see Installation)
  • A 3D file — GLB, glTF + bin + textures, OBJ, or USDZ
  • A Vectreal account (create one at /sign-up)

No account needed to try the Publisher. Anonymous sessions allow you to upload and configure a model — you'll be prompted to save when you create an account.


Step 1 — Open the Publisher

Navigate to /publisher (or click Visit Publisher in the top navigation).

The publisher opens with an empty canvas and an upload prompt.


Step 2 — Upload a model

Drag your 3D file onto the canvas, or click the upload area to open the file picker.

glTF bundles: drag the entire folder (containing the .gltf, .bin, and texture files) onto the upload area to upload them together.

The model will appear in the 3D viewport once parsed. The loading indicator shows parsing progress.

Supported formats

FormatExtensionNotes
glTF.gltf + .bin + texturesPreferred format for full fidelity
GLB.glbSelf-contained binary glTF
OBJ.objMaterial (.mtl) loaded automatically if in same directory
USDZ.usdzLimited support — work in progress

Step 3 — Optimize & configure

Use the right sidebar to adjust:

  • Quality preset — raw, high, medium, low (controls mesh simplification and texture compression)
  • Lighting — environment preset, intensity, and shadow settings
  • Camera — field of view, initial position, auto-rotate

Changes apply to the viewport in real time.


Step 4 — Save the scene

Click Save in the publisher header.

  • If you're signed in, the scene is saved to your account immediately.
  • If you're anonymous, you'll be prompted to sign in or create an account. Your configuration is preserved.

After saving, the scene appears in your Dashboard.


Step 5 — Publish the scene

From the dashboard, open the scene and click Publish in the publish sidebar.

Publishing transitions the scene from draft to published and generates a stable embed URL.


Step 6 — Embed on a page

After publishing, copy the embed snippet from the Embed section in the publish sidebar.

The snippet looks like:

<div style="position:relative;padding-top:56.25%;width:100%">
  <iframe
    src="https://vectreal.com/preview/fullscreen/<projectId>/<sceneId>?token=YOUR_PREVIEW_API_KEY"
    style="position:absolute;top:0;left:0;width:100%;height:100%;border:0"
    allow="autoplay"
    loading="lazy"
  ></iframe>
</div>

Paste this into any HTML page. The embedded viewer loads your published model.

A preview API key is required for external iframe access. Create one in Dashboard → API Keys.


What's next