URL Options

General

autospinnumber

0

Sets the automatic spin speed around the y-axis after loading (degrees/s). 0 = disabled.

autostartboolean

false

Enables autostart functionality. The viewer loads immediately when the page is ready.

enginestring

webgl

Sets the rendering engine type. Options: 'webgl', 'webgpu'.

Options:

• webgl - WebGL rendering engine
• webgpu - WebGPU rendering engine

fallback_langstring

de

Sets the fallback language for UI elements and text when the browser locale is not supported. Options: 'de' (German), 'en' (English), 'it' (Italian), etc.

langstring

Sets the language for UI elements and text, overriding the browser language. Options: 'de' (German), 'en' (English), 'it' (Italian), etc.

preloadboolean

true

Enables preloading of all resources (textures) before the scene is displayed.

render_backgroundboolean

false

Enables background rendering of the scene. Has impact on performance.

start_arboolean

false

Enables AR mode on start.

viewer_passwordstring

Sets the viewer password to unlock the viewer automatically.

Camera

camera_clipping_autoboolean

true

Enables automatic scaling of camera clipping planes (minZ and maxZ).

camera_clipping_maxnumber

100

Maximum camera clipping distance (far clipping plane, world units).

camera_clipping_minnumber

0.3

Minimum camera clipping distance (near clipping plane, world units).

camera_collisionboolean

true

Enables camera collision with the model.

camera_constraint_pitch_downnumber

0

Sets the camera pitch down rotation limit (degrees). Range: -90 to 90.

camera_constraint_pitch_upnumber

0

Sets the camera pitch up rotation limit (degrees). Range: -90 to 90.

camera_constraint_yaw_leftnumber

0

Sets the camera yaw left rotation limit (degrees). Range: -180 to 180.

camera_constraint_yaw_rightnumber

0

Sets the camera yaw right rotation limit (degrees). Range: -180 to 180.

camera_fovnumber

45

Sets the field of view for the active camera (degrees).

camera_limitboolean

true

Enables default pitch and yaw rotation limits.

camera_panning_axisstring

xyz

Sets the allowed camera panning axes. Options: 'xyz', 'xy', 'xz', 'yz', 'x', 'y', 'z', '' (disabled).

camera_pivotstring

middle

Sets the camera pivot point. Options: 'middle', 'origin'.

Options:

• middle - Pivot around model center
• origin - Pivot around model origin

camera_targetstring

Sets the initial camera target. Format: 'x,y,z' coordinates.

camera_wheel_multipliernumber

1

Sets the mouse wheel zoom speed multiplier.

camera_zoom_autoboolean

true

Enables automatic scaling of camera zoom limits (camera_zoom_max and camera_zoom_min).

camera_zoom_maxnumber

20

Maximum camera zoom distance (world units).

camera_zoom_minnumber

0.003

Minimum camera zoom distance (world units).

camera_zoom_startnumber

0

Sets the initial camera zoom distance (world units).

User Interface - Controls

ui_animationsboolean

true

Shows the animation menu and timeline.

ui_annotationsboolean

true

Shows the annotation menu.

ui_arboolean

true

Shows the 'View in AR' button.

ui_audioboolean

true

Shows the audio/sound button.

ui_controlsboolean

true

Shows all viewer controls at the bottom of the viewer.

ui_fullscreenboolean

true

Shows the Fullscreen button.

ui_general_controlsboolean

true

Shows the main control buttons in the bottom-right corner.

ui_helpboolean

true

Shows the Help button.

ui_shareboolean

true

Shows the share dialog button.

ui_stopboolean

false

Shows the 'Disable Viewer' button. When disabled, users cannot stop the 3D render once started.

ui_vrboolean

true

Shows the 'View in VR' button.

ui_zoomboolean

false

Shows the zoom control buttons.

User Interface - Appearance

ui_color_accentstring

Accent UI color as hexadecimal code (without #).

ui_color_primarystring

Primary UI color as hexadecimal code (without #).

ui_color_secondarystring

Secondary UI color as hexadecimal code (without #).

ui_header_btn_imagestring

URL for the custom button icon in the top-right corner.

ui_header_btn_linkstring

URL for a custom button in the top-right corner.

ui_infosboolean

true

Shows the info bar at the top of the viewer.

ui_infos_persistboolean

false

Shows the info bar in 3D mode. When disabled, the info bar is hidden in 3D mode.

ui_logoboolean

true

Shows the rooom logo.

ui_logo_linkboolean

true

Enables the link on the rooom logo.

ui_nftboolean

true

Shows the NFT button.

ui_ratingnumber

1

Shows the rating button. 0 = hidden, 1 = shown.

Options:

• 0 - Hidden
• 1 - Shown

ui_text_primarystring

Primary UI text color as hexadecimal code (without #).

ui_text_secondarystring

Secondary UI text color as hexadecimal code (without #).

User Interface - Features

ui_ar_linkstring

Custom URL for the AR screen with QR code.

ui_hintnumber

1

Viewer hint animation behavior ('click & hold to rotate'). 0 = never show, 1 = show on first visit, 2 = always show.

Options:

• 0 - Never show
• 1 - Show on first visit
• 2 - Always show

ui_hint_colorstring

Hint text color as hexadecimal code (3 or 6 characters, without #).

ui_hint_shadowboolean

true

Shows a shadow under the hint text.

ui_statsboolean

false

Shows the performance monitor (stats.js).

User Interface - Loading

ui_progress_bgboolean

true

Shows the background on the loading screen.

ui_progress_logostring

URL for the custom loading screen logo image.

ui_progress_minimalboolean

false

Shows only the progress bar on the loading screen, hiding other elements.

Environment

bg_colorstring

FFFFFF

Background color as hexadecimal code (without #).

env_intensitynumber

1.5

Sets the scene environment map intensity.

highlight_colorstring

Default highlight color as hexadecimal code (without #).

mirrorboolean

true

Enables the mirror effect under the model.

skyboxboolean

true

Shows the skybox effect.

transparentboolean

false

Enables transparent background. Useful for overlaying models on website elements.

Mesh

backfaceboolean

false

Enables double-sided rendering. Shows both front and back faces of the mesh.

material_sheennumber

0

Sets the material sheen intensity. Range: 0 (off) to 1 (maximum).

max_texture_sizenumber

8192

Maximum texture resolution (longest side in pixels). Should be a power of 2 value (32, 128, 256, 512, 1024, 2048, 4096, 8192, etc.).

mobile_max_texture_sizenumber

2048

Maximum texture resolution on mobile devices (longest side in pixels). Should be a power of 2 value (32, 128, 256, 512, 1024, 2048, etc.).

shadow_planeboolean

true

Enables the shadow plane below the mesh.

Animations

animation_loopboolean

false

Enables loop mode for the animation specified in 'animation_play'.

animation_playnumber

-1

Plays the animation with the specified index on viewer start. -1 = no animation.

animationsboolean

true

Enables all animations on the object.

Annotations

annotation_marker_colorstring

FFFFFF

Annotation marker color as hexadecimal code (without #).

annotation_marker_sizenumber

1

Sets the annotation marker size (cm). Relative to mesh scaling.

annotation_shownumber

-1

Shows the annotation with the specified index on viewer start. -1 = no annotation.

annotationsboolean

true

Enables all annotations on the object.

annotations_auto_durationnumber

2500

Sets the duration between each annotation in autopilot mode (ms).

annotations_autoplayboolean

false

Enables annotation autopilot. Automatically cycles through all annotations.

annotations_showboolean

false

Shows all annotations simultaneously.

annotations_typestring

point

Sets the annotation display type. Options: 'point', 'line'.

Options:

• point - Point markers
• line - Line/flag markers

Augmented Reality

ar_animatedboolean

true

Enables animations in AR mode. When disabled, exports the GLB as a static model.

ar_occlusionboolean

true

Enables occlusion in AR mode.

ar_placementstring

floor

Sets the AR placement surface. Options: 'floor', 'wall'.

Options:

• floor - Place on floor
• wall - Place on wall

ar_scaleboolean

true

Enables automatic scaling for AR on Android devices. When disabled, uses fixed scale.

Virtual Reality

vr_camera_distancenumber

1.8

Sets the camera Z distance from the object in VR mode (meters).

vr_floor_heightnumber

0

Sets the camera Y position from the floor in VR mode (meters).

vr_scalenumber

1

Sets the object scale factor in VR mode.

Performance

perf_texture_optimizedboolean

false

Enables optimized texture loading (KTX2 format) if available and supported by the browser.

Additional Resources

Customize Loading Screen

Learn how to customize the loading screen appearance and branding.