Skip to content

Files

Latest commit

2ed22f8 · Nov 27, 2023

History

History
144 lines (128 loc) · 8.63 KB

README.md

File metadata and controls

144 lines (128 loc) · 8.63 KB

renderlayer

WebGL 2 rendering library targeting modern browsers.

NPM version License CI Coverage

Structure

This repository employs a monorepo setup which hosts a number of associated packages under the packages directory. They can be used in any combination and define minimum dependencies between each other.

Package Version Description
animation animation
buffers buffers
cameras cameras
controls controls
core core
curves curves
draco draco
extras extras
geometries geometries
gltf gltf
interpolants interpolants
keyframes keyframes
lights lights
loaders loaders
materials materials
math math
objects objects
renderers renderers
scenes scenes
shaders shaders
shared shared
targets targets
textures textures
webgl webgl

A convenience package is provided to make core packages available to your development tools with minimal configuration. An LTS release is also available.

Package Version Description
renderlayer NPM version bundle

Scripts

Action Command Description
build npm run build Build all modules
meta npm run meta Create esbuild meta for analysis
check npm run check Check for circular dependencies
lint npm run lint Run static code analysis
test npm run test Run unit tests and exit
test-watch npm run test-watch Watch for changes and re-run tests
test-coverage npm run test-coverage Generate a test coverage report
format npm run format Check source file formatting
format-fix npm run format-fix Format source files

Tools

Tool Reference
Node.js https://nodejs.org
Vite https://vitejs.dev
Vitest https://vitest.dev
rollup.js https://rollupjs.org
ESLint https://eslint.org
Prettier https://prettier.io
EditorConfig https://editorconfig.org
esbuild https://esbuild.github.io
mswjs https://mswjs.io

References

Website Reference
WebGL2 https://www.khronos.org/webgl/
glTF https://www.khronos.org/gltf/
analyze https://esbuild.github.io/analyze/

License

This project is released under the MIT License.