{"id":16153263,"url":"https://github.com/danielesteban/r3f-voxels","last_synced_at":"2025-07-16T21:39:04.803Z","repository":{"id":246139894,"uuid":"818959364","full_name":"danielesteban/r3f-voxels","owner":"danielesteban","description":null,"archived":false,"fork":false,"pushed_at":"2024-06-27T09:46:59.000Z","size":71,"stargazers_count":19,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-24T10:06:10.202Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/danielesteban.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-23T11:19:23.000Z","updated_at":"2025-01-08T12:40:45.000Z","dependencies_parsed_at":"2024-10-10T01:20:54.959Z","dependency_job_id":null,"html_url":"https://github.com/danielesteban/r3f-voxels","commit_stats":null,"previous_names":["danielesteban/r3f-voxels"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/danielesteban/r3f-voxels","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielesteban%2Fr3f-voxels","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielesteban%2Fr3f-voxels/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielesteban%2Fr3f-voxels/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielesteban%2Fr3f-voxels/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/danielesteban","download_url":"https://codeload.github.com/danielesteban/r3f-voxels/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielesteban%2Fr3f-voxels/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265542436,"owners_count":23785225,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-10T01:10:48.461Z","updated_at":"2025-07-16T21:39:04.748Z","avatar_url":"https://github.com/danielesteban.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"r3f-voxels\n==\n\n### Examples\n\n* [Basic](https://codesandbox.io/p/sandbox/r3f-voxels-basic-8xd52s)\n* [Advanced](https://codesandbox.io/p/sandbox/r3f-voxels-advanced-fpp9j3)\n\n### Installation \n\n```bash\nnpm install r3f-voxels\n```\n\n### Basic usage\n\n```jsx\nimport { Canvas } from '@react-three/fiber';\nimport { Voxels, VoxelsApi } from 'r3f-voxels';\nimport { Vector3 } from 'three';\n\nconst Scene = () =\u003e {\n  const voxels = useRef\u003cVoxelsApi\u003e(null!);\n  useLayoutEffect(() =\u003e {\n    voxels.current.setVoxel(new Vector3(0, 0, 0), 1);\n  }, []);\n  return (\n    \u003cVoxels ref={voxels} /\u003e\n  );\n};\n\nconst App = () =\u003e  (\n  \u003cCanvas\u003e\n    \u003cScene /\u003e\n    \u003cambientLight /\u003e\n  \u003c/Canvas\u003e\n);\n```\n\n### Api\n\n```ts\ntype VoxelsApi = {\n  clearChunks: () =\u003e void;\n  exportChunks: () =\u003e { [key: string]: Uint8Array };\n  importChunks: (chunks: { [key: string]: Uint8Array }) =\u003e void;\n  getMaterials: () =\u003e { opaque: ChunkMaterial; transparent: ChunkMaterial };\n  getVoxel: (position: Vector3) =\u003e number;\n  setVoxel: (position: Vector3, value: number) =\u003e void;\n};\n```\n\n### Props\n\n```ts\ntype VoxelsProps = {\n  atlas?: DataArrayTexture | Texture;\n  normalAtlas?: DataArrayTexture | Texture;\n  occlusionRoughnessMetalnessAtlas?: DataArrayTexture | Texture;\n  bounds?: Box3;\n  followCamera?: boolean;\n  generator?: (x: number, y: number, z: number) =\u003e number;\n  getPhysics?: () =\u003e RapierContext;\n  getTexture?: (voxel: number, face: VoxelFace, isTop: boolean) =\u003e number;\n  getTransparent?: (voxel: number) =\u003e boolean;\n  metalness?: number;\n  roughness?: number;\n};\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanielesteban%2Fr3f-voxels","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdanielesteban%2Fr3f-voxels","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanielesteban%2Fr3f-voxels/lists"}