You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Enable resizing on iOS (uncomment commented out code, and add a comment about it).
- Disable Metal API Validation for the test projects.
- Add documentation about disabling Metal API Validation.
- Do a general pass on updating docs.
Babylon React Native is in the early phase of its development, and has the following limitations:
8
11
9
-
1. Android support only - support for both iOS and Windows is planned.
10
-
1. JavaScriptCore only - support for Hermes is planned, and support for other JavaScript engines used by React Native is uncertain.
12
+
1. Android and iOS support only - support for Windows is planned, but the timeline is currently unknown.
13
+
1. JavaScriptCore (JSC) only - the published @babylonjs/react-native package is configured specifically for JSC, though it is possible to rebuild it and target other JavaScript engines supported by React Native. In the future, the published package will directly support all JavaScript engines that can be used with React Native.
11
14
12
15
## Usage
13
16
14
-
See the [package usage](Apps/Playground/node_modules/@babylonjs/react-native/README.md) or the Playground app's [App.tsx](Apps/Playground/App.tsx) for example usage.
17
+
See the [package usage](Apps/Playground/node_modules/@babylonjs/react-native/README.md)for installation instructions and/or the Playground app's [App.tsx](Apps/Playground/App.tsx) for example usage.
15
18
16
19
## Contributing
17
20
18
-
This quick overview will help you get started developing in the Babylon React Native repository. We support development on Windows and macOS, but assume the use of [PowerShell](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell) in the instructions below.
21
+
This quick overview will help you get started developing in the Babylon React Native repository. We support development on Windows and MacOS, but assume the use of [PowerShell](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell) in the instructions below (unless otherwise noted).
19
22
20
23
If you are interested in making contributions, be sure to also review [CONTRIBUTING.md](CONTRIBUTING.md).
On either Mac or Windows, NPX is used to build and run the Playground sample/test app from the command line. Open a command prompt at the root of the BabylonReactNative repo if you don't have one already open.
90
+
On either Mac or Windows, NPM is used to build and run the Playground sample/test app from the command line. Open a command prompt at the root of the BabylonReactNative repo if you don't have one already open.
88
91
89
92
#### Android
90
93
91
94
```
92
95
cd Apps/Playground
93
-
npx react-native run-android
96
+
npm runandroid
94
97
```
95
98
96
99
After having run the above commands, you can also open `Apps/Playground/android` in Android Studio and run the app from there.
97
100
98
101
#### iOS
99
102
103
+
iOS can only be built on a Mac. Additionally, `CMake` must manually be run to generate the XCode project that the [Playground XCode workspace](Apps/Playground/ios/Playground.xcworkspace/contents.xcworkspacedata) includes.
After having run the above commands, you can also open `Apps/Playground/ios/Playground.xcworkspace` in XCode and run the app from there.
110
115
111
116
### **Building the NPM Package**
112
117
113
-
An NPM package can be built in two different ways: as source, and as binaries. Source is useful if you want to debug the Babylon React Native source in the context of the project consuming it, though configuration is a bit more involved. Binaries are useful in that they simplify configuration in the consuming app, though they cannot be debugged so easily.
118
+
An NPM package can be built in two different ways: as source, and as binaries. Source is useful if you want to debug the Babylon React Native source in the context of the project consuming it, though configuration is a bit more involved. Binaries are useful in that they simplify configuration in the consuming app, though they cannot be debugged so easily. The binary package is what is published to [npmjs.org](https://www.npmjs.com/package/@babylonjs/react-native).
114
119
115
120
#### Source Package
116
121
@@ -121,7 +126,7 @@ cd Apps/Playground/node_modules/@babylonjs/react-native
121
126
npm pack
122
127
```
123
128
124
-
This will produce a zipped local NPM source-based package that can be installed into a React Native application for testing purposes.
129
+
This will produce a zipped local NPM source-based package that can be installed into a React Native application for testing purposes. Note that when testing a source based package for iOS, the XCode project needs to be generated with `CMake` as described [above](#ios).
0 commit comments