@babylonjs/inspector 8.33.0 → 8.33.1-preview

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/package.json CHANGED
@@ -1,59 +1,43 @@
1
1
  {
2
2
  "name": "@babylonjs/inspector",
3
- "version": "8.33.0",
4
- "module": "dist/babylon.inspector.bundle.js",
5
- "main": "dist/babylon.inspector.bundle.js",
6
- "esnext": "dist/babylon.inspector.bundle.js",
7
- "typings": "dist/babylon.inspector.module.d.ts",
3
+ "version": "8.33.1-preview",
4
+ "type": "module",
5
+ "main": "lib/index.js",
6
+ "module": "lib/index.js",
7
+ "esnext": "lib/index.js",
8
+ "types": "lib/index.d.ts",
8
9
  "files": [
9
- "dist/**/*.*",
10
+ "lib/**/*.js",
11
+ "lib/**/*.d.ts",
12
+ "lib/**/*.map",
10
13
  "readme.md",
11
14
  "license.md"
12
15
  ],
13
- "scripts": {
14
- "build": "npm run clean && npm run build:prod && npm run build:declaration",
15
- "build:dev": "webpack --env development",
16
- "build:prod": "webpack --env production",
17
- "build:declaration": "build-tools -c pud --config ./config.json",
18
- "clean": "rimraf dist"
19
- },
20
- "dependencies": {
21
- "@fortawesome/fontawesome-svg-core": "^6.1.0",
22
- "@fortawesome/free-regular-svg-icons": "^6.0.0",
23
- "@fortawesome/free-solid-svg-icons": "^6.0.0"
24
- },
25
16
  "peerDependencies": {
26
17
  "@babylonjs/addons": "^8.0.0",
27
18
  "@babylonjs/core": "^8.0.0",
28
19
  "@babylonjs/gui": "^8.0.0",
29
- "@babylonjs/gui-editor": "^8.0.0",
30
20
  "@babylonjs/loaders": "^8.0.0",
31
21
  "@babylonjs/materials": "^8.0.0",
32
22
  "@babylonjs/serializers": "^8.0.0",
33
- "@types/react": ">=16.7.3",
34
- "@types/react-dom": ">=16.0.9"
35
- },
36
- "devDependencies": {
37
- "@babylonjs/addons": "^8.33.0",
38
- "@babylonjs/core": "^8.33.0",
39
- "@babylonjs/gui": "^8.33.0",
40
- "@babylonjs/gui-editor": "^8.33.0",
41
- "@babylonjs/loaders": "^8.33.0",
42
- "@babylonjs/materials": "^8.33.0",
43
- "@babylonjs/serializers": "^8.33.0",
44
- "@lts/gui": "1.0.0",
45
- "react": "^18.2.0",
46
- "react-dom": "^18.2.0"
23
+ "@fluentui-contrib/react-virtualizer": "^0.5.3",
24
+ "@fluentui/react-components": "^9.70.0",
25
+ "@fluentui/react-icons": "^2.0.310",
26
+ "react": ">=16.14.0 <20.0.0",
27
+ "react-dom": ">=16.14.0 <20.0.0",
28
+ "usehooks-ts": "^3.1.1"
47
29
  },
48
30
  "keywords": [
49
31
  "3D",
50
32
  "javascript",
51
33
  "html5",
52
34
  "webgl",
53
- "babylon.js"
35
+ "babylon.js",
36
+ "inspector",
37
+ "diagnostic",
38
+ "debug"
54
39
  ],
55
40
  "license": "Apache-2.0",
56
- "sideEffects": true,
57
41
  "homepage": "https://www.babylonjs.com",
58
42
  "repository": {
59
43
  "type": "git",
@@ -62,4 +46,4 @@
62
46
  "bugs": {
63
47
  "url": "https://github.com/BabylonJS/Babylon.js/issues"
64
48
  }
65
- }
49
+ }
package/readme.md CHANGED
@@ -1,26 +1,23 @@
1
- # Babylon.js inspector module
1
+ # BabylonJS Inspector
2
2
 
3
- For usage documentation please visit https://doc.babylonjs.com/how_to/debug_layer.
3
+ The Babylon Inspector is a diagnostic tool that makes it possible to view and edit the scene graph, properties of entities within the scene, and more.
4
4
 
5
- # Installation instructions
5
+ Documentation and samples coming soon!
6
6
 
7
- To install using npm :
7
+ ## Installation
8
8
 
9
- ```shell
10
- npm install @babylonjs/core @babylonjs/inspector
11
- ```
12
-
13
- # How to use
14
-
15
- Afterwards it can be imported to your project using:
9
+ Install the package using npm:
16
10
 
17
- ```javascript
18
- import "@babylonjs/core/Debug/debugLayer";
19
- import "@babylonjs/inspector";
11
+ ```bash
12
+ npm install @babylonjs/inspector@preview
20
13
  ```
21
14
 
22
- The first line will ensure you can access the property debugLayer of the scene while the second will ensure the inspector can be used within your scene.
15
+ The simplest way to use the `Inspector` is to call the `ShowInspector` function, passing in your scene:
23
16
 
24
- This is a great example where code splitting or conditional loading could be used to ensure you are not delivering the inspector if not part of your final app.
17
+ ```ts
18
+ import { ShowInspector } from "@babylonjs/inspector";
25
19
 
26
- For more information you can have a look at our [ES6 dedicated documentation](https://doc.babylonjs.com/features/es6_support).
20
+ // Your code that sets up a Babylon.js scene
21
+
22
+ ShowInspector(scene);
23
+ ```