{"id":20760149,"url":"https://github.com/galacean/engine-toolkit","last_synced_at":"2025-10-10T00:03:41.530Z","repository":{"id":36978275,"uuid":"489552513","full_name":"galacean/engine-toolkit","owner":"galacean","description":"Some out-of-the-box utility features based on the Galacean engine.","archived":false,"fork":false,"pushed_at":"2024-05-17T07:21:44.000Z","size":1182,"stargazers_count":72,"open_issues_count":28,"forks_count":24,"subscribers_count":17,"default_branch":"main","last_synced_at":"2024-05-20T16:00:07.834Z","etag":null,"topics":["graphics-programming","shaders","toolkit","typescript","visual-effects","webgl"],"latest_commit_sha":null,"homepage":"https://oasisengine.cn","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/galacean.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCTOR.md","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},"funding":{"github":["oasis-engine"],"open_collective":"oasis"}},"created_at":"2022-05-07T03:01:09.000Z","updated_at":"2024-06-05T03:30:50.995Z","dependencies_parsed_at":"2023-12-13T17:44:10.847Z","dependency_job_id":"d5d3d8c1-08b7-4eb2-bc02-770bb3f21313","html_url":"https://github.com/galacean/engine-toolkit","commit_stats":null,"previous_names":["ant-galaxy/oasis-engine-toolkit","galacean/engine-toolkit","galacean/runtime-toolkit"],"tags_count":117,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/galacean%2Fengine-toolkit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/galacean%2Fengine-toolkit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/galacean%2Fengine-toolkit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/galacean%2Fengine-toolkit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/galacean","download_url":"https://codeload.github.com/galacean/engine-toolkit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246971104,"owners_count":20862690,"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":["graphics-programming","shaders","toolkit","typescript","visual-effects","webgl"],"created_at":"2024-11-17T10:11:35.175Z","updated_at":"2025-10-10T00:03:36.501Z","avatar_url":"https://github.com/galacean.png","language":"TypeScript","funding_links":["https://github.com/sponsors/oasis-engine","https://opencollective.com/oasis"],"categories":[],"sub_categories":[],"readme":"# Galacean Engine Toolkit\n\n\u003ca href=\"https://www.npmjs.com/package/oasis-engine-toolkit\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/oasis-engine-toolkit\"/\u003e\u003c/a\u003e ![npm-size](https://img.shields.io/bundlephobia/minzip/oasis-engine-toolkit) ![npm-download](https://img.shields.io/npm/dm/oasis-engine-toolkit) [![codecov](https://codecov.io/gh/oasis-engine/engine/branch/main/graph/badge.svg?token=KR2UBKE3OX)](https://codecov.io/gh/oasis-engine/engine-toolkit)\n\nSome out-of-the-box utility features based on the [Galacean engine](https://github.com/galacean/engine) `Script` and `Material`, welcome to enjoy!\n\n## Features\n\n- 📊 \u0026nbsp;**[Stats](packages/stats)** - Statistics rendering data\n\n- 🛸 \u0026nbsp;**[Controls](packages/controls)** - Some camera controllers\n- 🎥 \u0026nbsp;**[Tween](packages/tween)** - Library for tween animation\n- 🫧 \u0026nbsp;**[FrameBufferPicker](packages/framebuffer-picker)** - Pixel-based object picking\n- ➡️ \u0026nbsp;**[Gizmo](packages/gizmo)** - Operation tools for transforming (displacement, rotation, scaling)\n- 🧭 \u0026nbsp;**[Navigation Gizmo](packages/navigation-gizmo)** - Three-view \u0026 visualized operation for camera control\n- 🛣 \u0026nbsp;**[Waypoint](packages/way-point)** - control entity move along waypoint\n- 🪁 \u0026nbsp;**[Dynamic Bone](packages/dynamic-bone)** - use dynamic spring movement to enhance skeleton animation\n\n- 📐 \u0026nbsp;**[Lines](packages/lines)** - 2D Solid Line \u0026 Dash Line\n- 🖇 \u0026nbsp;**[Auxiliary Lines](packages/auxiliary-lines)** - Draw wireframe for entity and component\n- 🧍🏼 \u0026nbsp;**[Skeleton Helper](packages/skeleton-viewer)** - Skeleton visualization\n- ⭕️ \u0026nbsp;**[Outline](packages/outline)** - Show outline of mesh renderers\n- 🖼 \u0026nbsp;**[Geometry Sketch](packages/geometry-sketch)** - Convert geometry into texture \u0026\u0026 sketch normal and mesh wireframe\n- 🖱 \u0026nbsp;**[Input Logger](packages/input-logger)** - Outputs `keyboard` and `pointer` information in real time for developers\n- 📦 \u0026nbsp;**[Draco](packages/draco)** - Support draco compressed mesh\n\n### [Custom Materials](packages/custom-material)\n\n- ⚔️ \u0026nbsp;**[Grid Material](packages/custom-material/src/grid)** - Infinity grid material\n- 🗳 \u0026nbsp;**[Planar Shadow Material](packages/custom-material/src/planar-shadow)** - Two-pass shadow on the planar\n- 🍞 \u0026nbsp;**[Bake PBR Material](packages/custom-material/src/bake-pbr)** - Bake texture with ibl lighting\n- 🍞 \u0026nbsp;**[Shader Lab](packages/shaderlab)** - a declarative language for creating shader\n\n## npm\n\nThe toolkit is published on npm with full typing support. To install, use:\n\n```sh\nnpm install @galacean/engine-toolkit\n```\n\nThis will allow you to import toolkit entirely using:\n\n```javascript\nimport * as TOOLKIT from \"@galacean/engine-toolkit\";\n```\n\nor individual classes using:\n\n```javascript\nimport { OrbitControl, FramebufferPicker } from \"@galacean/engine-toolkit\";\n```\n\n## Contributing\n\nEveryone is welcome to join us! Whether you find a bug, have a great feature request or you fancy owning a task from the road map feel free to get in touch.\n\nMake sure to read the [Contributing Guide](.github/HOW_TO_CONTRIBUTE.md) / [贡献指南](https://github.com/galacean/engine/wiki/%E5%A6%82%E4%BD%95%E4%B8%8E%E6%88%91%E4%BB%AC%E5%85%B1%E5%BB%BA-Oasis-%E5%BC%80%E6%BA%90%E4%BA%92%E5%8A%A8%E5%BC%95%E6%93%8E) before submitting changes.\n\n## Build\n\nprerequisites:\n\n- [Node.js v15.0.0+](https://nodejs.org/en/) and NPM (Install Node.js By official website)\n- [PNPM](https://pnpm.io/) (Install Pnpm globally by `npm install -g pnpm`)\n\nFirst, you need to install the dependencies:\n\n```sh\npnpm install\n```\n\nThen, to build the source, using npm:\n\n```sh\nnpm run b:all\n```\n\n## Links\n\n- [Official Site](https://oasisengine.cn)\n- [Examples](https://oasisengine.cn/#/examples/latest/skeleton-viewer)\n- [Documentation](https://oasisengine.cn/#/docs/latest/cn/install)\n- [API References](https://oasisengine.cn/#/api/latest/core)\n\n## License\n\nThe engine is released under the [MIT](https://opensource.org/licenses/MIT) license. See LICENSE file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgalacean%2Fengine-toolkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgalacean%2Fengine-toolkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgalacean%2Fengine-toolkit/lists"}