babylonjs-toolkit 9.10.1
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 +59 -0
- package/lib/babylon.toolkit.d.ts +10524 -0
- package/lib/babylon.toolkit.js +1 -0
- package/lib/index.d.ts +10524 -0
- package/package.json +55 -0
package/README.md
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
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 ES6 Next Edition of the Babylon Toolkit for new projects**
|
|
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
|
+
|
|
10
|
+
## Basic Installation
|
|
11
|
+
```bash
|
|
12
|
+
npm install babylonjs-toolkit
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Default Installation (UMD)
|
|
16
|
+
```bash
|
|
17
|
+
npm install babylonjs babylonjs-gui babylonjs-addons babylonjs-loaders babylonjs-materials babylonjs-inspector babylonjs-toolkit
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
* Global Import Side Effects (main.ts)
|
|
21
|
+
```javascript
|
|
22
|
+
import 'babylonjs';
|
|
23
|
+
import 'babylonjs-gui';
|
|
24
|
+
import 'babylonjs-loaders';
|
|
25
|
+
import 'babylonjs-materials';
|
|
26
|
+
import 'babylonjs-toolkit';
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
* TypeScript Configuration Settings (tsconfig.json)
|
|
30
|
+
```json
|
|
31
|
+
"types": [
|
|
32
|
+
"babylonjs",
|
|
33
|
+
"babylonjs-gui",
|
|
34
|
+
"babylonjs-loaders",
|
|
35
|
+
"babylonjs-gltf2interface",
|
|
36
|
+
"babylonjs-materials",
|
|
37
|
+
"babylonjs-toolkit"
|
|
38
|
+
]
|
|
39
|
+
```
|
|
40
|
+
### Vite Configuration (UMD)
|
|
41
|
+
|
|
42
|
+
The Vite bundle services behave differently in devmode than production. To preserve some required classes during devmode, these `exclude` and `include` settings are strongly recommended in your vite.config.js settings file.
|
|
43
|
+
|
|
44
|
+
```json
|
|
45
|
+
optimizeDeps: {
|
|
46
|
+
exclude: ["babylonjs-inspector"],
|
|
47
|
+
include: mode === 'development' ? [
|
|
48
|
+
"babylonjs",
|
|
49
|
+
"babylonjs-gui",
|
|
50
|
+
"babylonjs-addons",
|
|
51
|
+
"babylonjs-loaders",
|
|
52
|
+
"babylonjs-materials",
|
|
53
|
+
"babylonjs-toolkit",
|
|
54
|
+
] : [],
|
|
55
|
+
},
|
|
56
|
+
```
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
Note: The **BABYLON** and **TOOLKIT** and **PROJECT** namespaces are globally accessible for UMD style project script bunndles.
|