diff --git a/README.md b/README.md index 3a3d1b4..c1ef031 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

- - Viro Community logo + +

@@ -41,7 +41,7 @@ The documentation is found [here](https://viro-community.readme.io/docs/overview # Examples -See our [Example projects](readmes/EXAMPLES.md) page. These are a little old (~2019) but are a great reference point for how to use bits of the library. +See our [Example projects](https://viro-community.readme.io/docs/examples) page. These are a little old (~2019) but are a great reference point for how to use bits of the library. # Need help? Or want to contribute? @@ -51,14 +51,6 @@ See our [Example projects](readmes/EXAMPLES.md) page. These are a little old (~2 # A little history... -ViroReact was originaly developed by the [Viro Media](http://www.viromedia.com/) company, but was open sourced in 2019. In late 2020 the [Viro Community](https://virocommunity.github.io/) was formed to help maintain and move the project onwards, updating it so it could run with modern versions of react native, and start to add in new features. +ViroReact was originaly developed by the [Viro Media](http://www.viromedia.com/) company, but was open sourced in 2019. In late 2020 the Viro Community was formed to help maintain and move the project onwards, updating it so it could run with modern versions of react native, and start to add in new features. NativeVision now focuses on the project full time making sure the codebase is updated and ready for the future of XR / Spatial Computing. -We, as a community, owe a great debt to Viro Media and the people who developed this library originally. We hope to make them proud as it continues to develop and grow in the Viro Community. - -# Supporters - -

- - Morrow - -

+We, as a community, owe a great debt to Viro Media and the people who developed this library originally. We hope to make them proud as it continues to develop and grow in the spirit of open source. diff --git a/public/icons/NVLogo.png b/public/icons/NVLogo.png new file mode 100644 index 0000000..86dd281 Binary files /dev/null and b/public/icons/NVLogo.png differ diff --git a/readmes/EXAMPLES.md b/readmes/EXAMPLES.md deleted file mode 100644 index 0405c8a..0000000 --- a/readmes/EXAMPLES.md +++ /dev/null @@ -1,154 +0,0 @@ -_Please note that these examples are a bit old, the code targets an older version of viro before the community took over the project. If you have a cool app you'd like to share then give us a shout so we can update these!_ - -# AR Examples - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - A scene with objects, text and animation displayed on ARKit planes detected in the scene. -
-
- AR Sample -
- - - An ARScene that looks for an image and adds a model of a car with the ability to change its colors. -
-
- AR Car Maker Demo -
- - - An ARScene that lets the user place a car on a surface and drive it around the world. See instructions in the project directory to enable the demo. -
-
- AR Car Driving Demo -
- - - An ARScene that searches for this vertical marker image, and renders Black Panther jumping out of the marker. -
-
- AR Poster Demo -
- - - An ARScene that tracks this business card continously using image tracking. -
-
- AR Tracking Business Card Demo - iOS Only -
- - - An ARScene that tracks this business card continously using image tracking. -
-
- AR Full Sample App -
-
- -# VR Examples - - - - - - - - - - - - - - - - - - -
- - - 360 photo tour example that shows you how to display a 360 photo with clickable hot spots. -
-
- 360 Photo Tour -
- - - This example showcases 3d objects. Orbit around a 3d Heart to see it from different angles! -
-
- Human Body -
- - - Learn how to display and play 2d and 360 video with interactive play controls that can play, pause and stop. -
-
- VR MediaPlayer -
- - - A demonstration on how to do an interactive shopping app for TV's. Uses flexbox for UI and 3d objects with animations. -
-
- Product Showcase -
-
- -# Tutorials - -_Please note that these tutorials are also a bit old, the code targets an older version of viro before the community took over the project._ - - - - - - - - - - - - - - -
- - - How to build an interactive AR app in 5 minutes -
- - - How to build AR Portals in 5 minutes -
- - - Add Snapchat-like AR Lenses to any app -
diff --git a/readmes/EXPO_PLUGIN.md b/readmes/EXPO_PLUGIN.md deleted file mode 100644 index 0c827f2..0000000 --- a/readmes/EXPO_PLUGIN.md +++ /dev/null @@ -1,13 +0,0 @@ -# Installation instructions - -After installing the package, add the [config plugin](https://docs.expo.io/guides/config-plugins/) to the [`plugins`](https://docs.expo.io/versions/latest/config/app/#plugins) array of your `app.json` or `app.config.js`. Then rebuild your app as described in the ["Adding custom native code"](https://docs.expo.io/workflow/customizing/) guide. - -## Example - -In your app.json `plugins` array: - -```json -{ - "plugins": ["@viro-community/react-viro"] -} -``` diff --git a/readmes/INSTALL.md b/readmes/INSTALL.md index 53630bc..2d28d71 100644 --- a/readmes/INSTALL.md +++ b/readmes/INSTALL.md @@ -6,7 +6,7 @@ The steps below are for manually installing and linking the library to an existi ## Install -#### NPM +#### NPM ```console $ npm install --save @viro-community/react-viro @@ -18,13 +18,35 @@ $ npm install --save @viro-community/react-viro $ yarn add @viro-community/react-viro ``` -## Linking (You _must_ do this - we do not support auto-linking) +## » [General Instructions](https://viro-community.readme.io/docs/installation-instructions#installation-instructions) + +## OS Linking (You _must_ do this - we do not support auto-linking) If you're unsure about which file to edit or where to put specified the lines, we have added links to how this is done in our [starter-kit](https://github.com/ViroCommunity/starter-kit) repo. -## » [iOS linking](./INSTALL_IOS.md) +## » [iOS linking](https://viro-community.readme.io/docs/installation-instructions#ios-linking-you-must-do-this---we-do-not-yet-support-auto-linking) + +## » [Android linking](https://viro-community.readme.io/docs/installation-instructions#android-linking-you-must-do-this---we-do-not-yet-support-auto-linking) + +## Expo Plugin + +## » [General Instructions](https://viro-community.readme.io/docs/integrating-with-expo#installation-instructions) + +## » [Android Options](https://viro-community.readme.io/docs/integrating-with-expo#android-options) + +## » [iOS Options](https://viro-community.readme.io/docs/integrating-with-expo#ios-options) + +## » [Running your Expo app](https://viro-community.readme.io/docs/integrating-with-expo#running-your-expo-app) + +## Examples + +Please note that these examples are a bit old, the code targets an older version of viro before the NativeVision took over the project. They will be updated soon! + +## » [AR](https://viro-community.readme.io/docs/examples#ar-examples) + +## » [VR](https://viro-community.readme.io/docs/examples#vr-examples) -## » [Android linking](./INSTALL_ANDROID.md) +## » [Tutorials](https://viro-community.readme.io/docs/examples#tutorials) # **Troubleshooting** diff --git a/readmes/INSTALL_ANDROID.md b/readmes/INSTALL_ANDROID.md deleted file mode 100644 index d8b70e7..0000000 --- a/readmes/INSTALL_ANDROID.md +++ /dev/null @@ -1,172 +0,0 @@ -# Android Linking (You **_must_** do this - we do not yet support auto-linking) - -## 1. In your `android/build.gradle` Bump the minimum SDK version to at least `24`, and the gradle plugin to at least `4.1.1`: - - ```groovy - buildscript{ - ext{ - ... - minSdkVersion = 24 - ... - } - ... - dependencies{ - classpath('com.android.tools.build:gradle:4.1.1') - } - } - ``` - - See an [example](https://github.com/ViroCommunity/starter-kit/blob/master/android/build.gradle) here. - -## 2. In your `android/app/build.gradle` Add the following lines to the dependencies section: - - ```groovy - dependencies { - implementation fileTree(dir: "libs", include: ["*.jar"]) - //noinspection GradleDynamicVersion - - implementation "com.facebook.react:react-native:+" // From node_modules - - // Add these lines - implementation project(':gvr_common') - implementation project(':arcore_client') - implementation project(path: ':react_viro') - implementation project(path: ':viro_renderer') - implementation 'com.google.android.exoplayer:exoplayer:2.7.1' - implementation 'com.google.protobuf.nano:protobuf-javanano:3.0.0-alpha-7' - ``` - - See an [example](https://github.com/ViroCommunity/starter-kit/blob/master/android/app/build.gradle) here. - -## 3. In your `android/settings.gradle` Add the following lines to the end: - - ```groovy - include ':react_viro', ':arcore_client', ':gvr_common', ':viro_renderer' - project(':arcore_client').projectDir = new File('../node_modules/@viro-community/react-viro/android/arcore_client') - project(':gvr_common').projectDir = new File('../node_modules/@viro-community/react-viro/android/gvr_common') - project(':viro_renderer').projectDir = new File('../node_modules/@viro-community/react-viro/android/viro_renderer') - project(':react_viro').projectDir = new File('../node_modules/@viro-community/react-viro/android/react_viro') - ``` - - See an [example](https://github.com/ViroCommunity/starter-kit/blob/master/android/settings.gradle) here. - -## 4. In your `android/gradle/wrapper/gradle-wrapper.properties` set the `distributionUrl` to at least 6.5: - - ```properties - distributionUrl=https\://services.gradle.org/distributions/gradle-6.5-bin.zip - ``` - - See an [example](https://github.com/ViroCommunity/starter-kit/blob/master/android/gradle/wrapper/gradle-wrapper.properties) here. - -## 5. Now add the Viro package to your `MainApplication.java`: - - - Add the following line to the end of the import list: - - ```java - import com.viromedia.bridge.ReactViroPackage; - ``` - - - Add the imported package inside the `getPackages` method: - - ```java - @Override - protected List getPackages() { - @SuppressWarnings("UnnecessaryLocalVariable") - List packages = new PackageList(this).getPackages(); - - // Add this line - packages.add(new ReactViroPackage(ReactViroPackage.ViroPlatform.valueOf("AR"))); - - return packages; - } - - ``` - - You can replace the string `AR` with one of the following depending on your needs: `GVR`, `OVR_MOBILE`, `AR`. - - See an [example](https://github.com/ViroCommunity/starter-kit/blob/master/android/app/src/main/java/com/myviroapp/MainApplication.java) here. - -## 6. In your `android/app/src/main/AndroidManifest.xml`: - - ### **For AR** - - - Ensure the `` has the `tools` namespace schema: - - ```xml - - ``` - - - Add the following line to the `` node, this enables ARCore: - - ```xml - - ``` - - _Note_: If you want to restrict your app to ARCore-only devices, set the `android:value` to `"required"` - - - Add the camera permission to the `` node below other permissions: - - ```xml - - ``` - - There are quite a few other camera-related permissions and features you might also want to specify, depending on your app: - - ```xml - - - - - - - - - - - - ``` - - ### **For VR** - - - If your app supports Cardboard or Daydream, you should add them as a category to the `intent-filter` in your activity: - - ```xml - - - - - - - - - ``` - - - To support GearVR, you need to add the following under the `` node: - - ```xml - - ``` - - ### **For API level 30 or above** - - If you are targetting API Level 30 or above, make sure to add the following lines to the ``: - ```xml - - - - ``` - - ### **Optional - when debugging** - - Add the following line as an attribute on the `` node. This should only used when debugging and is not recommended for production (you may want to inject the value using [manifestPlaceholders](https://developer.android.com/studio/build/manifest-build-variables) set for specific [build types](https://developer.android.com/studio/build/build-variants)). - - ```xml - config["reactNativePath"])`: - - ```yaml - pod 'ViroReact', :path => '../node_modules/@viro-community/react-viro/ios' - pod 'ViroKit', :path => '../node_modules/@viro-community/react-viro/ios/dist/ViroRenderer/' - ``` - - See this [example](https://github.com/ViroCommunity/starter-kit/blob/master/ios/Podfile) - -2. Install the iOS native pods by running: - - ```console - $ npx pod-install - ``` - - or inside the `ios` directory... - - ```console - $ pod install - ``` - -3. If you are going to be doing any AR then you will need to request permissions for using the camera in the `ios/APP_NAME/info.plist` by adding the following: - - ```xml - NSCameraUsageDescription - The camera is needed for AR functionality - ``` - - The `string` can be more appropriate to the needs of your app. - - See an [example](https://github.com/ViroCommunity/starter-kit/blob/master/ios/myviroapp/Info.plist#L40) here. - -4. You're done! You can now run `npx react-native ios`. - - Remember, if you are using AR, you _need to run on a [real device](https://reactnative.dev/docs/running-on-device)_. diff --git a/readmes/morrow-supporter.png b/readmes/morrow-supporter.png deleted file mode 100644 index b7ad65f..0000000 Binary files a/readmes/morrow-supporter.png and /dev/null differ