SocialARLib

SocialARLib is a collection of utility libraries for several Social Augmented Reality platforms, like Snapchat's Lens Studio and Facebook's Spark AR platform. The Pièce-de-Résistance of this library is a complete and feature-rich tweening-library for Spark AR, with a syntax and API comparable to that of Greensock's GSAP platform.

SocialARLib also contains a lot of other gems that make developing a Spark AR filter a lot easier.

What's inside SocialARLib

SparkAR (Facebook / Instagram) Feature | Description :--- | :--- ARTween | A complete Tweening-library in the style of good old TweenLite CustomConsole | Add a visual console to your scene so you can debug your projects on any device IKSystem | A flexible IK-system. Handy if you need your character to use a bicycle CameraLookAt | Make something happen by looking at a specific object in the scene CustomUI | A utility-class with some handy UI-functions AudioObject | For handling audio much easier DeviceInfo | DeviceInfo provides some basic information about the device. It needs a reference to a canvas in Spark AR to do so. Math2 | Handy math functions ObjectFinder | Find objects, or not and get some nice debug-logs SceneLoader | For easy scene-manager Patches | A collection of ready-to-use patches

Lens Studio (Snapchat) Feature | Description :--- | :--- ... | A complete Tweening-library in the style of good old TweenLite

Setup

Some basic Spark-AR script information

Spark-AR wants all scripts being used to sit in a folder called scripts. It also wants all scripts that are being used in your project (even if they're referenced or imported in other scripts) to be added inside Spark-AR.

SocialARLib.js

For this library we are gonna output a script called socialarlib.js. This will contain all the necessary library-functions you need.

When you want to use ARrrrLib as an external library for your own (or a new) Studio AR project then follow the following procedure:

• make sure to copy the package-lock.json and package.json to the root of your project. This folder, although it's an external library will also need to have the node_modules installed to function. To install the node_modules you will have to run:

npm i

Spark AR

When we look at the scripts-folder After installing all the necessary node_modules we need to build the socialarlib.js file and fill it with all the classes of the library.

P.S. The node_modules folder is ignored through the .gitignore, which can be found in the root of ARrrrLib.