r3f-performance 0.1.1 → 0.1.3

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.
Files changed (2) hide show
  1. package/README.md +11 -3
  2. package/package.json +56 -43
package/README.md CHANGED
@@ -2,19 +2,27 @@
2
2
 
3
3
  **[Changelog](https://github.com/anhldh/r3f-performace/blob/main/CHANGELOG.md)**
4
4
 
5
- A lightweight and easy-to-use tool to monitor the performance of your @react-three/fiber application.
5
+ A lightweight and easy-to-use tool to monitor the performance of your
6
+ [@react-three/fiber](https://github.com/pmndrs/react-three-fiber) application.
6
7
 
7
8
  <table>
8
9
  <tr>
9
10
  <td>Add the <code>&lt;PerformanceMonitor /&gt;</code> component anywhere in your R3F Canvas.</td>
10
11
  <td>
11
- <a href="https://wtp9t.csb.app/">
12
12
  <img src="https://bf3xu0otcy.ufs.sh/f/lSBP1EY5xRSnLHNlxKuvoRAdugXS39mBlIzpHEcwjKqeLFNJ" alt="R3F Performance Monitor" />
13
- </a>
14
13
  </td>
15
14
  </tr>
16
15
  </table>
17
16
 
17
+ ## Features
18
+
19
+ - FPS and render performance monitoring
20
+ - Draw calls, geometries and WebGL program analysis
21
+ - Memory usage tracking
22
+ - Estimated GPU VRAM usage
23
+ - Optional performance graphs
24
+ - Minimal / headless modes for production or debugging
25
+
18
26
  ## Installation
19
27
 
20
28
  ```bash
package/package.json CHANGED
@@ -1,46 +1,59 @@
1
1
  {
2
- "name": "r3f-performance",
3
- "version": "0.1.1",
4
- "private": false,
5
- "type": "module",
6
- "main": "./dist/index.cjs",
7
- "module": "./dist/index.mjs",
8
- "types": "./dist/index.d.ts",
9
- "exports": {
10
- ".": {
11
- "types": "./dist/index.d.ts",
12
- "import": "./dist/index.mjs",
13
- "require": "./dist/index.cjs"
2
+ "name": "r3f-performance",
3
+ "version": "0.1.3",
4
+ "license": "MIT",
5
+ "keywords": [
6
+ "react-three-fiber",
7
+ "r3f",
8
+ "three",
9
+ "threejs",
10
+ "webgl",
11
+ "performance",
12
+ "performance-monitor",
13
+ "fps",
14
+ "rendering",
15
+ "devtools"
16
+ ],
17
+ "private": false,
18
+ "type": "module",
19
+ "main": "./dist/index.cjs",
20
+ "module": "./dist/index.mjs",
21
+ "types": "./dist/index.d.ts",
22
+ "exports": {
23
+ ".": {
24
+ "types": "./dist/index.d.ts",
25
+ "import": "./dist/index.mjs",
26
+ "require": "./dist/index.cjs"
27
+ }
28
+ },
29
+ "files": [
30
+ "dist",
31
+ "README.md",
32
+ "LICENSE"
33
+ ],
34
+ "scripts": {
35
+ "dev": "vite build --watch",
36
+ "build": "vite build",
37
+ "typecheck": "tsc -p tsconfig.json --noEmit",
38
+ "clean": "rimraf dist"
39
+ },
40
+ "peerDependencies": {
41
+ "@react-three/drei": ">=9",
42
+ "@react-three/fiber": ">=8",
43
+ "eventemitter3": ">=4",
44
+ "react": ">=18",
45
+ "react-dom": ">=18",
46
+ "three": ">=0.150",
47
+ "zustand": ">=4"
48
+ },
49
+ "devDependencies": {
50
+ "@types/node": "^25.0.10",
51
+ "@types/react-dom": "^19.2.3",
52
+ "@vitejs/plugin-react": "^4.3.0",
53
+ "rimraf": "^6.0.0",
54
+ "typescript": "^5.0.0",
55
+ "vite": "^5.4.0",
56
+ "vite-plugin-css-injected-by-js": "^3.5.2",
57
+ "vite-plugin-dts": "^4.2.0"
14
58
  }
15
- },
16
- "files": [
17
- "dist",
18
- "README.md",
19
- "LICENSE"
20
- ],
21
- "scripts": {
22
- "dev": "vite build --watch",
23
- "build": "vite build",
24
- "typecheck": "tsc -p tsconfig.json --noEmit",
25
- "clean": "rimraf dist"
26
- },
27
- "peerDependencies": {
28
- "@react-three/drei": ">=9",
29
- "@react-three/fiber": ">=8",
30
- "eventemitter3": ">=4",
31
- "react": ">=18",
32
- "react-dom": ">=18",
33
- "three": ">=0.150",
34
- "zustand": ">=4"
35
- },
36
- "devDependencies": {
37
- "@types/node": "^25.0.10",
38
- "@types/react-dom": "^19.2.3",
39
- "@vitejs/plugin-react": "^4.3.0",
40
- "rimraf": "^6.0.0",
41
- "typescript": "^5.0.0",
42
- "vite": "^5.4.0",
43
- "vite-plugin-css-injected-by-js": "^3.5.2",
44
- "vite-plugin-dts": "^4.2.0"
45
- }
46
59
  }