Skip to content

Tell TypeScript users to install @types/three #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aka-blackboots merged 1 commit into from
Nov 10, 2026
Merged

Tell TypeScript users to install @types/three #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ npm install opengeometry three
```

- `three` is a peer dependency: versions `>=0.168.0 <0.185.0` are supported.
- The package is ES modules only, and its TypeScript types are included.
- The package is ES modules only, and its TypeScript types are included. They use the types of `three`, which `three` does not ship: in a TypeScript project, also run `npm install --save-dev @types/three`.
- The package ships `opengeometry_bg.wasm` (the kernel) and `tessellation-worker.js` (the display worker), and your page must be able to fetch both. With no arguments, `OpenGeometry.create()` looks for them next to the package's own `index.js`. If your bundler moves or rewrites `index.js` without the two files, that lookup fails, so the dependable way is the one the quick start uses: copy both files from `node_modules/opengeometry/` into the folder your site serves at its root (in Vite, the `public/` folder by default) and pass their URLs to `create`.

## Quick start
Expand Down
2 changes: 1 addition & 1 deletion docs/opengeometry/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ npm install opengeometry three
```

- `three` is a peer dependency. Versions `>=0.168.0 <0.185.0` are supported.
- The package is ES modules only. Its TypeScript types are included.
- The package is ES modules only. Its TypeScript types are included. They use the types of `three`, which `three` does not ship: in a TypeScript project, also run `npm install --save-dev @types/three`.

## Serve the two files

Expand Down
Loading