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
This change includes a handful of fixes that prepare the repo for packaging and publishing react-native-babylon. In its initial form, this will be as source, where the consuming project compiles the linked projects.
Copy file name to clipboardExpand all lines: README.md
+31-12Lines changed: 31 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -13,19 +13,35 @@ Babylon React Native is in the early phase of its development, and has the follo
13
13
14
14
This quick overview will help you understand the constructs provided by Babylon React Native and how to use them in a React Native application. See the Playground app's [App.tsx](Apps/Playground/App.tsx) for example usage.
15
15
16
+
### Dependencies
17
+
18
+
This package has several **peer dependencies**. If these dependencies are unmet, `react-native` will emit warnings. Be sure to add these dependencies to your project.
19
+
20
+
### C++ Build Requirements
21
+
22
+
This package includes C++ source, so platform specific tooling to build C++ code must be installed.
23
+
24
+
### Android Requirements
25
+
26
+
The minimum Android SDK version is 24. This must be set as `minSdkVersion` in the consuming project's `build.gradle` file.
27
+
16
28
### `useEngine`
17
29
18
-
`useEngine` is a **custom React hook** that manages the lifecycle of a Babylon engine instance in the context of an owning React component. A callback is passed to `useEngine`that receives an engine instance which is used to create and configure scenes. For example:
30
+
`useEngine` is a **custom React hook** that manages the lifecycle of a Babylon engine instance in the context of an owning React component. `useEngine`creates an engine instance **asynchronously**which is used to create and configure scenes. Typically scene initialization code should exist in a `useEffect` triggered by an `engine` state change. For example:
0 commit comments