babylonjs-toolkit 9.6.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,63 @@
1
+ # Classic Edition
2
+ The <a href="https://www.babylontoolkit.com">Babylon Toolkit</a> is a runtime library extension for BabylonJS development that provides modern programming mechanics with a familiar Unity like scripting model to fast track native web game development.
3
+
4
+ **We recommend using the modern ES6 supported edition**
5
+
6
+ <a href="https://www.npmjs.com/package/@babylonjs-toolkit/next">Next Edition (ES6)</a>
7
+ <br/>
8
+ <a href="https://github.com/BabylonJS/BabylonToolkit/tree/master/Runtime">Browser Library (CDN)</a>
9
+ <br/>
10
+ <a href="https://github.com/codewrxai/Starter-Project">Demo React Project (TSX)</a>
11
+
12
+
13
+ ## Basic Installation
14
+ ```bash
15
+ npm install babylonjs-toolkit
16
+ ```
17
+
18
+
19
+ ## Default Installation (UMD)
20
+ ```bash
21
+ npm install babylonjs babylonjs-gui babylonjs-loaders babylonjs-materials babylonjs-toolkit
22
+ ```
23
+
24
+ * Global Import Side Effects (main.ts)
25
+ ```javascript
26
+ import 'babylonjs';
27
+ import 'babylonjs-gui';
28
+ import 'babylonjs-loaders';
29
+ import 'babylonjs-materials';
30
+ import 'babylonjs-toolkit';
31
+ ```
32
+
33
+ * TypeScript Configuration Settings (tsconfig.json)
34
+ ```json
35
+ "types": [
36
+ "babylonjs",
37
+ "babylonjs-gui",
38
+ "babylonjs-loaders",
39
+ "babylonjs-gltf2interface",
40
+ "babylonjs-materials",
41
+ "babylonjs-toolkit"
42
+ ]
43
+ ```
44
+
45
+ Note: The **BABYLON** and **TOOLKIT** namespaces are globally accessible. Navigation is now bundled within the toolkit.
46
+
47
+
48
+ ## Navigation Mesh And Pathfinding ([Navigation](https://github.com/MackeyK24/babylon-navigation-mesh))
49
+
50
+ Access Navigation from the babylon-toolkit:
51
+ ```
52
+ TOOLKIT.Navigation
53
+ ```
54
+
55
+ Or access Navigation from the global window:
56
+ ```
57
+ window.Navigation
58
+ ```
59
+
60
+ Or access Navigation using shorthand globals:
61
+ ```
62
+ Navigation;
63
+ ```