Documentation

There are various scenario how and when to use the Rubens Configurator. Therefore Roomle offers different ways to integrate the Rubens Configurator into your website or webshop. Depending on your needs there are currently 3 different possibilities. Each of them built on top of each other. This means if you choose to start with a simpler solution it's easy to upgrade to a more sophisticated later easily.

# Configurator

Getting started

Introduction to the key concepts of the Configurator Web SDK, prerequisites, asset paths and browser compatibility.

Tutorials

Guides you through basic samples how to use the Configurator Web SDK and how to create a basic app.

SDK Reference

Look up the interfaces provided by the Roomle Web SDK to communicate with the modules of the Configurator.

Embedding

This is especially interesting for Level 1 customers and/or when you only have static products. To embed the Rubens Configurator you need to create a link and use this link as a src in an iframe. Probably you already know how to do this from popular platfroms like YouTube.

Embedding Integration

If you need a deep integration of the Rubens Configurator into your website or webshop the Embedding Integration is the way to go. In contrast to simple embedding you need to write some JavaScipt glue code to connect your website or webshop with Rubens Configurator.

Web SDK

The Roomle Web SDK comes into play when you want to develop your own user interface on top of the 3D scene of the Rubens Configurator. This is very handy because you do not need to learn any 3D "shenanigans" and can only focus on regular web frontend development.

# 3D & Content

Rubens 3D Data Creation and Management

Tutorials and FAQ for the Rubens 3D/AR data management area.

Material Definition

Docs how to define material attributes for use in the Roomle platform. Find many example texture JSON files.

Blender Addon

Download, install the Roomle Blender Addon to export Roomle Configurator Script format and external mesh files.

Scripting Resources

Helps you setting up the scripting environment, first steps and examples for scripting. Reference for naming and language specific conventions.

# API

# API Reference