{"id":15314007,"url":"https://github.com/vanruesc/rabbit-hole","last_synced_at":"2025-04-15T02:12:29.153Z","repository":{"id":40601774,"uuid":"54531240","full_name":"vanruesc/rabbit-hole","owner":"vanruesc","description":"An experimental voxel engine.","archived":false,"fork":false,"pushed_at":"2023-08-03T10:16:06.000Z","size":44178,"stargazers_count":46,"open_issues_count":2,"forks_count":10,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-15T02:12:22.737Z","etag":null,"topics":["3d-graphics","csg","engine","isosurface","lod","terrain","volume","voxel","webgl"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"zlib","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vanruesc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE.md","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":"2016-03-23T04:38:48.000Z","updated_at":"2024-05-10T22:22:30.000Z","dependencies_parsed_at":"2025-02-26T15:35:44.905Z","dependency_job_id":"30574cf0-bd4b-4de3-900d-941f7f20016c","html_url":"https://github.com/vanruesc/rabbit-hole","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanruesc%2Frabbit-hole","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanruesc%2Frabbit-hole/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanruesc%2Frabbit-hole/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanruesc%2Frabbit-hole/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vanruesc","download_url":"https://codeload.github.com/vanruesc/rabbit-hole/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248991558,"owners_count":21194894,"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":["3d-graphics","csg","engine","isosurface","lod","terrain","volume","voxel","webgl"],"created_at":"2024-10-01T08:44:09.180Z","updated_at":"2025-04-15T02:12:29.136Z","avatar_url":"https://github.com/vanruesc.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Rabbit Hole\n\n[![CI](https://badgen.net/github/checks/vanruesc/rabbit-hole/main)](https://github.com/vanruesc/rabbit-hole/actions)\n[![Version](https://badgen.net/npm/v/rabbit-hole?color=green)](https://www.npmjs.com/package/rabbit-hole)\n[![Peer dependencies](https://badgen.net/david/peer/vanruesc/rabbit-hole)](https://david-dm.org/vanruesc/rabbit-hole?type=peer)\n\nAn experimental voxel engine for WebGL. This software has been created in the context of a Master's degree project at\nthe [University of Applied Sciences Brandenburg](https://www.th-brandenburg.de) in cooperation with the\n[Norwegian University of Technology and Science](https://www.ntnu.no).\n\n:warning: _While many core features are already implemented, this project is still incomplete._ :warning:\n\n*[Demo](https://vanruesc.github.io/rabbit-hole/demo)\u0026ensp;\u0026middot;\u0026ensp;[Documentation](https://vanruesc.github.io/rabbit-hole/docs)\u0026ensp;\u0026middot;\u0026ensp;[Master's Thesis (2016)](https://raw.githubusercontent.com/vanruesc/rabbit-hole/main/thesis-volumetric-terrain-rendering-with-webgl.pdf)\u0026ensp;\u0026middot;\u0026ensp;[Electronic Imaging Paper (2018)](https://www.ingentaconnect.com/contentone/ist/ei/2018/00002018/00000006/art00007)*\n\n\n## Installation\n\nThis library requires the peer dependency [three](https://github.com/vanruesc/iterator-result).\n\n```sh\nnpm install three rabbit-hole\n``` \n\n\n## Usage\n\nThe following example uses the rendering framework [three](https://github.com/mrdoob/three.js/).\nPlease refer to the [usage example](https://github.com/mrdoob/three.js/blob/master/README.md) of `three` for information\non how to setup the renderer, scene and camera.\n\n##### Basics\n\n```js\nimport { Terrain } from \"rabbit-hole\";\n\nconst terrain = new Terrain();\nscene.add(terrain);\n\nrequestAnimationFrame(function render() {\n\n\trequestAnimationFrame(render);\n\tterrain.update(camera);\n\trenderer.render(scene, camera);\n\n});\n```\n\n##### Constructive Solid Geometry\n\n```js\nimport { SuperPrimitive, SuperPrimitivePreset } from \"rabbit-hole\";\n\nconst a = SuperPrimitive.create(SuperPrimitivePreset.SPHERE);\nconst b = SuperPrimitive.create(SuperPrimitivePreset.TORUS);\nconst c = SuperPrimitive.create(SuperPrimitivePreset.CUBE);\n\nterrain.union(a);\nterrain.subtract(b.intersect(c).subtract(a));\nterrain.intersect(c.subtract(a.union(b)));\n```\n\n\n## Features\n\n- [Multithreading](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API)\n- Level of Detail\n- Real-time volume construction and destruction\n\n\n## Contributing\n\nPlease refer to the [contribution guidelines](https://github.com/vanruesc/rabbit-hole/blob/main/.github/CONTRIBUTING.md) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvanruesc%2Frabbit-hole","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvanruesc%2Frabbit-hole","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvanruesc%2Frabbit-hole/lists"}