@crapthings/run3d 0.2.0 → 0.2.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.
Files changed (6) hide show
  1. package/README.md +38 -17
  2. package/package.json +2 -1
  3. package/template/AGENTS.md +4 -0
  4. package/template/package.json +15 -1
  5. package/template/pnpm-lock.yaml +893 -0
  6. package/template/src/main.jsx +1 -0
package/README.md CHANGED
@@ -1,15 +1,10 @@
1
1
  # run3d
2
2
 
3
- A simple 3D sandbox so you don't have to set up the same project every time.
4
- JavaScript, Vite, React Three Fiber, Drei, and Tailwind CSS — with a grid and a box to start with.
5
-
6
- Also includes [pmndrs/math](https://github.com/pmndrs/math) (`math`), [React Three Rapier](https://github.com/pmndrs/react-three-rapier) (`@react-three/rapier`), and [Floating UI for React](https://floating-ui.com/docs/react) (`@floating-ui/react`).
7
-
8
- React and React DOM are pinned to 19.2.8 to match React Three Fiber 9.7's supported range (`>=19 <19.3`). The template uses stable dependencies and a committed lockfile for reproducible installs.
3
+ Create a 3D project in one command. The starter scene has a grid and a box ready to edit.
9
4
 
10
5
  ## Usage
11
6
 
12
- Requires Node.js `^20.19.0 || >=22.12.0` and pnpm. Generated projects pin pnpm 12.4.1.
7
+ Requires Node.js `^20.19.0 || >=22.12.0` and pnpm.
13
8
 
14
9
  ```bash
15
10
  npx @crapthings/run3d my-project
@@ -17,18 +12,44 @@ cd my-project
17
12
  pnpm dev
18
13
  ```
19
14
 
20
- Edit `src/Scene.jsx` and start building. Use `--skip-install` to skip dependency installation.
15
+ Edit `src/Scene.jsx` to make it your own. To install dependencies later, add `--skip-install` to the first command.
21
16
 
22
- ## Publishing
17
+ ## Included tools
23
18
 
24
- Log in once with `npm login`. From this repository, run:
19
+ ### App foundation
25
20
 
26
- ```bash
27
- pnpm release # 0.1.1 → 0.1.2
28
- pnpm release minor # 0.1.1 → 0.2.0
29
- pnpm release major # 0.1.1 → 1.0.0
30
- ```
21
+ - Vite — runs the development server and builds the app.
22
+ - React and React DOM — build and render the app UI.
23
+
24
+ ### 3D scenes
25
+
26
+ - Three.js — renders 3D scenes.
27
+ - pmndrs/math — provides math utilities for 3D work.
28
+ - Postprocessing — applies visual effects to rendered scenes.
29
+ - React Three Fiber — lets you build Three.js scenes with React.
30
+ - Drei — provides ready-made 3D helpers and controls.
31
+ - GSAP — animates scene and UI properties with timelines.
32
+ - `@react-three/postprocessing` — uses postprocessing effects as React components.
33
+ - R3F-Perf — monitors rendering performance while developing.
34
+
35
+ ### Worlds and movement
36
+
37
+ - FastNoiseLite — generates procedural 2D and 3D noise.
38
+ - Three Hex Tiling — reduces visible repetition in tiled textures.
39
+ - Recast Navigation — generates navmeshes and finds paths.
40
+ - `@recast-navigation/three` — connects Recast Navigation to Three.js scenes.
41
+ - Navcat — builds and queries navmeshes in pure JavaScript, with Three.js helpers.
42
+ - React Three Rapier — adds physics and collisions.
43
+
44
+ ### Data and state
45
+
46
+ - D3 — provides data scales, layouts, and visualizations.
47
+ - p5.js — creates interactive graphics and creative coding sketches.
48
+ - Zustand — manages React app state.
49
+ - Koota — manages game state with entities and components.
31
50
 
32
- The command checks that the current branch includes the latest version on `origin`, checks npm login, runs lint, tests and a package dry run, bumps the version, commits **all current changes and unignored new files**, publishes to npm, then creates a version tag and pushes the commit and tag to the same branch on `origin`. Review `git status` first. npm may prompt for two-factor authentication.
51
+ ### Interface
33
52
 
34
- If a release fails, follow the recovery commands printed by the script. If npm publishing succeeded but Git pushing failed, only retry the Git steps. Running `pnpm release` again starts a new version.
53
+ - React Router — connects URLs to pages and handles navigation.
54
+ - Tailwind CSS — styles the app.
55
+ - 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.0",
6
+ "version": "0.2.2",
7
7
  "description": "Create a minimal Vite, React Three Fiber, and Drei Grid starter project",
8
8
  "type": "module",
9
9
  "bin": {
@@ -11,6 +11,7 @@
11
11
  },
12
12
  "files": [
13
13
  "bin",
14
+ "template/AGENTS.md",
14
15
  "template/gitignore",
15
16
  "template/index.html",
16
17
  "template/jsconfig.json",
package/template/AGENTS.md ADDED
@@ -0,0 +1,4 @@
1
+ # Rules
2
+
3
+ - Only run `pnpm build`, `pnpm lint`, or `pnpm test` when explicitly requested by the user.
4
+ - Follow JavaScript Standard Style (standard.js) when writing `.js` and `.jsx` files.
package/template/package.json CHANGED
@@ -16,15 +16,29 @@
16
16
  "@floating-ui/react": "^0.27.20",
17
17
  "@react-three/drei": "^10.7.8",
18
18
  "@react-three/fiber": "^9.7.0",
19
+ "@react-three/postprocessing": "^3.1.1",
19
20
  "@react-three/rapier": "^2.2.0",
21
+ "@recast-navigation/three": "^0.43.1",
22
+ "d3": "^7.9.0",
23
+ "fastnoise-lite": "^1.1.1",
24
+ "gsap": "^3.15.0",
25
+ "koota": "^0.6.6",
20
26
  "math": "0.1.0",
27
+ "navcat": "^0.4.1",
28
+ "p5": "^2.3.3",
29
+ "postprocessing": "^6.39.5",
21
30
  "react": "19.2.8",
22
31
  "react-dom": "19.2.8",
23
- "three": "^0.186.0"
32
+ "react-router": "^7.18.3",
33
+ "recast-navigation": "^0.43.1",
34
+ "three": "^0.186.0",
35
+ "three-hex-tiling": "^0.1.5",
36
+ "zustand": "^5.0.15"
24
37
  },
25
38
  "devDependencies": {
26
39
  "@tailwindcss/vite": "^4.3.3",
27
40
  "@vitejs/plugin-react": "^6.1.1",
41
+ "r3f-perf": "^7.2.3",
28
42
  "tailwindcss": "^4.3.3",
29
43
  "vite": "^8.3.0"
30
44
  }