Guidelines for 3D asset uploads

The quick way

1. Model the 3D asset
2. Prepare the 3D asset
3. Upload the 3D asset to the Files library
4. Best practices to make 3D models work
5. Another way

Do this step by step

1 Model the 3D asset

There are various things to keep in mind when modeling your 3D asset:

• Indicate the length, height, and width of the object. The 3D model needs to reflect the real-world proportion of the products.
• Set the anchor point of the object (where it is supposed to touch the surface) and the object’s coordinates to 0, 0, 0 on the X, Y, Z axis accordingly. If we don’t do this, the object might appear like it’s hovering over the surface as we move the device around.
• Bake the textures. Baking means generating a UVW Map which is an image file that contains the texture of every polygon of an object.
• Keep the file size of the models and textures small to enhance the user experience. Limit the size for a smooth experience in a mobile, tablet, or desktop browser.

2 Prepare the 3D asset

A 3D asset consists of multiple files in a single zip file.

• Manifest: The manifest.json file is mandatory and indicates where to find the model and the preview image.
• Model: The model in .dae (Collada) or USDZ file format. This is a mandatory file, built in a common 3D file format. USDZ files are only compatible with the iOS app. 
• Preview: A preview file in png or jpg format. This file is optional and if added, we recommend using a large enough image in landscape format (1600 * 1200px). If no preview is specified, the file will be represented by a default icon in Showpad.
• Textures: The textures for the model should be in .tga, .jpg, .bmp, and preferably, .png format. Textures are optional, but we recommend adding them to give your model that extra flair.

Note: The fluency of viewing 3D models depends on how detailed your model is and the device's performance. Make sure to brief the file creator clearly on your goal. Using AR on iOS is more fluent with simplified models compared to models that contain the tiniest detail.

If we take a look at our manifest.json file in detail, it contains the version number of the model, the type of file, the filename of the model, and the name of the preview image. Make sure you've added the correct file names.

It's important to mention that formatting can make or break a .json file. Take care when crafting the file to ensure all commas and capitalizations are correct, as these are the most common errors that can result in issues. 

Here is an example of how your folder can look before creating a .zip file:

The location of the textures is defined in your .dae model file. Textures don't necessarily have to be in a separate textures folder, but you need to be sure that the file paths of the textures in the .dae file are limited to the .zip folder. The texture’s location needs to be relative.

When you have all the required files, you can zip everything into one file so it can be used for uploading to the Files library. There is no set requirement for the size of your 3D assets, but our best practice is not to exceed the size specified in the Supported file types article. 

3 Upload the 3D asset to the content library

1. Navigate to Libraries.
2. If your organization uses multiple Divisions, select the desired Division from the top-left dropdown menu.
3. Click All Files.
4. You can drag and drop your .zip file directly to the Files library or click Add and select Files. Choose the file(s) you want to upload from your device.
5. Configure the file properties:
   • Change the filename - Hover over the filename and click the pencil icon to make changes. If the AI Filename is available, click the AI button to see the suggested name.
   • Add tags - Hover over the tags field and select the relevant icon to edit tags, copy tags, or paste tags.
   • To paste tags in bulk, select multiple files and paste the desired tag(s).
   • Select the language - Check the relevant language for the uploaded files.
   • Edit the author if needed.
   • Add a release and expiry date.
6. Click Finish. The files will be uploaded with your selected properties.

Best practices to make 3D models work

• Make sure you use the correct file extensions in the manifest.json file. We support .dae files (Collada) on the Web app, or USDZ files on iOS. When using other file types, your users and their prospects will see an error message even though the upload in the content library was successful.
• To display 3D content on web browsers we use WebGL. It's standard in most modern browsers, but you might want to check for compatibility if you're receiving the following message.

Another way

There are JavaScript libraries available that also allow you to display and interact with 3D objects; however, these can not be uploaded as 3D objects. Since these libraries use HTML and JavaScript, they can be packaged and uploaded as an HTML5 web app.