Skip to content
Code samples for ViroCore. Track issues in ViroCore here.
C++ C Java JavaScript Objective-C CSS Other
Branch: master
Clone or download

README.md

Releases

ViroCore downloads are available on our Releases page.

ViroCore

ViroCore is SceneKit for Android, a 3D framework for developers to build immersive applications using Java. ViroCore combines a high-performance rendering engine with a descriptive API for creating 3D, AR, and VR apps. While lower-level APIs like OpenGL require you to precisely implement complex rendering algorithms, ViroCore requires only high-level scene descriptions, and code for the interactivity and animations you want your application to perform.

Platforms supported: Android, ARCore, Google Daydream, Samsung GearVR, Google Cardboard VR

The repository contains both the rendering source code, and as well as the ViroCore platform. Both are free to use with no limits on distribution.

To report bugs/issues with the Viro platform, please file new issues on this repository.

Instructions for running sample code:

  1. Follow the prerequisite directions on our Quick start guide to setup dependencies for trying these sample projects with the Viro Media App.
  2. Clone the repo into your workspace with git: git clone https://github.com/viromedia/virocore.git.
  3. Go to the code-sample directory for a list of current samples.
  4. Choose the code sample you wish to deploy, and open the root directory in Android studio.
  5. Ensure that Instant Run is disabled.
  6. (Optional) Clean and gradle sync.
  7. Build and deploy.
  8. You should now be in the application! Enjoy!

Instructions for building the renderer and ViroCore platform:

Building the ViroCore platform:

  1. Follow the same prerequisite directions above from our Quick start guide.
  2. Clone the repo into your workspace with git: git clone https://github.com/viromedia/virocore.git.
  3. Execute the following commands to build the ViroCore platform library
    $ cd android
    $ ./gradlew :virocore:assembleRelease
    
  4. If the above gradle build succeeded, verify you see a virocore-*.aar file (* for the version number) at android/virocore/build/outputs/aar/virocore-*.aar
  5. To run ViroCore tests, open the android project at android/app in Android Studio and run releasetest target on your android device.
  6. To use this updated / newly built virocore-*.aar in your own project copy the aar file to viro_core/ in your project and modify your viro_core/build.gradle to point to the new file.

(Android) Building the renderer to be used in react-viro platform:

  1. Follow the same prerequisite directions above from our Quick start guide.
  2. Clone the repo into your workspace with git: git clone https://github.com/viromedia/virocore.git.
  3. Clone the react-viro repo (named viro) in the same workspace (same parent directory as virocore) with git: https://github.com/viromedia/viro.git
  4. Execute the following commands to build the ViroCore platform library
    $ cd android
    $ ./gradlew :viroreact:assembleRelease
    
  5. If the above gradle build succeeded, verify you see a new viroreact-release.aar file at /viroreact/build/outputs/aar/viroreact-release.aar.
  6. Additionally verify you see a new file built at viro/android/viro_renderer/viro_renderer-release.aar in the viro repo you cloned above in step #3. The build instructions outlined in viro repo will walk you through steps involved in building the react-viro bridge using this built renderer.

(iOS) Building the renderer to be used in react-viro platform:

  1. Make sure you followed through steps 1 - 3 mentioned in the android section.

  2. Execute the following commands to install pods from Podfile.

    cd ios
    pod install
    
  3. Open ViroRenderer.xcworkspace in Xcode. Build scheme ViroKit with Build Configuration set to Release and target set to Generic iOS Device. Note:

    3.a If you want the ability to run on Simulator, 
        change target to any of the `iOS Simulator` targets instead of `Generic iOS Device`. 
    3.b If in your own app project setup, you prefer to include react-viro as a static library 
        rather than relying on `use_frameworks!` - build scheme `ViroKit_static_lib` 
        instead of `ViroKit` as mentioned above in step #3. 
    
  4. If the above Xcode build succeeded, you should see a bunch of new files copied over in viro/ios/dist/ folder in the viro repo you cloned earlier. The build instructions outlined in viro repo will walk you through steps involved in building the react-viro bridge using this built renderer.

More Information

Viro Media Website: https://viromedia.com/

ViroCore Documentation: https://virocore.viromedia.com/

API Reference(Java Docs): https://developer.viromedia.com/

Join our Slack group here.

Check out our blog for tutorials, news, and updates.

Sample Code Examples

AR Hellow World Android

AR Placing Objects

AR Retail

Link to AR Retail tutorial

AR Tesla

AR Black Panther

You can’t perform that action at this time.