Skip to content

Add table of additional dependency packages #385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 1, 2022
Merged

Add table of additional dependency packages #385

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
886a092
Add table of additional dependency packages
ryantrem Mar 31, 2022
c69c9f7
Fix typo and readme titles
ryantrem Apr 1, 2022
ec58a6e
Merge branch 'master' into native-package-docs
ryantrem Apr 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Modules/@babylonjs/react-native-iosandroid/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @babylonjs/react-native-iosandroid
# Babylon React Native iOS and Android Runtime

## Usage

Expand All @@ -9,4 +9,4 @@ This package contains iOS and Android dependencies for @babylonjs/react-native.
This package has several **peer dependencies**. If these dependencies are unmet, `npm install` will emit warnings. Be sure to add these dependencies to your project.

This package will not work without installing the `@babylonjs/react-native` peer dependency.
The `react-native-permissions` dependency is required for XR capabilities of Babylon.js.
The `react-native-permissions` dependency is required for XR capabilities of Babylon.js.
4 changes: 2 additions & 2 deletions Modules/@babylonjs/react-native-windows/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @babylonjs/react-native-windows
# Babylon React Native Windows Runtime

## Usage

Expand All @@ -9,4 +9,4 @@ This package contains windows dependencies for @babylonjs/react-native. See @bab
This package has several **peer dependencies**. If these dependencies are unmet, `npm install` will emit warnings. Be sure to add these dependencies to your project.

This package will not work without installing the `@babylonjs/react-native` peer dependency.
The `react-native-permissions` dependency is required for XR capabilities of Babylon.js.
The `react-native-permissions` dependency is required for XR capabilities of Babylon.js.
14 changes: 10 additions & 4 deletions Modules/@babylonjs/react-native/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @babylonjs/react-native
# Babylon React Native

## Usage

Expand All @@ -18,9 +18,15 @@ The minimum Android SDK version is 18. This must be set as `minSdkVersion` in th

The minimum deployment target version is 12. This must be set as `iOS Deployment Target` in the consuming project's `project.pbxproj`, and must also be set as `platform` in the consuming project's `podfile`.

### Universal Windows Platform (UWP) Configuration
### Platform Native Packages

For windows support, install `@babylonjs/react-native-windows`.
Babylon React Native platform native packages must also be installed for the platforms and React Native versions being targeted. This is only needed for ***apps*** using Babylon React Native, not for ***libraries (React Native packages)*** building on top of Babylon React Native.

| | React Native 0.63 - 0.64 | React Native 0.65 - 0.66 |
| ------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| Android | [@babylonjs/react-native-iosandroid-0-64](https://www.npmjs.com/package/@babylonjs/react-native-iosandroid-0-64) | [@babylonjs/react-native-iosandroid-0-65](https://www.npmjs.com/package/@babylonjs/react-native-iosandroid-0-65) |
| iOS | [@babylonjs/react-native-iosandroid-0-64](https://www.npmjs.com/package/@babylonjs/react-native-iosandroid-0-64) | [@babylonjs/react-native-iosandroid-0-65](https://www.npmjs.com/package/@babylonjs/react-native-iosandroid-0-65) |
| Windows | [@babylonjs/react-native-windows-0-64](https://www.npmjs.com/package/@babylonjs/react-native-windows-0-64) | [@babylonjs/react-native-windows-0-65](https://www.npmjs.com/package/@babylonjs/react-native-windows-0-65) |

### `useEngine`

Expand Down Expand Up @@ -84,4 +90,4 @@ e.g.
<EngineView style={{flex: 1}} camera={camera} isTransparent={true} />
```

Note: Currently only one `EngineView` can be active at any given time. Multi-view will be supported in a future release.
Note: Currently only one `EngineView` can be active at any given time. Multi-view will be supported in a future release.