Installing ViroReact

Installation instructions

If you are starting a new project, please consider using our Starter Kit as a basis for your app.

The steps below are for manually installing and linking the library to an existing React Native project. We do not yet support auto-linking.

Install

NPM

console

$ npm install --save @reactvision/react-viro

Yarn

console

$ yarn add @reactvision/react-viro

Download Depth Model

In order to use depth-based features such as occlusion on iOS devices that do not support LiDAR, you will need to download the CoreML depth model. Below is a link to download a .zip containing the required model. Once the model has been downloaded, ensure the model is bundled into your iOS project before building your app.

If you are using Expo, you will need to add the model to your iOS project after you've run prebuild as running prebuild can clear your native directories.

Download Depth Model →

Complete your integration

Now that you've installed the ViroReact library into your project, you'll need to complete your setup by following one of our two integration guides.

• Integrating ViroReact into a React Native project (no Expo) →
• Integrating ViroReact into a React Native project with Expo (Recommended)→