Using AR Library

Use AR Library to import complete 3D objects, audio clips, patch assets and scripts into your Spark AR Studio projects. It's a quick and easy way to start building your own effects.

Licensing

AR Library includes assets provided by Facebook and Sketchfab:

• 3D objects and patch assets are licensed for use under the CC BY 4.0 license.
• Scripts are licensed under the MIT license.
• Audio files are licensed under Facebook’s Sound Collection Terms.

Attribution is provided automatically when people view the effect. You don’t need to provide attribution when publishing your effect.

To see the license for each asset, select the asset in AR Library.

Opening AR Library

To open AR library, click the Library icon in the toolbar:

You can also:

1. Click Add Asset in the Assets panel.
2. Select Import From AR Library.

AR Library will open in a separate window:

To find assets either browse categories using the menu on the left, or use the search bar.

3D Objects

3D primitives

Use these 3D objects for prototyping. To find them:

1. Open AR Library.
2. Select 3D Objects in the menu on the left, then 3D Primitives.

Sketchfab 3D models

We've partnered with Sketchfab to provide a huge range of 3D models. Before you can download 3D objects from the library, you'll need to log in with your Sketchfab account. If you don't have a Sketchfab account you can create one for free.

To browse Sketchfab 3D models:

1. Open AR Library.
2. Select 3D Objects.
3. Click View All.

To manage the Sketchfab account you're logged into AR Library with, click Preferences in the toolbar, then AR Library.

Importing 3D objects

When you've selected an object you'll see information about it under Specifications. For example, for 3D objects you'll see how many vertices it has or if there are animations included:

The specifications should help you make sure any assets you import follow our technical guidelines, so your effect works well on different devices.

To add the asset to your project, click Import.

Audio files

There’s a huge range of sounds available, especially created for AR effects. To find them:

1. Open AR Library.
2. Select Audio in the menu on the left.

You can browse by 3 categories:

• Ambient Sounds - good for providing background noise to add atmosphere, like the sound of waves or bird song.
• Sound Effects - best for adding short triggered sound effects like a glass breaking or an air horn.
• Music - a selection of music to add to your effects.

To add the audio to your project, click Import Free.

Script packages

AR Library includes a range of useful script packages for adding more functionality to your code. For example, the cannon script package adds the appearance of gravity to objects, and the sparkar-head-rotation-trigger script package provides a function to enable firing events in response to head movements.

To browse and import script packages:

1. Open AR Library.
2. Select Script Packages.
3. Select the package you want to install and click Import Free.

The script package will be listed in the Assets panel under Packages:

 ### Adding script packages to your project

To add a script package to your project:

1. Open your script file.
2. Import the script package as follows, replacing spark-ar-library with the library you just installed:

      // in script.js 
        const library = require('spark-ar-library');
    

Patch assets

Patch assets are ready-made patch graphs. Use them to quickly add logic, visual effects and complexity to your projects. There are 2 categories to choose from:

• Animation - use these graphs to add animation to objects in your effect.
• Utilities - to quickly add common functions, like converting units of measurement.
• Shaders - to add visual effects like gradients, patterns and colored filters.

To find them:

1. Open the AR Library.
2. Select Patch Assets in the menu on the left.

The patch asset will be listed in the Assets panel. Drag it into the Patch Editor and connect it to other patches to add it to your project.

Viewing imported assets in Spark AR Studio

When the asset is selected in Spark AR Studio, in the Inspector you'll see:

• The name of the file.
• The size of the file.
• Its components - including any animations and unsupported components.

Adding imported assets to your scene

Add assets from AR Library to your scene like you would any other object or asset imported into Spark AR Studio.