@crapthings/run3d 0.2.4 → 0.2.6
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 +6 -3
- package/package.json +3 -2
- package/template/AGENTS.md +8 -1
- package/template/index.html +3 -1
- package/template/package.json +11 -9
- package/template/pnpm-lock.yaml +298 -268
- package/template/public/favicon.ico +0 -0
- package/template/public/favicon.svg +8 -0
- package/template/src/App.jsx +3 -2
- package/template/src/Scenes/index.jsx +38 -0
- package/template/src/Scene.jsx +0 -80
package/README.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# run3d
|
|
2
2
|
|
|
3
|
-
Create a 3D project in one command. The starter scene
|
|
3
|
+
Create a 3D project in one command. The starter scene recreates the run3d icon with a green cube and speed lines, ready to edit.
|
|
4
4
|
|
|
5
5
|
As models like GPT-6 Astra grow more capable at building 3D experiences, the distance from an idea to a working prototype keeps shrinking. I have new ideas every day, and I want to spend that energy creating. run3d brings my go-to tools for brainstorming and experimentation into one ready-to-use starter, so I can jump straight into building, testing ideas, and discovering what works.
|
|
6
6
|
|
|
7
7
|
## Usage
|
|
8
8
|
|
|
9
|
-
Requires Node.js
|
|
9
|
+
Requires Node.js `>=22.22.0` and pnpm.
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
12
|
npx @crapthings/run3d my-project
|
|
@@ -14,7 +14,9 @@ cd my-project
|
|
|
14
14
|
pnpm dev
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
Edit `src/
|
|
17
|
+
Edit the components in `src/Scenes` to make the starter scene your own. To install dependencies later, add `--skip-install` to the first command.
|
|
18
|
+
|
|
19
|
+
Drag to orbit the scene, scroll to zoom, and right-drag to pan. Edit `src/Scenes/index.jsx` for the scene and its settings.
|
|
18
20
|
|
|
19
21
|
## Included tools
|
|
20
22
|
|
|
@@ -52,5 +54,6 @@ Edit `src/Scene.jsx` to make it your own. To install dependencies later, add `--
|
|
|
52
54
|
|
|
53
55
|
- [React Router](https://github.com/remix-run/react-router) — connects URLs to pages and handles navigation.
|
|
54
56
|
- [Tailwind CSS](https://github.com/tailwindlabs/tailwindcss) — styles the app.
|
|
57
|
+
- [React Hotkeys Hook](https://github.com/JohannesKlauss/react-hotkeys-hook) — adds declarative keyboard shortcuts with a React hook.
|
|
55
58
|
- [Headless UI](https://github.com/tailwindlabs/headlessui) — provides accessible, unstyled React UI components.
|
|
56
59
|
- [Floating UI](https://github.com/floating-ui/floating-ui) — positions menus, tooltips, and popovers.
|
package/package.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"publishConfig": {
|
|
4
4
|
"access": "public"
|
|
5
5
|
},
|
|
6
|
-
"version": "0.2.
|
|
6
|
+
"version": "0.2.6",
|
|
7
7
|
"description": "From idea to interactive 3D prototype in one command. A JavaScript starter with Vite, React Three Fiber, and tools for creative experimentation.",
|
|
8
8
|
"type": "module",
|
|
9
9
|
"bin": {
|
|
@@ -18,11 +18,12 @@
|
|
|
18
18
|
"template/npmrc",
|
|
19
19
|
"template/package.json",
|
|
20
20
|
"template/pnpm-lock.yaml",
|
|
21
|
+
"template/public",
|
|
21
22
|
"template/src",
|
|
22
23
|
"template/vite.config.js"
|
|
23
24
|
],
|
|
24
25
|
"engines": {
|
|
25
|
-
"node": "
|
|
26
|
+
"node": ">=22.22.0"
|
|
26
27
|
},
|
|
27
28
|
"scripts": {
|
|
28
29
|
"lint": "standard \"bin/**/*.js\" \"scripts/**/*.js\" \"test/**/*.js\" \"template/src/**/*.{js,jsx}\" template/vite.config.js",
|
package/template/AGENTS.md
CHANGED
|
@@ -2,12 +2,19 @@
|
|
|
2
2
|
|
|
3
3
|
## Commands
|
|
4
4
|
|
|
5
|
-
- Only run `pnpm build`, `pnpm lint`, or `pnpm test` when explicitly requested by the user
|
|
5
|
+
- Only run `pnpm build`, `pnpm lint`, or `pnpm test` when explicitly requested by the user, and never run `pnpm dev`.
|
|
6
6
|
|
|
7
7
|
## Code Style
|
|
8
8
|
|
|
9
9
|
- Follow JavaScript Standard Style (standard.js) when writing `.js` and `.jsx` files.
|
|
10
|
+
- Explain each top-level declaration's purpose in a one-sentence comment; split it if one sentence cannot explain it clearly.
|
|
11
|
+
- Avoid overengineering: question whether each solution or abstraction is needed for current requirements before implementing it.
|
|
12
|
+
- Write component styles inline with Tailwind utilities in `className`, using arbitrary values when needed; use CSS files only for global setup or styles Tailwind cannot express.
|
|
10
13
|
|
|
11
14
|
## Scene Lighting
|
|
12
15
|
|
|
13
16
|
- Avoid ambient lighting by default. Only add ambient lighting (such as `AmbientLight` or `HemisphereLight`) when explicitly requested by the user.
|
|
17
|
+
|
|
18
|
+
## Texture Maps
|
|
19
|
+
|
|
20
|
+
- When using texture maps, process them with the installed `three-hex-tiling` package to reduce visible texture repetition instead of relying on basic repeating UV tiling alone.
|
package/template/index.html
CHANGED
|
@@ -3,7 +3,9 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="UTF-8" />
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
6
|
-
<meta name="theme-color" content="#
|
|
6
|
+
<meta name="theme-color" content="#0f172a" />
|
|
7
|
+
<link rel="icon" href="%BASE_URL%favicon.ico" sizes="any" />
|
|
8
|
+
<link rel="icon" href="%BASE_URL%favicon.svg" type="image/svg+xml" />
|
|
7
9
|
<title>Run3D</title>
|
|
8
10
|
</head>
|
|
9
11
|
<body>
|
package/template/package.json
CHANGED
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
"private": true,
|
|
4
4
|
"version": "0.0.0",
|
|
5
5
|
"type": "module",
|
|
6
|
-
"packageManager": "pnpm@12.
|
|
6
|
+
"packageManager": "pnpm@12.8.1",
|
|
7
7
|
"engines": {
|
|
8
|
-
"node": "
|
|
8
|
+
"node": ">=22.22.0"
|
|
9
9
|
},
|
|
10
10
|
"scripts": {
|
|
11
11
|
"dev": "vite",
|
|
@@ -16,9 +16,9 @@
|
|
|
16
16
|
"@floating-ui/react": "^0.27.20",
|
|
17
17
|
"@gsap/react": "^2.1.2",
|
|
18
18
|
"@headlessui/react": "^2.2.10",
|
|
19
|
-
"@react-three/drei": "^10.7.
|
|
20
|
-
"@react-three/fiber": "^9.
|
|
21
|
-
"@react-three/postprocessing": "^3.1.
|
|
19
|
+
"@react-three/drei": "^10.7.9",
|
|
20
|
+
"@react-three/fiber": "^9.8.1",
|
|
21
|
+
"@react-three/postprocessing": "^3.1.3",
|
|
22
22
|
"@react-three/rapier": "^2.2.0",
|
|
23
23
|
"@recast-navigation/three": "^0.43.1",
|
|
24
24
|
"d3": "^7.9.0",
|
|
@@ -27,14 +27,16 @@
|
|
|
27
27
|
"koota": "^0.6.6",
|
|
28
28
|
"math": "0.1.0",
|
|
29
29
|
"navcat": "^0.4.1",
|
|
30
|
-
"p5": "^2.3.
|
|
30
|
+
"p5": "^2.3.4",
|
|
31
31
|
"postprocessing": "^6.39.5",
|
|
32
32
|
"react": "19.2.8",
|
|
33
33
|
"react-dom": "19.2.8",
|
|
34
|
-
"react-
|
|
34
|
+
"react-hotkeys-hook": "^5.3.3",
|
|
35
|
+
"react-router": "^8.4.0",
|
|
35
36
|
"recast-navigation": "^0.43.1",
|
|
36
|
-
"three": "^0.186.
|
|
37
|
+
"three": "^0.186.1",
|
|
37
38
|
"three-hex-tiling": "^0.1.5",
|
|
39
|
+
"tsl-hex-tiling": "^0.1.1",
|
|
38
40
|
"zustand": "^5.0.15"
|
|
39
41
|
},
|
|
40
42
|
"devDependencies": {
|
|
@@ -42,6 +44,6 @@
|
|
|
42
44
|
"@vitejs/plugin-react": "^6.1.1",
|
|
43
45
|
"r3f-perf": "^7.2.3",
|
|
44
46
|
"tailwindcss": "^4.3.3",
|
|
45
|
-
"vite": "^8.3.
|
|
47
|
+
"vite": "^8.3.1"
|
|
46
48
|
}
|
|
47
49
|
}
|